Module org.phenopackets.phenopackettools.validator.core

Package org.phenopackets.phenopackettools.validator.core

Enum Class ValidationLevel

java.lang.Object

java.lang.Enum<ValidationLevel>

org.phenopackets.phenopackettools.validator.core.ValidationLevel

All Implemented Interfaces:

Serializable, Comparable<ValidationLevel>, Constable

public enum ValidationLevel
extends Enum<ValidationLevel>

ValidationLevel represents a severity level for ValidationResult.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ERROR	The level for pointing out an issue pertaining to a required field as described in the Phenopacket Schema requirements
WARNING	The level for pointing out an issue pertaining to a recommended field as described in the Phenopacket Schema requirements

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

WARNING

public static final ValidationLevel WARNING

The level for pointing out an issue pertaining to a recommended field as described in the Phenopacket Schema requirements

Briefly, the field is not absolutely required or there are valid reasons in particular circumstances that the field does not apply to the intended use case of the Phenopacket. This corresponds to the keywords SHOULD and RECOMMENDED in RFC2119.

ERROR

public static final ValidationLevel ERROR

The level for pointing out an issue pertaining to a required field as described in the Phenopacket Schema requirements

Briefly, the field is required, its presence is an absolute requirement of the specification, failing which the entire phenopacket is regarded as malformed. This corresponds to the keywords MUST, REQUIRED, and SHALL in RFC2119.

Method Details

values

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

isError

public boolean isError()

Returns:

true if this ValidationLevel is ERROR

isWarning

public boolean isWarning()

Returns:

true if this ValidationLevel is WARNING