org.apache.ratis.util

Enum LifeCycle.State

java.lang.Object

java.lang.Enum<LifeCycle.State>

org.apache.ratis.util.LifeCycle.State

All Implemented Interfaces:

Serializable, Comparable<LifeCycle.State>

Enclosing class:

LifeCycle

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

The states in the life cycle.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSED The machine is closed, a final state.
CLOSING The machine is closing, stopping providing service and releasing resources.
EXCEPTION The machine catches an internal exception so that it must be closed.
NEW The machine is newly created and holds zero resource.
PAUSED The machine is paused and does not provide any service.
PAUSING The machine is pausing and stopping providing service.
RUNNING The machine is running and providing service.
STARTING The machine is starting and does not yet provide any service.

Method Summary

Modifier and Type	Method and Description
boolean	isClosingOrClosed() Is this CLOSING or CLOSED?
boolean	isPausingOrPaused() Is this PAUSING or PAUSED?
boolean	isRunning() Is this RUNNING?
static boolean	isValid(LifeCycle.State from, LifeCycle.State to) Is the given transition valid?
static LifeCycle.State	valueOf(String name) Returns the enum constant of this type with the specified name.
static LifeCycle.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

NEW

public static final LifeCycle.State NEW

The machine is newly created and holds zero resource.

STARTING

public static final LifeCycle.State STARTING

The machine is starting and does not yet provide any service.

RUNNING

public static final LifeCycle.State RUNNING

The machine is running and providing service.

PAUSING

public static final LifeCycle.State PAUSING

The machine is pausing and stopping providing service.

PAUSED

public static final LifeCycle.State PAUSED

The machine is paused and does not provide any service.

EXCEPTION

public static final LifeCycle.State EXCEPTION

The machine catches an internal exception so that it must be closed.

CLOSING

public static final LifeCycle.State CLOSING

The machine is closing, stopping providing service and releasing resources.

CLOSED

public static final LifeCycle.State CLOSED

The machine is closed, a final state.

Method Detail

values

public static LifeCycle.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 (LifeCycle.State c : LifeCycle.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 LifeCycle.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

isRunning

public boolean isRunning()

Is this RUNNING?

isClosingOrClosed

public boolean isClosingOrClosed()

Is this CLOSING or CLOSED?

isPausingOrPaused

public boolean isPausingOrPaused()

Is this PAUSING or PAUSED?

isValid

public static boolean isValid(LifeCycle.State from,
                              LifeCycle.State to)

Is the given transition valid?