com.vmware.vapi.metadata.metamodel

Class ElementValue

java.lang.Object

com.vmware.vapi.metadata.metamodel.ElementValue

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

public final class ElementValue
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

The ElementValue class describes the value of the metadata element.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ElementValue.Builder Builder class for ElementValue.
static class	ElementValue.Type The Type enumeration class defines the valid types for values in metadata elements.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	ElementValue() Default constructor.
protected	ElementValue(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Summary

Modifier and Type	Method and Description
<T extends com.vmware.vapi.bindings.Structure> T	_convertTo(java.lang.Class<T> clazz)
java.lang.String	_getCanonicalName()
static java.lang.String	_getCanonicalTypeName() Returns the canonical type name.
static com.vmware.vapi.bindings.type.StructType	_getClassType() WARNING: Internal method, subject to change in future versions.
com.vmware.vapi.data.StructValue	_getDataValue()
com.vmware.vapi.data.DataValue	_getDynamicField(java.lang.String fieldName)
java.util.Set<java.lang.String>	_getDynamicFieldNames()
com.vmware.vapi.bindings.type.StructType	_getType()
boolean	_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
static ElementValue	_newInstance(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, 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.
static ElementValue	_newInstance2(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
void	_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)
protected void	_updateDataValue(com.vmware.vapi.data.StructValue structValue)
void	_validate()
boolean	equals(java.lang.Object obj)
java.util.List<java.lang.String>	getListValue() List of strings value of the metadata element.
java.lang.Long	getLongValue() Long value of the metadata element.
java.lang.String	getStringValue() String value of the metadata element.
java.lang.String	getStructureId() Identifier of the structure element.
java.util.List<java.lang.String>	getStructureIds() List of identifiers of the structure elements.
ElementValue.Type	getType() Type of the value.
int	hashCode()
void	setListValue(java.util.List<java.lang.String> listValue) List of strings value of the metadata element.
void	setLongValue(java.lang.Long longValue) Long value of the metadata element.
void	setStringValue(java.lang.String stringValue) String value of the metadata element.
void	setStructureId(java.lang.String structureId) Identifier of the structure element.
void	setStructureIds(java.util.List<java.lang.String> structureIds) List of identifiers of the structure elements.
void	setType(ElementValue.Type type) Type of the value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

ElementValue

public ElementValue()

Default constructor.

ElementValue

protected ElementValue(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Detail

getType

public ElementValue.Type getType()

Type of the value.

Returns:

The current value of the property.

setType

public void setType(ElementValue.Type type)

Type of the value.

Parameters:

type - New value for the property.

getLongValue

public java.lang.Long getLongValue()

Long value of the metadata element. This property is optional and it is only relevant when the value of getType() is ElementValue.Type.LONG.

Returns:

The current value of the property.

setLongValue

public void setLongValue(java.lang.Long longValue)

Long value of the metadata element. This property is optional and it is only relevant when the value of getType() is ElementValue.Type.LONG.

Parameters:

longValue - New value for the property.

getStringValue

public java.lang.String getStringValue()

String value of the metadata element. This property is optional and it is only relevant when the value of getType() is ElementValue.Type.STRING.

Returns:

The current value of the property.

setStringValue

public void setStringValue(java.lang.String stringValue)

String value of the metadata element. This property is optional and it is only relevant when the value of getType() is ElementValue.Type.STRING.

Parameters:

stringValue - New value for the property.

getListValue

public java.util.List<java.lang.String> getListValue()

List of strings value of the metadata element. This property is optional and it is only relevant when the value of getType() is ElementValue.Type.STRING_LIST.

Returns:

The current value of the property.

setListValue

public void setListValue(java.util.List<java.lang.String> listValue)

List of strings value of the metadata element. This property is optional and it is only relevant when the value of getType() is ElementValue.Type.STRING_LIST.

Parameters:

listValue - New value for the property.

getStructureId

public java.lang.String getStructureId()

Identifier of the structure element. This property is optional and it is only relevant when the value of getType() is ElementValue.Type.STRUCTURE_REFERENCE.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: com.vmware.vapi.structure. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.vapi.structure.

setStructureId

public void setStructureId(java.lang.String structureId)

Identifier of the structure element. This property is optional and it is only relevant when the value of getType() is ElementValue.Type.STRUCTURE_REFERENCE.

Parameters:

structureId - New value for the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: com.vmware.vapi.structure. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.vapi.structure.

getStructureIds

public java.util.List<java.lang.String> getStructureIds()

List of identifiers of the structure elements. This property is optional and it is only relevant when the value of getType() is ElementValue.Type.STRUCTURE_REFERENCE_LIST.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the property must contain identifiers for the resource type: com.vmware.vapi.structure. When methods return a value of this class as a return value, the property will contain identifiers for the resource type: com.vmware.vapi.structure.

setStructureIds

public void setStructureIds(java.util.List<java.lang.String> structureIds)

List of identifiers of the structure elements. This property is optional and it is only relevant when the value of getType() is ElementValue.Type.STRUCTURE_REFERENCE_LIST.

Parameters:

structureIds - New value for the property. When clients pass a value of this class as a parameter, the property must contain identifiers for the resource type: com.vmware.vapi.structure. When methods return a value of this class as a return value, the property will contain identifiers for the resource type: com.vmware.vapi.structure.

_getType

public com.vmware.vapi.bindings.type.StructType _getType()

Specified by:

_getType in interface com.vmware.vapi.bindings.StaticStructure

_getDataValue

public com.vmware.vapi.data.StructValue _getDataValue()

Specified by:

_getDataValue in interface com.vmware.vapi.bindings.Structure

_updateDataValue

protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)

_validate

public void _validate()

Specified by:

_validate in interface com.vmware.vapi.bindings.StaticStructure

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Specified by:

toString in interface com.vmware.vapi.bindings.StaticStructure

Overrides:

toString in class java.lang.Object

_hasTypeNameOf

public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)

Specified by:

_hasTypeNameOf in interface com.vmware.vapi.bindings.Structure

_convertTo

public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)

Specified by:

_convertTo in interface com.vmware.vapi.bindings.Structure

_setDynamicField

public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)

Specified by:

_setDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicField

public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)

Specified by:

_getDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicFieldNames

public java.util.Set<java.lang.String> _getDynamicFieldNames()

Specified by:

_getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure

_getClassType

public static com.vmware.vapi.bindings.type.StructType _getClassType()

WARNING: Internal method, subject to change in future versions.

Returns:

StructType instance representing the static bindings type for this Structure.

_getCanonicalName

public java.lang.String _getCanonicalName()

Specified by:

_getCanonicalName in interface com.vmware.vapi.bindings.Structure

_getCanonicalTypeName

public static java.lang.String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static ElementValue _newInstance(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, 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.

Parameters:

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.

Returns:

the static bindings StructType

_newInstance2

public static ElementValue _newInstance2(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.