Package com.helger.base.state

Enum Class EValidity

java.lang.Object

java.lang.Enum<EValidity>

com.helger.base.state.EValidity

All Implemented Interfaces:

IValidityIndicator, Serializable, Comparable<EValidity>, 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 @NonNull EValidity	valueOf(boolean bValidity)	Convert a boolean value to the corresponding EValidity enum value.
static @NonNull EValidity	valueOf(@NonNull IValidityIndicator aValidityIndicator)	Convert an IValidityIndicator to the corresponding EValidity enum value.
static EValidity	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EValidity[]	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

Methods inherited from interface com.helger.base.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 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 EValidity 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

isValid

public boolean isValid()

Specified by:

isValid in interface IValidityIndicator

Returns:

true if valid and false if invalid.

valueOf

public static @NonNull EValidity valueOf(boolean bValidity)

Convert a boolean value to the corresponding EValidity enum value.

Parameters:

bValidity - true for VALID, false for INVALID.

Returns:

Never null.

valueOf

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

Convert an IValidityIndicator to the corresponding EValidity enum value.

Parameters:

aValidityIndicator - The validity indicator to convert. May not be null.

Returns:

Never null.