public static final class SerialTypes.BackingSpec extends Object implements Serializable, StaticStructure
BackingSpec
class provides a specification of the physical resource
backing a virtual serial port.Modifier and Type | Class and Description |
---|---|
static class |
SerialTypes.BackingSpec.Builder
Builder class for
SerialTypes.BackingSpec . |
Constructor and Description |
---|
SerialTypes.BackingSpec()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
<T extends Structure> |
_convertTo(Class<T> clazz)
Converts this structure into an instance of the provided class structure
if possible.
|
String |
_getCanonicalName()
Returns the canonical name of the structure.
|
static String |
_getCanonicalTypeName()
Returns the canonical type name.
|
static com.vmware.vapi.bindings.type.StructType |
_getClassType()
WARNING: Internal API, subject to change in future versions.
|
StructValue |
_getDataValue()
Returns this
Structure represented in the dynamic
DataValue model. |
DataValue |
_getDynamicField(String fieldName)
Get dynamic filed value.
|
Set<String> |
_getDynamicFieldNames()
Get the names of the dynamic fields in the structure.
|
com.vmware.vapi.bindings.type.StructType |
_getType()
WARNING: Internal API, subject to change in future versions.
|
boolean |
_hasTypeNameOf(Class<? extends Structure> clazz)
Checks that the runtime type name matches the type name from the binding
class.
|
static SerialTypes.BackingSpec |
_newInstance(StructValue structValue)
WARNING: Internal API, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized. |
void |
_setDynamicField(String fieldName,
DataValue fieldValue)
Sets a dynamic field value.
|
void |
_validate()
Validates the state of the discriminated unions and HasFieldsOf
restrictions (if any) in this Java language binding
Structure . |
boolean |
equals(Object obj) |
String |
getFile()
Path of the file backing the virtual serial port.
|
String |
getHostDevice()
Name of the device backing the virtual serial port.
|
URI |
getNetworkLocation()
URI specifying the location of the network service backing the virtual serial
port.
|
Boolean |
getNoRxLoss()
Flag that enables optimized data transfer over the pipe.
|
String |
getPipe()
Name of the pipe backing the virtual serial port.
|
URI |
getProxy()
Proxy service that provides network access to the network backing.
|
SerialTypes.BackingType |
getType()
Backing type for the virtual serial port.
|
int |
hashCode() |
void |
setFile(String file)
Path of the file backing the virtual serial port.
|
void |
setHostDevice(String hostDevice)
Name of the device backing the virtual serial port.
|
void |
setNetworkLocation(URI networkLocation)
URI specifying the location of the network service backing the virtual serial
port.
|
void |
setNoRxLoss(Boolean noRxLoss)
Flag that enables optimized data transfer over the pipe.
|
void |
setPipe(String pipe)
Name of the pipe backing the virtual serial port.
|
void |
setProxy(URI proxy)
Proxy service that provides network access to the network backing.
|
void |
setType(SerialTypes.BackingType type)
Backing type for the virtual serial port.
|
String |
toString()
Returns a string representation of this structure.
|
public SerialTypes.BackingType getType()
public void setType(SerialTypes.BackingType type)
type
- New value for the property.public String getFile()
getType()
is SerialTypes.BackingType.FILE
.public void setFile(String file)
getType()
is SerialTypes.BackingType.FILE
.file
- New value for the property.public String getHostDevice()
null
, the virtual serial port will be configured to automatically
detect a suitable host device.public void setHostDevice(String hostDevice)
null
, the virtual serial port will be configured to automatically
detect a suitable host device.hostDevice
- New value for the property.public String getPipe()
getType()
is one of SerialTypes.BackingType.PIPE_SERVER
or SerialTypes.BackingType.PIPE_CLIENT
.public void setPipe(String pipe)
getType()
is one of SerialTypes.BackingType.PIPE_SERVER
or SerialTypes.BackingType.PIPE_CLIENT
.pipe
- New value for the property.public Boolean getNoRxLoss()
null
, defaults to false.public void setNoRxLoss(Boolean noRxLoss)
null
, defaults to false.noRxLoss
- New value for the property.public URI getNetworkLocation()
getType()
is SerialTypes.BackingType.NETWORK_SERVER
, this
property is the location used by clients to connect to this server. The hostname
part of the URI should either be empty or should specify the address of the host
on which the virtual machine is running.getType()
is SerialTypes.BackingType.NETWORK_CLIENT
, this
property is the location used by the virtual machine to connect to the remote
server.getType()
is one of SerialTypes.BackingType.NETWORK_SERVER
or SerialTypes.BackingType.NETWORK_CLIENT
.public void setNetworkLocation(URI networkLocation)
getType()
is SerialTypes.BackingType.NETWORK_SERVER
, this
property is the location used by clients to connect to this server. The hostname
part of the URI should either be empty or should specify the address of the host
on which the virtual machine is running.getType()
is SerialTypes.BackingType.NETWORK_CLIENT
, this
property is the location used by the virtual machine to connect to the remote
server.getType()
is one of SerialTypes.BackingType.NETWORK_SERVER
or SerialTypes.BackingType.NETWORK_CLIENT
.networkLocation
- New value for the property.public URI getProxy()
null
, no proxy service should be used.public void setProxy(URI proxy)
null
, no proxy service should be used.proxy
- New value for the property.public com.vmware.vapi.bindings.type.StructType _getType()
StaticStructure
StructType
instance representing the static bindings
type for this Structure
._getType
in interface StaticStructure
StructType
public StructValue _getDataValue()
Structure
Structure
represented in the dynamic
DataValue
model.
Attempts to change the returned StructValue
representation are not required to change the state of this structure.
Actually the behavior is implementation dependent and is unspecified.
In general the returned value shouldn't be changed.
_getDataValue
in interface Structure
StructValue
representing this structurepublic void _validate()
StaticStructure
Structure
.
More precisely, for each union: given value of the discriminant/tag
field (@UnionTag
in the IDL) of an union in this structure,
validates that:
_validate
in interface StaticStructure
public String toString()
StaticStructure
In general no code should depend on the format of the resulting string. E.g. there must be no attempts to parse for re-creation of the original instance.
toString
in interface StaticStructure
toString
in class Object
public boolean _hasTypeNameOf(Class<? extends Structure> clazz)
Structure
_hasTypeNameOf
in interface Structure
clazz
- type of the result structure. cannot be null.public <T extends Structure> T _convertTo(Class<T> clazz)
Structure
_convertTo
in interface Structure
clazz
- type of the result structure. cannot be null.CoreException
is thrown otherwise.public void _setDynamicField(String fieldName, DataValue fieldValue)
StaticStructure
_setDynamicField
in interface StaticStructure
fieldName
- canonical name of the dynamic field to setfieldValue
- the value of the fieldpublic DataValue _getDynamicField(String fieldName)
StaticStructure
_getDynamicField
in interface StaticStructure
fieldName
- the canonical name of the dynamic fieldDataValue
of the dynamic fieldpublic Set<String> _getDynamicFieldNames()
StaticStructure
_getDynamicFieldNames
in interface StaticStructure
public static com.vmware.vapi.bindings.type.StructType _getClassType()
StructType
instance representing the static bindings
type for this Structure
.public String _getCanonicalName()
Structure
org.example.FooBar
would turn into
org.example.foo_bar
._getCanonicalName
in interface Structure
public static String _getCanonicalTypeName()
_getCanonicalName()
.public static SerialTypes.BackingSpec _newInstance(StructValue structValue)
structValue
- the source of the data contained in the binding object. Could
contain more data than fields of this class can describe i.e.
newer version of the binding object. Could be null.StructType
Copyright © 2016. All Rights Reserved.