Enum Class IncrementOrder

Object
Enum<IncrementOrder>
IncrementOrder
All Implemented Interfaces:
Serializable, Comparable<IncrementOrder>, Constable, Enumerator

public enum IncrementOrder extends Enum<IncrementOrder> implements Enumerator
A representation of the literals of the enumeration 'Increment Order', and utility methods for working with them. The enumeration value here indicates the incrementation order to be used on the first 2 axes, i.e. "+x-y" means that the points on the first axis are to be traversed from lowest to highest and the points on the second axis are to be traversed from highest to lowest. The points on all other axes (if any) beyond the first 2 are assumed to increment from lowest to highest.
See Also:
  • Enum Constant Details

  • Field Details

    • XY_VALUE

      public static final int XY_VALUE
      The 'XY' literal value.

      If the meaning of 'XY' literal object isn't clear, there really should be more of a description here...

      See Also:
    • YX_VALUE

      public static final int YX_VALUE
      The 'YX' literal value.

      If the meaning of 'YX' literal object isn't clear, there really should be more of a description here...

      See Also:
    • XY1_VALUE

      public static final int XY1_VALUE
      The 'XY1' literal value.

      If the meaning of 'XY1' literal object isn't clear, there really should be more of a description here...

      See Also:
    • XY2_VALUE

      public static final int XY2_VALUE
      The 'XY2' literal value.

      If the meaning of 'XY2' literal object isn't clear, there really should be more of a description here...

      See Also:
    • VALUES

      public static final List<IncrementOrder> VALUES
      A public read-only list of all the 'Increment Order' enumerators.
  • Method Details

    • values

      public static IncrementOrder[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static IncrementOrder valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • get

      public static IncrementOrder get(String literal)
      Returns the 'Increment Order' literal with the specified literal value.
      Parameters:
      literal - the literal.
      Returns:
      the matching enumerator or null.
    • getByName

      public static IncrementOrder getByName(String name)
      Returns the 'Increment Order' literal with the specified name.
      Parameters:
      name - the name.
      Returns:
      the matching enumerator or null.
    • get

      public static IncrementOrder get(int value)
      Returns the 'Increment Order' literal with the specified integer value.
      Parameters:
      value - the integer value.
      Returns:
      the matching enumerator or null.
    • getValue

      public int getValue()
      Specified by:
      getValue in interface Enumerator
    • getName

      public String getName()
      Specified by:
      getName in interface Enumerator
    • getLiteral

      public String getLiteral()
      Specified by:
      getLiteral in interface Enumerator
    • toString

      public String toString()
      Returns the literal value of the enumerator, which is its string representation.
      Overrides:
      toString in class Enum<IncrementOrder>