Package bytemusketeers.heslingtonhustle.scene

Enum Area.Name

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Area.Name>
    Enclosing class:
    Area
    public static enum Area.Name
extends java.lang.Enum<Area.Name>
    Distinguishes between the standard Area instantiations
    See Also:
    AreaFactory

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String displayName
      A human-readable name for the Area.Name ordinal

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Name​(java.lang.String displayName)
      Instantiates a new standard Area.Name template to correspond with an Area

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String toString()
      Retrieves the human-readable Area.Name
      static Area.Name valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Area.Name[] 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, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • OutdoorMap

        public static final Area.Name OutdoorMap

      • PiazzaBuilding

        public static final Area.Name PiazzaBuilding

      • CompSciBuilding

        public static final Area.Name CompSciBuilding

      • BedroomBuilding

        public static final Area.Name BedroomBuilding

    • Field Detail

      • displayName

        private final java.lang.String displayName
        A human-readable name for the Area.Name ordinal

    • Constructor Detail

      • Name

        private Name​(java.lang.String displayName)
        Instantiates a new standard Area.Name template to correspond with an Area
        Parameters:
        displayName - The human-readable name of the new Area.Name

    • Method Detail

      • values

        public static Area.Name[] 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 (Area.Name c : Area.Name.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Area.Name 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

      • toString

        public java.lang.String toString()
        Retrieves the human-readable Area.Name
        Overrides:
        toString in class java.lang.Enum<Area.Name>
        Returns:
        The name for the requested Area