org.opengis.metadata

Class Obligation

java.lang.Object

org.opengis.util.CodeList<Obligation>

org.opengis.metadata.Obligation

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Obligation>

@UML(identifier="MD_ObligationCode",
     specification=ISO_19115)
public final class Obligation
extends CodeList<Obligation>

Obligation of the element or entity.

Since:

GeoAPI 2.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Obligation	CONDITIONAL Element is required when a specific condition is met.
static Obligation	MANDATORY Element is always required.
static Obligation	OPTIONAL Element is not required.

Constructor Summary

Constructors

Constructor and Description
Obligation(java.lang.String name) Constructs an enum with the given name.

Method Summary

Modifier and Type	Method and Description
CodeList[]	family() Returns the list of enumerations of the same kind than this enum.
static Obligation[]	values() Returns the list of Obligations.

Methods inherited from class org.opengis.util.CodeList

compareTo, name, ordinal, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MANDATORY

@UML(identifier="mandatory",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final Obligation MANDATORY

Element is always required.

OPTIONAL

@UML(identifier="optional",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final Obligation OPTIONAL

Element is not required.

CONDITIONAL

@UML(identifier="conditional",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final Obligation CONDITIONAL

Element is required when a specific condition is met.

Constructor Detail

Obligation

public Obligation(java.lang.String name)

Constructs an enum with the given name. The new enum is automatically added to the list returned by values().

Parameters:

name - The enum name. This name must not be in use by an other enum of this type.

Method Detail

values

public static Obligation[] values()

Returns the list of Obligations.

family

public CodeList[] family()

Returns the list of enumerations of the same kind than this enum.

Specified by:

family in class CodeList<Obligation>