Enum Class SignType

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

public enum SignType extends Enum<SignType> implements Enumerator
A representation of the literals of the enumeration 'Sign Type', and utility methods for working with them. Utility type used in various places - e.g. to indicate the direction of topological objects; "+" for forwards, or "-" for backwards.
See Also:
  • Enum Constant Details

  • Field Details

    • MINUS_VALUE

      public static final int MINUS_VALUE
      The '' literal value.

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

      See Also:
    • PLUS_VALUE

      public static final int PLUS_VALUE
      The '1' literal value.

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

      See Also:
    • VALUES

      public static final List<SignType> VALUES
      A public read-only list of all the 'Sign Type' enumerators.
  • Method Details

    • values

      public static SignType[] 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 SignType 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 SignType get(String literal)
      Returns the 'Sign Type' literal with the specified literal value.
      Parameters:
      literal - the literal.
      Returns:
      the matching enumerator or null.
    • getByName

      public static SignType getByName(String name)
      Returns the 'Sign Type' literal with the specified name.
      Parameters:
      name - the name.
      Returns:
      the matching enumerator or null.
    • get

      public static SignType get(int value)
      Returns the 'Sign Type' 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<SignType>