Enum Ordinate

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

    public enum Ordinate
    extends java.lang.Enum<Ordinate>
    An enumeration of possible Well-Known-Text or Well-Known-Binary ordinates.

    Intended to be used as an EnumSet<Ordinate>, optimized create methods have been provided for createXY(), createXYM(), createXYZ() and createXYZM().

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      M
      Measure-ordinate
      X
      X-ordinate
      Y
      Y-ordinate
      Z
      Z-ordinate
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.util.EnumSet<Ordinate> createXY()
      EnumSet of X and Y ordinates, a copy is returned as EnumSets are not immutable.
      static java.util.EnumSet<Ordinate> createXYM()
      EnumSet of XYM ordinates, a copy is returned as EnumSets are not immutable.
      static java.util.EnumSet<Ordinate> createXYZ()
      EnumSet of XYZ ordinates, a copy is returned as EnumSets are not immutable.
      static java.util.EnumSet<Ordinate> createXYZM()
      EnumSet of XYZM ordinates, a copy is returned as EnumSets are not immutable.
      static Ordinate valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Ordinate[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • X

        public static final Ordinate X
        X-ordinate
      • Y

        public static final Ordinate Y
        Y-ordinate
      • Z

        public static final Ordinate Z
        Z-ordinate
      • M

        public static final Ordinate M
        Measure-ordinate
    • Method Detail

      • values

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

        public static Ordinate 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
      • createXY

        public static java.util.EnumSet<Ordinate> createXY()
        EnumSet of X and Y ordinates, a copy is returned as EnumSets are not immutable.
        Returns:
        EnumSet of X and Y ordinates.
      • createXYZ

        public static java.util.EnumSet<Ordinate> createXYZ()
        EnumSet of XYZ ordinates, a copy is returned as EnumSets are not immutable.
        Returns:
        EnumSet of X and Y ordinates.
      • createXYM

        public static java.util.EnumSet<Ordinate> createXYM()
        EnumSet of XYM ordinates, a copy is returned as EnumSets are not immutable.
        Returns:
        EnumSet of X and Y ordinates.
      • createXYZM

        public static java.util.EnumSet<Ordinate> createXYZM()
        EnumSet of XYZM ordinates, a copy is returned as EnumSets are not immutable.
        Returns:
        EnumSet of X and Y ordinates.