com.phloc.commons.state

Enum EEnabled

java.lang.Object

java.lang.Enum<EEnabled>

com.phloc.commons.state.EEnabled

All Implemented Interfaces:

IEnabledIndicator, Serializable, Comparable<EEnabled>

public enum EEnabled
extends Enum<EEnabled>
implements IEnabledIndicator

Small enum for setter method to identify whether an object is enabled or not.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED
ENABLED

Method Summary

Methods

Modifier and Type	Method and Description
EEnabled	and(IEnabledIndicator aEnabled)
boolean	isDisabled()
boolean	isEnabled()
EEnabled	or(IEnabledIndicator aEnabled)
static EEnabled	valueOf(boolean bEnabled)
static EEnabled	valueOf(IEnabledIndicator aEnabledIndicator)
static EEnabled	valueOf(String name) Returns the enum constant of this type with the specified name.
static EEnabled[]	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

ENABLED

public static final EEnabled ENABLED

DISABLED

public static final EEnabled DISABLED

Method Detail

values

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

Returns:

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

valueOf

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

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface IEnabledIndicator

Returns:

true if the object is currently enabled, false otherwise.

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in interface IEnabledIndicator

Returns:

true if the object is currently disabled, false otherwise.

or

@Nonnull
public EEnabled or(@Nonnull
                  IEnabledIndicator aEnabled)

and

@Nonnull
public EEnabled and(@Nonnull
                   IEnabledIndicator aEnabled)

valueOf

@Nonnull
public static EEnabled valueOf(boolean bEnabled)

valueOf

@Nonnull
public static EEnabled valueOf(@Nonnull
                       IEnabledIndicator aEnabledIndicator)