Obligation (Geotools modules 31-SNAPSHOT API)

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:

GeoAPI 2.0

Author:

Martin Desruisseaux (IRD)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	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.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 `Obligation`s.

Methods inherited from class CodeList
compareTo, equals, hashCode, identifier, matches, name, ordinal, readResolve, toString, valueOf

Methods inherited from class Object
clone, finalize, getClass, 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.
- Method Detail
  - 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.