Package org.odpi.openmetadata.serveroperations.properties

Enum Class ServerInstanceStatus

java.lang.Object

java.lang.Enum<ServerInstanceStatus>

org.odpi.openmetadata.serveroperations.properties.ServerInstanceStatus

All Implemented Interfaces:

Serializable, Comparable<ServerInstanceStatus>, Constable

public enum ServerInstanceStatus
extends Enum<ServerInstanceStatus>

Server instance status defines the state of the server (or a service) on a single platform.

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
INACTIVE	Inactive - The server is not running.
RUNNING	Running - The server has completed start up and is running.
STARTING	Starting - The server is starting.
STOPPING	Stopping - The server has received a request to shut down.
UNKNOWN	Unknown - The state of the server is unknown.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description for this enum.
String	getName()	Return the default name for this enum type.
int	getOrdinal()	Return the code for this enum used for indexing based on the enum value.
String	toString()	Standard toString method.
static ServerInstanceStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ServerInstanceStatus[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final ServerInstanceStatus UNKNOWN

Unknown - The state of the server is unknown. This is equivalent to a null value.

STARTING

public static final ServerInstanceStatus STARTING

Starting - The server is starting.

RUNNING

public static final ServerInstanceStatus RUNNING

Running - The server has completed start up and is running.

STOPPING

public static final ServerInstanceStatus STOPPING

Stopping - The server has received a request to shut down.

INACTIVE

public static final ServerInstanceStatus INACTIVE

Inactive - The server is not running.

Method Details

values

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

getOrdinal

public int getOrdinal()

Return the code for this enum used for indexing based on the enum value.

Returns:

int code number

getName

public String getName()

Return the default name for this enum type.

Returns:

String name

getDescription

public String getDescription()

Return the default description for this enum.

Returns:

String description

toString

public String toString()

Standard toString method.

Overrides:

toString in class Enum<ServerInstanceStatus>

Returns:

print out of variables in a JSON-style