org.opengis.annotation
Enum Obligation

Show UML class diagram

Object
  Enum<Obligation>
      Obligation

All Implemented Interfaces:

Serializable, Comparable<Obligation>

@UML(identifier="MD_ObligationCode",
     specification=ISO_19115)
public enum Obligation
extends Enum<Obligation>

Whether an element is mandatory, optional or have other obligation. The enumeration values declared here duplicate the code list elements declared in the Obligation code list from the metadata package.

Since:

2.0

Enum Constant Summary

CONDITIONAL
Element is required when a specific condition is met.

FORBIDDEN
The element should always be null.

MANDATORY
Element is always required.

OPTIONAL
Element is not required.

Method Summary

static Obligation	valueOf(String name) Returns the enum constant of this type with the specified name.
static Obligation[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 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 {@code 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