com.vmware.vcenter.vm

Class PowerTypes.State

java.lang.Object

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

com.vmware.vcenter.vm.PowerTypes.State

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

PowerTypes

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

The State enumeration class defines the valid power states for a virtual machine.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static PowerTypes.State	POWERED_OFF The virtual machine is powered off.
static PowerTypes.State	POWERED_ON The virtual machine is powered on.
static PowerTypes.State	SUSPENDED The virtual machine is suspended.

Method Summary

Methods

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

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

buildNameMap, equals, hashCode, name, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

POWERED_OFF

public static final PowerTypes.State POWERED_OFF

The virtual machine is powered off.

POWERED_ON

public static final PowerTypes.State POWERED_ON

The virtual machine is powered on.

SUSPENDED

public static final PowerTypes.State SUSPENDED

The virtual machine is suspended.

Method Detail

values

public static PowerTypes.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 PowerTypes.State but is not pre-defined.

Returns:

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

valueOf

public static PowerTypes.State valueOf(java.lang.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 PowerTypes.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 PowerTypes.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 PowerTypes.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 PowerTypes.State.Values._UNKNOWN enum constant is returned.

The native Java enum is PowerTypes.State.Values.

Returns:

The Java enum constant. Never null.