Package org.geotools.api.annotation
Enum Obligation
- Object
-
- Enum<Obligation>
-
- Obligation
-
- All Implemented Interfaces:
Serializable
,Comparable<Obligation>
@UML(identifier="MD_ObligationCode", specification=ISO_19115) public enum Obligation extends Enum<Obligation>
Obligation of the element or entity. The enum values declared here are an exact copy of the code list elements declared in theObligation
code list from the metadata package.- Since:
- GeoAPI 2.0
- Author:
- Martin Desruisseaux (IRD)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CONDITIONAL
Element is required when a specific condition is met.FORBIDDEN
The element should always benull
.MANDATORY
Element is always required.OPTIONAL
Element is not required.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method 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.
-
-
-
Enum Constant Detail
-
CONDITIONAL
public static final Obligation CONDITIONAL
Element is required when a specific condition is met.
-
OPTIONAL
@UML(identifier="optional", obligation=CONDITIONAL, specification=ISO_19115) public static final Obligation OPTIONAL
Element is not required.
-
MANDATORY
@UML(identifier="mandatory", obligation=CONDITIONAL, specification=ISO_19115) public static final Obligation MANDATORY
Element is always required.
-
FORBIDDEN
public static final Obligation FORBIDDEN
The element should always benull
. This obligation code is used only when a subinterface overrides an association and force it to anull
value. An example isTemporalDatum.getAnchorPoint()
.
-
-
Method Detail
-
values
public static Obligation[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (Obligation c : Obligation.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Obligation valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
-