Module org.opengis.geoapi
Package org.opengis.annotation

Enum Obligation

Object
Enum<Obligation>
Obligation
All Implemented Interfaces:
Serializable, Comparable<Obligation>
@UML(identifier="MD_ObligationCode", specification=ISO_19115) public enum Obligation extends Enum<Obligation>
Obligation of the element or entity. The enum values declared here duplicate the code list elements declared in the Obligation code list from the metadata package.
Since:
2.0

  • Enum Constant Details

    • CONDITIONAL

      @UML(identifier="conditional", specification=ISO_19115) public static final Obligation CONDITIONAL
      Element is required when a specific condition is met.

    • OPTIONAL

      @UML(identifier="optional", specification=ISO_19115) public static final Obligation OPTIONAL
      Element is not required.

    • MANDATORY

      @UML(identifier="mandatory", specification=ISO_19115) public static final Obligation MANDATORY
      Element is always required.

    • 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 abstract specification:
      Departure due to constraint of the Java language 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 Details

    • values

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