com.io7m.jequality.validator

Enum AnnotationRequirement

java.lang.Object

java.lang.Enum<AnnotationRequirement>

com.io7m.jequality.validator.AnnotationRequirement

All Implemented Interfaces:

Serializable, Comparable<AnnotationRequirement>

public enum AnnotationRequirement
extends Enum<AnnotationRequirement>

The annotation requirements for validation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANNOTATIONS_OPTIONAL Equality annotations are optional.
ANNOTATIONS_REQUIRED Equality annotations are required.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ANNOTATIONS_OPTIONAL

public static final AnnotationRequirement ANNOTATIONS_OPTIONAL

Equality annotations are optional.

ANNOTATIONS_REQUIRED

public static final AnnotationRequirement ANNOTATIONS_REQUIRED

Equality annotations are required.

Method Detail

values

public static AnnotationRequirement[] 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 (AnnotationRequirement c : AnnotationRequirement.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AnnotationRequirement 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 name

NullPointerException - if the argument is null