@UML(identifier="MD_ObligationCode", specification=ISO_19115) public enum Obligation extends Enum<Obligation>
Obligation
code list from the metadata
package.Enum Constant and Description |
---|
CONDITIONAL
Element is required when a specific condition is met.
|
FORBIDDEN
The element should always be
null . |
MANDATORY
Element is always required.
|
OPTIONAL
Element is not required.
|
Modifier and Type | Method and Description |
---|---|
static Obligation |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static Obligation[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
@UML(identifier="conditional", specification=ISO_19115) public static final Obligation CONDITIONAL
@UML(identifier="optional", specification=ISO_19115) public static final Obligation OPTIONAL
@UML(identifier="mandatory", specification=ISO_19115) public static final Obligation MANDATORY
public static final Obligation FORBIDDEN
null
. This obligation code is used only when
a sub-interface overrides an association and force it to a null
value.
An example is TemporalDatum.getAnchorPoint()
.Departure from OGC/ISO specification:
ISO specifications sometime override a parent method with a comment saying that the method is not allowed for a particular class. Since there is no construct in Java for expressing this constraint in the method signature, GeoAPI defines aFORBIDDEN
obligation (not in original ISO specifications) to be used with the@UML
annotation and which adds a flag in the Java documentation.
public static Obligation[] values()
for (Obligation c : Obligation.values()) System.out.println(c);
public static Obligation valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullCopyright © 1994–2019 Open Geospatial Consortium. All rights reserved.