Package org.opt4j.core.optimizer

Enum Class Control.State

java.lang.Object

java.lang.Enum<Control.State>

org.opt4j.core.optimizer.Control.State

All Implemented Interfaces:

Serializable, Comparable<Control.State>, Constable

Enclosing class:

Control

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

The Control.State of the control.

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
PAUSED	The paused state.
RUNNING	The running state.
STOPPED	The stopped state.
TERMINATED	The terminated state.

Method Summary

Modifier and Type	Method	Description
boolean	isPausable()	Returns true if the current state allows to pause the optimization.
boolean	isStartable()	Returns true if the current state allows to start the optimization.
boolean	isStoppable()	Returns true if the current state allows to stop the optimization.
static Control.State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Control.State[]	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

RUNNING

public static final Control.State RUNNING

The running state.

PAUSED

public static final Control.State PAUSED

The paused state.

STOPPED

public static final Control.State STOPPED

The stopped state.

TERMINATED

public static final Control.State TERMINATED

The terminated state.

Method Details

values

public static Control.State[] 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 Control.State 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

isStartable

public boolean isStartable()

Returns true if the current state allows to start the optimization.

Returns:

true if start is available

isPausable

public boolean isPausable()

Returns true if the current state allows to pause the optimization.

Returns:

true if pause is available

isStoppable

public boolean isStoppable()

Returns true if the current state allows to stop the optimization.

Returns:

true if stop is available