com.vmware.vcenter.vm.hardware

Class SerialTypes.BackingType

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<SerialTypes.BackingType>

com.vmware.vcenter.vm.hardware.SerialTypes.BackingType

All Implemented Interfaces:

Serializable

Enclosing interface:

SerialTypes

public static final class SerialTypes.BackingType
extends ApiEnumeration<SerialTypes.BackingType>

The BackingType enumeration class defines the valid backing types for a virtual serial port.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static SerialTypes.BackingType	FILE Virtual serial port is backed by a file.
static SerialTypes.BackingType	HOST_DEVICE Virtual serial port is backed by a device on the host where the virtual machine is running.
static SerialTypes.BackingType	NETWORK_CLIENT Virtual serial port is backed by a network client.
static SerialTypes.BackingType	NETWORK_SERVER Virtual serial port is backed by a network server.
static SerialTypes.BackingType	PIPE_CLIENT Virtual serial port is backed by a named pipe client.
static SerialTypes.BackingType	PIPE_SERVER Virtual serial port is backed by a named pipe server.

Method Summary

Methods

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

FILE

public static final SerialTypes.BackingType FILE

Virtual serial port is backed by a file.

HOST_DEVICE

public static final SerialTypes.BackingType HOST_DEVICE

Virtual serial port is backed by a device on the host where the virtual machine is running.

PIPE_SERVER

public static final SerialTypes.BackingType PIPE_SERVER

Virtual serial port is backed by a named pipe server. The virtual machine will accept a connection from a host application or another virtual machine on the same host. This is useful for capturing debugging information sent through the virtual serial port.

PIPE_CLIENT

public static final SerialTypes.BackingType PIPE_CLIENT

Virtual serial port is backed by a named pipe client. The virtual machine will connect to the named pipe provided by a host application or another virtual machine on the same host. This is useful for capturing debugging information sent through the virtual serial port.

NETWORK_SERVER

public static final SerialTypes.BackingType NETWORK_SERVER

Virtual serial port is backed by a network server. This backing may be used to create a network-accessible serial port on the virtual machine, accepting a connection from a remote system.

NETWORK_CLIENT

public static final SerialTypes.BackingType NETWORK_CLIENT

Virtual serial port is backed by a network client. This backing may be used to create a network-accessible serial port on the virtual machine, initiating a connection to a remote system.

Method Detail

values

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

Returns:

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

valueOf

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

The native Java enum is SerialTypes.BackingType.Values.

Returns:

The Java enum constant. Never null.