Package com.helger.commons.state

Enum ESuccess

java.lang.Object

java.lang.Enum<ESuccess>

com.helger.commons.state.ESuccess

All Implemented Interfaces:

ISuccessIndicator, Serializable, Comparable<ESuccess>

public enum ESuccess
extends Enum<ESuccess>
implements ISuccessIndicator

Small enum for manager actions to indicate success or failure.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAILURE
SUCCESS

Method Summary

Modifier and Type	Method	Description
boolean	isSuccess()
static ESuccess	valueOf(boolean bSuccess)	Returns the enum constant of this type with the specified name.
static ESuccess	valueOf(ISuccessIndicator aSuccessIndicator)	Returns the enum constant of this type with the specified name.
static ESuccess	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ESuccess	valueOfChange(IChangeIndicator aChange)
static ESuccess[]	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.ISuccessIndicator

and, isFailure, or

Enum Constant Detail

SUCCESS

public static final ESuccess SUCCESS

FAILURE

public static final ESuccess FAILURE

Method Detail

values

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

Returns:

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

valueOf

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

isSuccess

public boolean isSuccess()

Specified by:

isSuccess in interface ISuccessIndicator

Returns:

true on success and false on failure.

valueOf

@Nonnull
public static ESuccess valueOf(boolean bSuccess)

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:

bSuccess - 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 ESuccess valueOf(@Nonnull
                               ISuccessIndicator aSuccessIndicator)

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:

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

valueOfChange

@Nonnull
public static ESuccess valueOfChange(@Nonnull
                                     IChangeIndicator aChange)