Class CodeList<E extends CodeList<E>>

    • Constructor Detail

      • CodeList

        protected CodeList​(String name,
                           Collection<E> values)
        Creates a new code list element and add it to the given collection. Subclasses will typically give a static reference to an ArrayList for the values argument. This list is used for values() method implementations.
        name - The code name.
        values - The collection to add the element to.
    • Method Detail

      • valueOf

        public static <T extends CodeList> T valueOf​(Class<T> codeType,
                                                     String name)
        Returns the code of the given type that matches the given name, or returns a new one if none match it. More specifically, this methods returns the first element of the given class where matches(name) returned true. If no such element is found, then a new instance is created using the constructor expecting a single String argument.
        Type Parameters:
        T - The compile-time type given as the codeType parameter.
        codeType - The type of code list.
        name - The name of the code to obtain.
        A code matching the given name.
      • ordinal

        public final int ordinal()
        Returns the ordinal of this code constant. This is its position in its elements declaration, where the initial constant is assigned an ordinal of zero.
        The position of this code constants in elements declaration.
      • identifier

        public String identifier()
        Returns the identifier declared in the UML annotation, or null if none. The UML identifier shall be the ISO or OGC name for this code constant.
        The ISO/OGC identifier for this code constant, or null if none.
        GeoAPI 2.2
      • name

        public final String name()
        Returns the name of this code list constant.
        The name of this code constant.
      • matches

        public boolean matches​(String name)
        Returns true if the given name matches the name, identifier or any other identification string of this code list element. The comparison is case-insensitive.
        name - The name to check.
        true if the given name matches the code name or identifier.
        GeoAPI 2.2
      • family

        public abstract E[] family()
        Returns the list of codes of the same kind than this code.
        The codes of the same kind than this code.
      • compareTo

        public final int compareTo​(E other)
        Compares this code with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

        Code list constants are only comparable to other code list constants of the same type. The natural order implemented by this method is the order in which the constants are declared.

        Specified by:
        compareTo in interface Comparable<E extends CodeList<E>>
        other - The code constant to compare with this code.
        -1 if the given code is less than this code, +1 if greater or 0 if equal.
      • equals

        public final boolean equals​(Object object)
        Compares the specified object with this code list for equality. This method compares only ordinal values for consistency with the compareTo(E) method. Ordinal values are unique for each code list element of the same class.
        equals in class Object
        object - The object to compare with this code.
        true if the given object is equals to this code.
        GeoAPI 2.2
      • hashCode

        public int hashCode()
        hashCode in class Object
      • toString

        public String toString()
        Returns a string representation of this code list.
        toString in class Object
      • readResolve

        protected Object readResolve()
                              throws ObjectStreamException
        Resolves the code list to an unique instance after deserialization. The instance is resolved using its name only (not its ordinal).
        This code list as an unique instance.
        ObjectStreamException - if the deserialization failed.