org.apache.slider.providers.agent

Enum State

java.lang.Object

java.lang.Enum<State>

org.apache.slider.providers.agent.State

All Implemented Interfaces:

Serializable, Comparable<State>

public enum State
extends Enum<State>

The states a component instance can be.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INIT
INSTALL_FAILED
INSTALLED
INSTALLING
STARTED
STARTING
STOPPED
STOPPING
TERMINATING
UPGRADED
UPGRADING

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canIssueCommands() Indicates whether or not it is a valid state to produce a command.
boolean	couldHaveIssued(Command command)
State	getNextState(Command command) Returns next state based on the command.
State	getNextState(CommandResult result) Returns next state based on the command result.
Command	getSupportedCommand() Returns valid command in this state.
Command	getSupportedCommand(boolean isInUpgradeMode)
Command	getSupportedCommand(boolean isInUpgradeMode, boolean stopInitiated)
static State	valueOf(String name) Returns the enum constant of this type with the specified name.
static 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

INIT

public static final State INIT

INSTALLING

public static final State INSTALLING

INSTALLED

public static final State INSTALLED

STARTING

public static final State STARTING

STARTED

public static final State STARTED

INSTALL_FAILED

public static final State INSTALL_FAILED

UPGRADING

public static final State UPGRADING

UPGRADED

public static final State UPGRADED

STOPPING

public static final State STOPPING

STOPPED

public static final State STOPPED

TERMINATING

public static final State TERMINATING

Method Detail

values

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

canIssueCommands

public boolean canIssueCommands()

Indicates whether or not it is a valid state to produce a command.

Returns:

true if command can be issued for this state.

getSupportedCommand

public Command getSupportedCommand()

Returns valid command in this state.

Returns:

command allowed in this state.

getSupportedCommand

public Command getSupportedCommand(boolean isInUpgradeMode)

getSupportedCommand

public Command getSupportedCommand(boolean isInUpgradeMode,
                          boolean stopInitiated)

getNextState

public State getNextState(CommandResult result)
                   throws IllegalArgumentException

Returns next state based on the command result.

Returns:

next state.

Throws:

IllegalArgumentException

getNextState

public State getNextState(Command command)
                   throws IllegalArgumentException

Returns next state based on the command.

Returns:

next state.

Throws:

IllegalArgumentException

couldHaveIssued

public boolean couldHaveIssued(Command command)