Package org.geotools.api.annotation
Enum Class Obligation
- All Implemented Interfaces:
Serializable
,Comparable<Obligation>
,Constable
@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 the
Obligation
code list from the metadata package.- Since:
- GeoAPI 2.0
- Author:
- Martin Desruisseaux (IRD)
-
Nested Class Summary
Nested classes/interfaces inherited from class Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionElement is required when a specific condition is met.The element should always benull
.Element is always required.Element is not required. -
Method Summary
Modifier and TypeMethodDescriptionstatic Obligation
Returns the enum constant of this class with the specified name.static Obligation[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
CONDITIONAL
Element is required when a specific condition is met. -
OPTIONAL
@UML(identifier="optional", obligation=CONDITIONAL, specification=ISO_19115) public static final Obligation OPTIONALElement is not required. -
MANDATORY
@UML(identifier="mandatory", obligation=CONDITIONAL, specification=ISO_19115) public static final Obligation MANDATORYElement is always required. -
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 Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-