com.vmware.vapi.bindings

Class DynamicStructureImpl

java.lang.Object

com.vmware.vapi.bindings.DynamicStructureImpl

All Implemented Interfaces:

DynamicStructure, Structure, Serializable

public final class DynamicStructureImpl
extends Object
implements DynamicStructure, Serializable

DynamicStructure implementation backed by a StructValue.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DynamicStructureImpl(StructValue strValue) Constructor.
DynamicStructureImpl(StructValue strValue, com.vmware.vapi.internal.bindings.TypeConverter converter) Constructor.

Method Summary

Modifier and Type	Method and Description
<T extends Structure> T	_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.
StructValue	_getDataValue() Returns this Structure represented in the dynamic DataValue model.
boolean	_hasTypeNameOf(Class<? extends Structure> clazz) Checks if the runtime type name of this structure matches the type represented by the specified binding class.
boolean	equals(Object other)
<T> T	getField(String fieldName, Class<T> targetClass) Gets a field value, represented as static bindings type.
int	hashCode()
<T> void	setField(String fieldName, T newValue, Class<T> valueClass) Sets a field value, represented as static bindings type.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicStructureImpl

public DynamicStructureImpl(StructValue strValue)

Constructor. default TypeConverter will be used.

Parameters:

strValue - the runtime struct value to be converted; must not be null

DynamicStructureImpl

public DynamicStructureImpl(StructValue strValue,
                            com.vmware.vapi.internal.bindings.TypeConverter converter)

Constructor.

Parameters:

strValue - the runtime struct value to be converted; must not be null

converter - for conversion from/to native types; must not be null

Method Detail

_getDataValue

public StructValue _getDataValue()

Description copied from interface: Structure

Returns this 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.

Specified by:

_getDataValue in interface Structure

Returns:

StructValue representing this structure

getField

public <T> T getField(String fieldName,
                      Class<T> targetClass)

Description copied from interface: DynamicStructure

Gets a field value, represented as static bindings type.

Specified by:

getField in interface DynamicStructure

Type Parameters:

T - static binding type for the field value

Parameters:

fieldName - name of the field to get

targetClass - Class for the result field value

Returns:

the field value

setField

public <T> void setField(String fieldName,
                         T newValue,
                         Class<T> valueClass)

Description copied from interface: DynamicStructure

Sets a field value, represented as static bindings type.

Specified by:

setField in interface DynamicStructure

Type Parameters:

T - static binding type for the field value

Parameters:

fieldName - name of the field to set

newValue - new value for fieldName field

valueClass - Class of newValue

_hasTypeNameOf

public boolean _hasTypeNameOf(Class<? extends Structure> clazz)

Description copied from interface: Structure

Checks if the runtime type name of this structure matches the type represented by the specified binding class.

This can be used as efficient check to determine if this instance can be successfully converted to the target type.

Specified by:

_hasTypeNameOf in interface Structure

Parameters:

clazz - bindings class for the target structure; must not be null

Returns:

true if this structures type name matches exactly the specified class' type name.

_convertTo

public <T extends Structure> T _convertTo(Class<T> clazz)

Description copied from interface: Structure

Converts this structure into an instance of the provided class structure if possible. A conversion will be possible if the requested structure's fields are all present in this structure.

Specified by:

_convertTo in interface Structure

Parameters:

clazz - type of the result structure. cannot be null.

Returns:

an instance of the requested type if conversion is possible. CoreException is thrown otherwise.

_getCanonicalName

public String _getCanonicalName()

Description copied from interface: Structure

Returns the canonical name of the structure. By default the canonical name is derived from the fully-qualified IDL name by converting to lower case and inserting underscores between words. For example org.example.FooBar would turn into org.example.foo_bar.

Specified by:

_getCanonicalName in interface Structure

Returns:

canonical name

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object