com.vmware.vcenter.vm.hardware

Class ConnectionState

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<ConnectionState>

com.vmware.vcenter.vm.hardware.ConnectionState

All Implemented Interfaces:

java.io.Serializable

public final class ConnectionState
extends ApiEnumeration<ConnectionState>

The ConnectionState enumeration class defines the valid states for a removable device that is configured to be connected.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static ConnectionState	CONNECTED The device is connected and working correctly.
static ConnectionState	NOT_CONNECTED The device is not connected.
static ConnectionState	RECOVERABLE_ERROR Device connection failed due to a recoverable error; for example, the virtual device backing is currently in use by another virtual machine.
static ConnectionState	UNKNOWN The device status is unknown.
static ConnectionState	UNRECOVERABLE_ERROR Device connection failed due to an unrecoverable error; for example, the virtual device backing does not exist.

Method Summary

Modifier and Type	Method and Description
ConnectionState.Values	getEnumValue() Returns a native Java enum constant representing this enumeration constant.
boolean	isUnknown() Checks if this enumeration constant is unknown.
static ConnectionState	valueOf(java.lang.String name) Returns the enumeration constant for the specified name.
static ConnectionState[]	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

CONNECTED

public static final ConnectionState CONNECTED

The device is connected and working correctly.

RECOVERABLE_ERROR

public static final ConnectionState RECOVERABLE_ERROR

Device connection failed due to a recoverable error; for example, the virtual device backing is currently in use by another virtual machine.

UNRECOVERABLE_ERROR

public static final ConnectionState UNRECOVERABLE_ERROR

Device connection failed due to an unrecoverable error; for example, the virtual device backing does not exist.

NOT_CONNECTED

public static final ConnectionState NOT_CONNECTED

The device is not connected.

UNKNOWN

public static final ConnectionState UNKNOWN

The device status is unknown.

Method Detail

values

public static ConnectionState[] 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 ConnectionState but is not pre-defined.

Returns:

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

valueOf

public static ConnectionState 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 ConnectionState will be returned for the specified name, which will not be one of the pre-defined constant instances. Such new instance maps to the ConnectionState.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 ConnectionState.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 ConnectionState.Values._UNKNOWN enum constant is returned.

The native Java enum is ConnectionState.Values.

Returns:

The Java enum constant. Never null.