Package com.helger.commons.state

Enum EHandled

java.lang.Object

java.lang.Enum<EHandled>

com.helger.commons.state.EHandled

All Implemented Interfaces:

IHandledIndicator, Serializable, Comparable<EHandled>

public enum EHandled
extends Enum<EHandled>
implements IHandledIndicator

Small enum to identify whether something was handled or not.

Since:

9.0.0

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant	Description
HANDLED
UNHANDLED

Method Summary

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

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

and, isUnhandled, or

Enum Constant Detail

HANDLED

public static final EHandled HANDLED

UNHANDLED

public static final EHandled UNHANDLED

Method Detail

values

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

Returns:

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

valueOf

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

isHandled

public boolean isHandled()

Specified by:

isHandled in interface IHandledIndicator

Returns:

true if handled and false if not.

valueOf

@Nonnull
public static EHandled valueOf(boolean bHandleded)

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:

bHandleded - 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 EHandled valueOf(@Nonnull
                               IHandledIndicator aHandledIndicator)

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:

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