com.speedment.component

Enum Lifecyclable.State

java.lang.Object

java.lang.Enum<Lifecyclable.State>

com.speedment.component.Lifecyclable.State

All Implemented Interfaces:

Serializable, Comparable<Lifecyclable.State>

Enclosing interface:

Lifecyclable<T extends Lifecyclable<T>>

public static enum Lifecyclable.State
extends Enum<Lifecyclable.State>

The state of the Lifecyclable is defined by the enum constants. Transition from one state to another must only be made sequentially in strict ordinal order using the nextState() method or an equivalent.

See Also:

CREATED, INIITIALIZED, LOADED, RESOLVED, STARTED, STOPPED

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREATED The Lifecyclable has been created but no Lifecyclable methods has been called on it yet.
INIITIALIZED The Lifecyclable has been initialized.
LOADED The Lifecyclable has been initialized and loaded.
RESOLVED The Lifecyclable has been initialized, loaded and resolved.
STARTED The Lifecyclable has been initialized, loaded, resolved and started.
STOPPED The Lifecyclable has been initialized, loaded, resolved, started and stopped.

Method Summary

Modifier and Type	Method and Description
void	checkNextState(Lifecyclable.State nextState) Asserts that the specified state is the correct next one.
Optional<Lifecyclable.State>	nextState() Returns the next State after this, if any.
boolean	onOrAfter(Lifecyclable.State compareToState) Returns if this State is on or after the provided state.
static Lifecyclable.State	valueOf(String name) Returns the enum constant of this type with the specified name.
static Lifecyclable.State[]	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

CREATED

public static final Lifecyclable.State CREATED

The Lifecyclable has been created but no Lifecyclable methods has been called on it yet.

INIITIALIZED

public static final Lifecyclable.State INIITIALIZED

The Lifecyclable has been initialized.

The following method(s) has been called and has completed on the Lifecyclable:

• Lifecyclable.initialize()

LOADED

public static final Lifecyclable.State LOADED

The Lifecyclable has been initialized and loaded.

The following method(s) has been called and has completed on the Lifecyclable:

• Lifecyclable.initialize()
• Lifecyclable.load()

RESOLVED

public static final Lifecyclable.State RESOLVED

The Lifecyclable has been initialized, loaded and resolved.

The following method(s) has been called and has completed on the Lifecyclable:

• Lifecyclable.initialize()
• Lifecyclable.load()
• Lifecyclable.resolve()

STARTED

public static final Lifecyclable.State STARTED

The Lifecyclable has been initialized, loaded, resolved and started.

The following method(s) has been called and has completed on the Lifecyclable:

• Lifecyclable.initialize()
• Lifecyclable.load()
• Lifecyclable.resolve()
• Lifecyclable.start()

STOPPED

public static final Lifecyclable.State STOPPED

The Lifecyclable has been initialized, loaded, resolved, started and stopped.

The following method(s) has been called and has completed on the Lifecyclable:

• Lifecyclable.initialize()
• Lifecyclable.load()
• Lifecyclable.resolve()
• Lifecyclable.start()
• Lifecyclable.stop()

Method Detail

values

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

Returns:

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

valueOf

public static Lifecyclable.State 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

checkNextState

public void checkNextState(Lifecyclable.State nextState)

Asserts that the specified state is the correct next one. If it is not, an IllegalStateException is thrown.

Parameters:

nextState - the proposed next state

nextState

public Optional<Lifecyclable.State> nextState()

Returns the next State after this, if any. If there is no following State, an empty optional is returned.

Returns:

the next State or empty if there is none

onOrAfter

public boolean onOrAfter(Lifecyclable.State compareToState)

Returns if this State is on or after the provided state. Thus, it returns if this State is the same or has already passed the provided state.

Parameters:

compareToState - the State to compare this with

Returns:

if same or earlier