com.io7m.jequality.validator

Enum ValidatorResult

java.lang.Object

java.lang.Enum<ValidatorResult>

com.io7m.jequality.validator.ValidatorResult

All Implemented Interfaces:

Serializable, Comparable<ValidatorResult>

public enum ValidatorResult
extends Enum<ValidatorResult>

The result of validation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
VALIDATION_ERROR_INCONSISTENT_HASHCODE Validation failed; hashCode checking was requested, but the hashCode method was not defined in the same class as equals.
VALIDATION_ERROR_WANTED_ANNOTATIONS Validation failed; annotations were required but none were included.
VALIDATION_ERROR_WANTED_REFERENCE_EQUALITY Validation failed; the class specified reference equality but actually overrode equals.
VALIDATION_ERROR_WANTED_STRUCTURAL_EQUALITY Validation failed; the class specified structural equality but failed to override equals.
VALIDATION_OK Validation succeeded.

Method Summary

Modifier and Type	Method and Description
static ValidatorResult	valueOf(String name) Returns the enum constant of this type with the specified name.
static ValidatorResult[]	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

VALIDATION_ERROR_INCONSISTENT_HASHCODE

public static final ValidatorResult VALIDATION_ERROR_INCONSISTENT_HASHCODE

Validation failed; hashCode checking was requested, but the hashCode method was not defined in the same class as equals.

VALIDATION_ERROR_WANTED_ANNOTATIONS

public static final ValidatorResult VALIDATION_ERROR_WANTED_ANNOTATIONS

Validation failed; annotations were required but none were included.

VALIDATION_ERROR_WANTED_REFERENCE_EQUALITY

public static final ValidatorResult VALIDATION_ERROR_WANTED_REFERENCE_EQUALITY

Validation failed; the class specified reference equality but actually overrode equals.

VALIDATION_ERROR_WANTED_STRUCTURAL_EQUALITY

public static final ValidatorResult VALIDATION_ERROR_WANTED_STRUCTURAL_EQUALITY

Validation failed; the class specified structural equality but failed to override equals.

VALIDATION_OK

public static final ValidatorResult VALIDATION_OK

Validation succeeded.

Method Detail

values

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

Returns:

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

valueOf

public static ValidatorResult 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