Package org.onosproject.net.region

Enum Region.Type

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Region.Type>
    Enclosing interface:
    Region
    public static enum Region.Type
extends java.lang.Enum<Region.Type>
    Coarse representation of the type of the region.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BUILDING
      Region represents a building.
      CAMPUS
      Region represents a campus.
      CONTINENT
      Region represents an entire continent.
      COUNTRY
      Region represents an entire country.
      DATA_CENTER
      Region represents a data center.
      FLOOR
      Region represents a building floor.
      LOGICAL_GROUP
      Region represents a logical grouping.
      METRO
      Region represents a metropolitan area.
      RACK
      Region represents a rack.
      ROOM
      Region represents a room.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Region.Type valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Region.Type[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • CONTINENT

        public static final Region.Type CONTINENT
        Region represents an entire continent.

      • COUNTRY

        public static final Region.Type COUNTRY
        Region represents an entire country.

      • METRO

        public static final Region.Type METRO
        Region represents a metropolitan area.

      • CAMPUS

        public static final Region.Type CAMPUS
        Region represents a campus.

      • BUILDING

        public static final Region.Type BUILDING
        Region represents a building.

      • DATA_CENTER

        public static final Region.Type DATA_CENTER
        Region represents a data center.

      • FLOOR

        public static final Region.Type FLOOR
        Region represents a building floor.

      • ROOM

        public static final Region.Type ROOM
        Region represents a room.

      • RACK

        public static final Region.Type RACK
        Region represents a rack.

      • LOGICAL_GROUP

        public static final Region.Type LOGICAL_GROUP
        Region represents a logical grouping.

    • Method Detail

      • values

        public static Region.Type[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Region.Type c : Region.Type.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Region.Type valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null