Enum Class RequirementLevel

java.lang.Object

java.lang.Enum<RequirementLevel>

org.incenp.linkml.core.RequirementLevel

All Implemented Interfaces:

Serializable, Comparable<RequirementLevel>, Constable

public enum RequirementLevel
extends Enum<RequirementLevel>

The level of requirement that applies to a given field within a class.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MANDATORY	Indicates a required field.
OPTIONAL	Indicates an optional field.
RECOMMENDED	Indicates an optional, but recommended, field.

Method Summary

Modifier and Type	Method	Description
static RequirementLevel	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RequirementLevel[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OPTIONAL

public static final RequirementLevel OPTIONAL

Indicates an optional field.

RECOMMENDED

public static final RequirementLevel RECOMMENDED

Indicates an optional, but recommended, field. A LinkML validator may emit a warning if the field is not set in a given instance.

MANDATORY

public static final RequirementLevel MANDATORY

Indicates a required field.

Method Details

values

public static RequirementLevel[] 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

public static RequirementLevel valueOf(String name)

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 name

NullPointerException - if the argument is null