Package com.helger.base.state

Enum Class ESuccess

java.lang.Object

java.lang.Enum<ESuccess>

com.helger.base.state.ESuccess

All Implemented Interfaces:

ISuccessIndicator, Serializable, Comparable<ESuccess>, Constable

public enum ESuccess
extends Enum<ESuccess>
implements ISuccessIndicator

Small enum for manager actions to indicate success or failure.

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
FAILURE
SUCCESS

Method Summary

Modifier and Type	Method	Description
boolean	isSuccess()
static @NonNull ESuccess	valueOf(boolean bSuccess)	Convert a boolean value to the corresponding ESuccess enum value.
static @NonNull ESuccess	valueOf(@NonNull ISuccessIndicator aSuccessIndicator)	Convert an ISuccessIndicator to the corresponding ESuccess enum value.
static ESuccess	valueOf(String name)	Returns the enum constant of this class with the specified name.
static @NonNull ESuccess	valueOfChange(@NonNull IChangeIndicator aChange)	Convert an IChangeIndicator to the corresponding ESuccess enum value where changed maps to success.
static ESuccess[]	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.ISuccessIndicator

and, isFailure, or

Enum Constant Details

SUCCESS

public static final ESuccess SUCCESS

FAILURE

public static final ESuccess FAILURE

Method Details

values

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

isSuccess

public boolean isSuccess()

Specified by:

isSuccess in interface ISuccessIndicator

Returns:

true on success and false on failure.

valueOf

public static @NonNull ESuccess valueOf(boolean bSuccess)

Convert a boolean value to the corresponding ESuccess enum value.

Parameters:

bSuccess - true for SUCCESS, false for FAILURE.

Returns:

Never null.

valueOf

public static @NonNull ESuccess valueOf(@NonNull ISuccessIndicator aSuccessIndicator)

Convert an ISuccessIndicator to the corresponding ESuccess enum value.

Parameters:

aSuccessIndicator - The success indicator to convert. May not be null.

Returns:

Never null.

valueOfChange

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

Convert an IChangeIndicator to the corresponding ESuccess enum value where changed maps to success.

Parameters:

aChange - The change indicator to convert. May not be null.

Returns:

Never null.