com.helger.commons.state

Enum EFinish

java.lang.Object

java.lang.Enum<EFinish>

com.helger.commons.state.EFinish

All Implemented Interfaces:

IFinishIndicator, Serializable, Comparable<EFinish>

public enum EFinish
extends Enum<EFinish>
implements IFinishIndicator

Small enum for manager actions to indicate finished or unfinished states.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
FINISHED
UNFINISHED

Method Summary

Methods

Modifier and Type	Method and Description
EFinish	and(IFinishIndicator aFinish)
boolean	isFinished()
boolean	isUnfinished()
EFinish	or(IFinishIndicator aFinish)
static EFinish	valueOf(boolean bFinished)
static EFinish	valueOf(IFinishIndicator aFinishIndicator)
static EFinish	valueOf(String name) Returns the enum constant of this type with the specified name.
static EFinish[]	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

FINISHED

public static final EFinish FINISHED

UNFINISHED

public static final EFinish UNFINISHED

Method Detail

values

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

Returns:

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

valueOf

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

isFinished

public boolean isFinished()

Specified by:

isFinished in interface IFinishIndicator

Returns:

true if finished and false if unfinished.

isUnfinished

public boolean isUnfinished()

Specified by:

isUnfinished in interface IFinishIndicator

Returns:

true if unfinished and false if finished.

or

@Nonnull
public EFinish or(@Nonnull
                 IFinishIndicator aFinish)

and

@Nonnull
public EFinish and(@Nonnull
                  IFinishIndicator aFinish)

valueOf

@Nonnull
public static EFinish valueOf(boolean bFinished)

valueOf

@Nonnull
public static EFinish valueOf(@Nonnull
                      IFinishIndicator aFinishIndicator)