Module org.opengis.geoapi

Package org.opengis.metadata

Class Obligation

Object

CodeList<Obligation>

Obligation

All Implemented Interfaces:

Serializable, Comparable<Obligation>, ControlledVocabulary

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

Obligation of the element or entity.

Upcoming API change — enumeration
According ISO 19115, Obligation shall be an enumeration, not a code list. Such enumeration already exists in the org.opengis.annotation package. Consequently this Obligation class may be deleted in favor or org.opengis.annotation.Obligation in GeoAPI 4.0. See GEO-199 for more information.

Since:

2.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class CodeList

CodeList.Filter

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Obligation[]	family()	Returns the list of codes of the same kind than this code list element.
static Obligation	valueOf(String code)	Returns the obligation that matches the given string, or returns a new one if none match it.
static Obligation[]	values()	Returns the list of Obligations.

Methods inherited from class CodeList

compareTo, identifier, name, names, ordinal, readResolve, toString, valueOf, valueOf, valueOf

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

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.

Method Details

values

public static Obligation[] values()

Returns the list of Obligations.

Returns:

The list of codes declared in the current JVM.

family

public Obligation[] family()

Returns the list of codes of the same kind than this code list element. Invoking this method is equivalent to invoking values(), except that this method can be invoked on an instance of the parent CodeList class.

Specified by:

family in interface ControlledVocabulary

Specified by:

family in class CodeList<Obligation>

Returns:

All code values for this code list.

valueOf

public static Obligation valueOf(String code)

Returns the obligation that matches the given string, or returns a new one if none match it. More specifically, this methods returns the first instance for which name().equals(code) returns true. If no existing instance is found, then a new one is created for the given name.

Parameters:

code - The name of the code to fetch or to create.

Returns:

A code matching the given name.