Package cloud.spawnery.agent.api

Enum Class ServerPhase

java.lang.Object

java.lang.Enum<ServerPhase>

cloud.spawnery.agent.api.ServerPhase

All Implemented Interfaces:

Serializable, Comparable<ServerPhase>, Constable

public enum ServerPhase
extends Enum<ServerPhase>

Where a server is in its life, in the operator's own vocabulary.

UNKNOWN is a phase this jar predates. Use fromWire(String) rather than valueOf, which throws.

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
DRAINING
FAILED
FINISHED	The round is over: the server said so with SpawneryApi.endRound() and its pod then stopped.
PENDING
READY
RETIRING
STARTING
TERMINATING
UNKNOWN

Method Summary

Modifier and Type	Method	Description
static ServerPhase	fromWire(String phase)	Maps the operator's spelling onto this enum, never throwing.
static ServerPhase	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ServerPhase[]	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

PENDING

public static final ServerPhase PENDING

STARTING

public static final ServerPhase STARTING

READY

public static final ServerPhase READY

RETIRING

public static final ServerPhase RETIRING

DRAINING

public static final ServerPhase DRAINING

TERMINATING

public static final ServerPhase TERMINATING

FAILED

public static final ServerPhase FAILED

FINISHED

public static final ServerPhase FINISHED

The round is over: the server said so with SpawneryApi.endRound() and its pod then stopped. Terminal like FAILED and replaced by its group at once, but not a fault: it costs the group no failure and is kept for a shorter retention than a failure.

UNKNOWN

public static final ServerPhase UNKNOWN

Method Details

values

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

fromWire

public static ServerPhase fromWire(String phase)

Maps the operator's spelling onto this enum, never throwing.