Enum Plane

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Plane>

    public enum Plane
    extends java.lang.Enum<Plane>
    implements java.io.Serializable
    the enum type, representing a transverse plane.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.String tag)
      compares the plane with the tag
      static Plane fromInt​(int intValue)
      returns the plane which corresponds to the given int value
      static Plane fromTag​(java.lang.String tag)
      returns the plane, which corresponds to the given tag
      java.lang.Integer getIntValue()  
      java.lang.String getTag()  
      java.lang.String toString()  
      static Plane valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Plane[] 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

      • HORIZONTAL

        public static final Plane HORIZONTAL
      • VERTICAL

        public static final Plane VERTICAL
    • Method Detail

      • values

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

        public static Plane 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
      • getTag

        public java.lang.String getTag()
        Returns:
        the tag (which e.g. is used in the database) of the plane
      • getIntValue

        public java.lang.Integer getIntValue()
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<Plane>
      • equals

        public boolean equals​(java.lang.String tag)
        compares the plane with the tag
        Parameters:
        tag - the tag to compare to
        Returns:
        true, if the tag corresponds to the plane, false if not
      • fromTag

        public static final Plane fromTag​(java.lang.String tag)
        returns the plane, which corresponds to the given tag
        Parameters:
        tag - the tag for which to find the plane
        Returns:
        the plane
      • fromInt

        public static final Plane fromInt​(int intValue)
        returns the plane which corresponds to the given int value
        Parameters:
        intValue - the integer value for which to get the plane
        Returns:
        the plane