Enum Bearing

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

    public enum Bearing
    extends java.lang.Enum<Bearing>
    implements java.io.Serializable
    Bearing (of a face)
    Since:
    1.0.0
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DOWN
      Face turned down
      LEFT
      Face turned left
      LEFT_DOWN
      Face turned left and down
      LEFT_UP
      Face turned left and up
      RIGHT
      Face turned right
      RIGHT_DOWN
      Face turned right and down
      RIGHT_UP
      Face turned right an up
      STRAIGHT
      Face turned straight to the camera
      UP
      Face turned up
    • Method Summary

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

      • STRAIGHT

        public static final Bearing STRAIGHT
        Face turned straight to the camera
        Since:
        1.0.0
      • UP

        public static final Bearing UP
        Face turned up
        Since:
        1.0.0
      • RIGHT_UP

        public static final Bearing RIGHT_UP
        Face turned right an up
        Since:
        1.0.0
      • RIGHT

        public static final Bearing RIGHT
        Face turned right
        Since:
        1.0.0
      • RIGHT_DOWN

        public static final Bearing RIGHT_DOWN
        Face turned right and down
        Since:
        1.0.0
      • DOWN

        public static final Bearing DOWN
        Face turned down
        Since:
        1.0.0
      • LEFT_DOWN

        public static final Bearing LEFT_DOWN
        Face turned left and down
        Since:
        1.0.0
      • LEFT

        public static final Bearing LEFT
        Face turned left
        Since:
        1.0.0
      • LEFT_UP

        public static final Bearing LEFT_UP
        Face turned left and up
        Since:
        1.0.0
    • Method Detail

      • values

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

        public static Bearing 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