Package com.helger.commons.state

Enum EValidity

java.lang.Object

java.lang.Enum<EValidity>

com.helger.commons.state.EValidity

All Implemented Interfaces:

IValidityIndicator, Serializable, Comparable<EValidity>, java.lang.constant.Constable

public enum EValidity
extends Enum<EValidity>
implements IValidityIndicator

Small enum for checks to indicate valid or invalid.

Author:

Philip Helger

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
INVALID
VALID

Method Summary

Modifier and Type	Method	Description
boolean	isValid()
static EValidity	valueOf(boolean bValidity)	Returns the enum constant of this type with the specified name.
static EValidity	valueOf(IValidityIndicator aValidityIndicator)	Returns the enum constant of this type with the specified name.
static EValidity	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EValidity[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.commons.state.IValidityIndicator

and, and, isInvalid, or, or

Enum Constant Details

VALID

public static final EValidity VALID

INVALID

public static final EValidity INVALID

Method Details

values

public static EValidity[] values()

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

Returns:

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

valueOf

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

isValid

public boolean isValid()

Specified by:

isValid in interface IValidityIndicator

Returns:

true if valid and false if invalid.

valueOf

@Nonnull
public static EValidity valueOf(boolean bValidity)

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:

bValidity - 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

valueOf

@Nonnull
public static EValidity valueOf(@Nonnull
 IValidityIndicator aValidityIndicator)

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:

aValidityIndicator - 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