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>

public enum EValidity
extends Enum<EValidity>
implements IValidityIndicator

Small enum for checks to indicate valid or invalid.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
INVALID
VALID

Method Summary

Methods

Modifier and Type	Method and Description
EValidity	and(IValidityIndicator aValidity)
boolean	isInvalid()
boolean	isValid()
EValidity	or(IValidityIndicator aValidity)
static EValidity	valueOf(boolean bValidity)
static EValidity	valueOf(IValidityIndicator aValidityIndicator)
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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VALID

public static final EValidity VALID

INVALID

public static final EValidity INVALID

Method Detail

values

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

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.

isInvalid

public boolean isInvalid()

Specified by:

isInvalid in interface IValidityIndicator

Returns:

true if invalid and false if valid.

or

@Nonnull
public EValidity or(@Nonnull
                   IValidityIndicator aValidity)

and

@Nonnull
public EValidity and(@Nonnull
                    IValidityIndicator aValidity)

valueOf

@Nonnull
public static EValidity valueOf(boolean bValidity)

valueOf

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