Enum Class NBInvokableState

java.lang.Object

java.lang.Enum<NBInvokableState>

io.nosqlbench.nb.api.components.core.NBInvokableState

All Implemented Interfaces:

Serializable, Comparable<NBInvokableState>, Constable

public enum NBInvokableState
extends Enum<NBInvokableState>

 errored_at > 0   -> ERROR
 started_at == 0   -> STARTING
 <p>
 <p>
 <p>
 started_at > closed_at
 STARTING
 closed_at > started_at
 RUNNING
 teardown_at > closed_at
 STOPPING
 teardown_at
 STOPPED
 stopped_at
 

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
CLOSING	The component has begun closing down, which means unwinding/closing any child components
ERRORED	There was an error
RUNNING	The component has completed initialization and is presumed to be running
STARTING	The component exists in some state but has not completed initialization / construction
STOPPED	The component has completed closing down, including its teardown logic

Method Summary

Modifier and Type	Method	Description
static NBInvokableState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NBInvokableState[]	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

Enum Constant Details

STARTING

public static final NBInvokableState STARTING

The component exists in some state but has not completed initialization / construction

RUNNING

public static final NBInvokableState RUNNING

The component has completed initialization and is presumed to be running

CLOSING

public static final NBInvokableState CLOSING

The component has begun closing down, which means unwinding/closing any child components

STOPPED

public static final NBInvokableState STOPPED

The component has completed closing down, including its teardown logic

ERRORED

public static final NBInvokableState ERRORED

There was an error

Method Details

values

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