Class Obligation

java.lang.Object

org.opengis.util.CodeList<Obligation>

org.opengis.metadata.Obligation

All Implemented Interfaces:

Serializable, Comparable<Obligation>

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

Obligation of the element or entity.

Since:

2.0

Version:

3.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.
private static final long	serialVersionUID	Serial number for compatibility with different versions.
private static final List<Obligation>	VALUES	List of all enumerations of this type.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Obligation(String name)	Constructs an enum with the given name.

Method Summary

Modifier and Type	Method	Description
Obligation[]	family()	Returns the list of enumerations of the same kind than this enum.
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, equals, identifier, name, names, ordinal, readResolve, toString, valueOf, valueOf

Methods inherited from class Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

Serial number for compatibility with different versions.

See Also:

• Constant Field Values

VALUES

private static final List<Obligation> VALUES

List of all enumerations of this type. Must be declared before any enum declaration.

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 Details

Obligation

private Obligation(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 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 enumerations of the same kind than this enum.

Specified by:

family in class CodeList<Obligation>

Returns:

The codes of the same kind than this code.

valueOf

public static Obligation valueOf(String code)

Returns the obligation that matches the given string, or returns a new one if none match it.

Parameters:

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

Returns:

A code matching the given name.