com.vmware.appliance.vmon

Class ServiceTypes.State

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<ServiceTypes.State>

com.vmware.appliance.vmon.ServiceTypes.State

All Implemented Interfaces:

Serializable

Enclosing interface:

ServiceTypes

public static final class ServiceTypes.State
extends ApiEnumeration<ServiceTypes.State>

The State enumeration class defines valid Run State for services.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceTypes.State.Values Native Java enum representing this enumeration class.

Field Summary

Fields

Modifier and Type	Field and Description
static ServiceTypes.State	STARTED Service Run State is Started, it is fully functional
static ServiceTypes.State	STARTING Service Run State is Starting, it is still not functional
static ServiceTypes.State	STOPPED Service Run State is Stopped
static ServiceTypes.State	STOPPING Service Run State is Stopping, it is not functional

Method Summary

Methods

Modifier and Type	Method and Description
ServiceTypes.State.Values	getEnumValue() Returns a native Java enum constant representing this enumeration constant.
boolean	isUnknown() Checks if this enumeration constant is unknown.
static ServiceTypes.State	valueOf(String name) Returns the enumeration constant for the specified name.
static ServiceTypes.State[]	values() Retrieve all enumeration constants pre-defined by this enumeration class.

Methods inherited from class com.vmware.vapi.bindings.ApiEnumeration

equals, hashCode, name, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

STARTING

public static final ServiceTypes.State STARTING

Service Run State is Starting, it is still not functional

STOPPING

public static final ServiceTypes.State STOPPING

Service Run State is Stopping, it is not functional

STARTED

public static final ServiceTypes.State STARTED

Service Run State is Started, it is fully functional

STOPPED

public static final ServiceTypes.State STOPPED

Service Run State is Stopped

Method Detail

values

public static ServiceTypes.State[] values()

Retrieve all enumeration constants pre-defined by this enumeration class.

Additional instances might exist at runtime, for example to represent a new constant added to this enumeration class in subsequent version of the API. Such new constant is represented as instance of ServiceTypes.State but is not pre-defined.

Returns:

Array of all pre-defined enumeration constants. Never null.

valueOf

public static ServiceTypes.State valueOf(String name)

Returns the enumeration constant for the specified name.

If the name matches exactly the identifier used to declare an enumeration constant from this enumeration class, the constant in question will be returned.

Otherwise, a new instance of ServiceTypes.State will be returned for the specified name, which will not be one of the pre-defined constant instances. Such new instance maps to the ServiceTypes.State.Values._UNKNOWN enum constant from the native Java enum.

Parameters:

name - The name of the constant to return. Must not be null.

Returns:

Enumeration constant for the specified name. Never null.

isUnknown

public boolean isUnknown()

Checks if this enumeration constant is unknown. Unknown is a constant that is not one of the pre-defined ones for this enumeration class. Also see valueOf(java.lang.String) and values().

Returns:

true if this constant is unknown, and false otherwise.

getEnumValue

public ServiceTypes.State.Values getEnumValue()

Returns a native Java enum constant representing this enumeration constant. The result is useful for usual handling of Java enum, for example it can be used in switch statements.

If this enumeration constant is unknown, then ServiceTypes.State.Values._UNKNOWN enum constant is returned.

The native Java enum is ServiceTypes.State.Values.

Returns:

The Java enum constant. Never null.