Enum Obligation

    • Enum Constant Detail

      • FORBIDDEN

        public static final Obligation FORBIDDEN
        The element should always be null. This obligation code is used only when a sub-interface overrides an association and force it to a null value. An example is TemporalDatum.getAnchorPoint().
        Departure from OGC/ISO specification:
        ISO specifications sometime override a parent method with a comment saying that the method is not allowed for a particular class. Since there is no construct in Java for expressing this constraint in the method signature, GeoAPI defines a FORBIDDEN obligation (not in original ISO specifications) to be used with the @UML annotation and which adds a flag in the Java documentation.
    • Method Detail

      • values

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

        public static Obligation valueOf​(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:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • identifier

        public String identifier()
        Returns the UML identifier for this enumeration constant, or null if none.
        Specified by:
        identifier in interface ControlledVocabulary
        Returns:
        the ISO/OGC identifier for this constant, or null if none.
        Since:
        3.1
      • names

        public String[] names()
        Returns the programmatic name of this constant together with its identifier, if any.
        Specified by:
        names in interface ControlledVocabulary
        Returns:
        all names of this constant. This array is never null and never empty.
        Since:
        3.1
      • family

        public Obligation[] family()
        Returns all constants defined by this enumeration type. Invoking this method is equivalent to invoking values(), except that this method can be invoked on an instance of the ControlledVocabulary interface (i.e. the enumeration type does not need to be known at compile-time).
        Specified by:
        family in interface ControlledVocabulary
        Returns:
        all values for this enumeration.
        Since:
        3.1