Class Obligation

Object

CodeList<Obligation>

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

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class CodeList

Code­List.Filter

Modifier and Type	Class	Description
static interface	Code­List.Filter	Used by Code­List.value­Of(Class, Filter) to select codes matching an arbitrary criterion.

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 enumerations of the same kind as this enum.
static Obligation	value­Of(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

compare­To, identifier, name, names, ordinal, read­Resolve, to­String, value­Of, value­Of

Modifier and Type	Method	Description
final int	compare­To(Obligation other)	Compares this code with the specified object for order.
String	identifier()	Returns the identifier declared in the UML annotation, or null if none.
final String	name()	Returns the programmatic name of this code list constant.
String[]	names()	Returns all the names of this code.
final int	ordinal()	Returns the ordinal of this code constant.
protected Object	read­Resolve()	Resolves the code list to an unique instance after deserialization.
String	to­String()	Returns a string representation of this code list.
static <T extends Code­List<T>> T	value­Of(Class<T> code­Type, String name)	Returns the code of the given type that matches the given name, or returns a new one if none match it.
static <T extends Code­List<T>> T	value­Of(Class<T> code­Type, Code­List.Filter filter)	Returns the code of the given type that matches the given criterion, or returns a new one if none match it.

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, 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 enumerations of the same kind as this enum.

Specified by:

family in class Code­List<Obligation>

Returns:

The codes of the same kind as 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.