com.vmware.vapi.metadata.metamodel

Class StructureInfo

java.lang.Object

com.vmware.vapi.metadata.metamodel.StructureInfo

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable

public final class StructureInfo
extends java.lang.Object
implements java.io.Serializable, StaticStructure

The StructureInfo class contains the metamodel information of all the field elements, constant elements and enumeration elements contained in the structure element.

In the interface definition language, API designers have the ability to include all the fields from one structure to another structure. This is done by using an annotation @Include on the structure in which we want to add the fields. If this annotation is present, the list of fields in the StructureInfo will also contain the fields that are being included. The annotation information is also retained in the getMetadata() element as well.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StructureInfo.Builder Builder class for StructureInfo.
static class	StructureInfo.Type The Type enumeration class defines the kind of this structure element.

Field Summary

Fields

Modifier and Type	Field and Description
protected StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	StructureInfo() Default constructor.
protected	StructureInfo(StructValue __dynamicStructureFields)

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Structure> T	_convertTo(java.lang.Class<T> clazz) Converts this structure into an instance of the provided class structure if possible.
java.lang.String	_getCanonicalName() Returns the canonical name of the structure.
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.
StructValue	_getDataValue() Returns this Structure represented in the dynamic DataValue model.
DataValue	_getDynamicField(java.lang.String fieldName) Get dynamic filed value.
java.util.Set<java.lang.String>	_getDynamicFieldNames() Get the names of the dynamic fields in the structure.
com.vmware.vapi.bindings.type.StructType	_getType() WARNING: Internal method, subject to change in future versions.
boolean	_hasTypeNameOf(java.lang.Class<? extends Structure> clazz) Checks that the runtime type name matches the type name from the binding class.
static StructureInfo	_newInstance(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.
void	_setDynamicField(java.lang.String fieldName, DataValue fieldValue) Sets a dynamic field value.
protected void	_updateDataValue(StructValue structValue)
void	_validate() Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,ConstantInfo>	getConstants() Metamodel information of all the constant elements contained in the structure element.
java.lang.String	getDocumentation() English language documentation for a structure element.
java.util.Map<java.lang.String,EnumerationInfo>	getEnumerations() Metamodel information of all the enumeration elements contained in the structure element.
java.util.List<FieldInfo>	getFields() Metamodel information of all the field elements.
java.util.Map<java.lang.String,ElementMap>	getMetadata() Generic metadata elements for the structure element.
java.lang.String	getName() Dot separated name of the structure element.
StructureInfo.Type	getType() Type of the structure.
int	hashCode()
void	setConstants(java.util.Map<java.lang.String,ConstantInfo> constants) Metamodel information of all the constant elements contained in the structure element.
void	setDocumentation(java.lang.String documentation) English language documentation for a structure element.
void	setEnumerations(java.util.Map<java.lang.String,EnumerationInfo> enumerations) Metamodel information of all the enumeration elements contained in the structure element.
void	setFields(java.util.List<FieldInfo> fields) Metamodel information of all the field elements.
void	setMetadata(java.util.Map<java.lang.String,ElementMap> metadata) Generic metadata elements for the structure element.
void	setName(java.lang.String name) Dot separated name of the structure element.
void	setType(StructureInfo.Type type) Type of the structure.
java.lang.String	toString() Returns a string representation of this structure.

Methods inherited from class java.lang.Object

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

Field Detail

__dynamicStructureFields

protected final StructValue __dynamicStructureFields

Constructor Detail

StructureInfo

public StructureInfo()

Default constructor.

StructureInfo

protected StructureInfo(StructValue __dynamicStructureFields)

Method Detail

getName

public java.lang.String getName()

Dot separated name of the structure element. The segments in the name reflect the organization of the APIs. The format of each segment is lower case with underscores. Each underscore represents a word boundary. If there are acronyms in the word, the capitalization is preserved. This format makes it easy to translate the segment into a different naming convention.

Returns:

The current value of the property.

setName

public void setName(java.lang.String name)

Dot separated name of the structure element. The segments in the name reflect the organization of the APIs. The format of each segment is lower case with underscores. Each underscore represents a word boundary. If there are acronyms in the word, the capitalization is preserved. This format makes it easy to translate the segment into a different naming convention.

Parameters:

name - New value for the property.

getType

public StructureInfo.Type getType()

Type of the structure.

Returns:

The current value of the property.

setType

public void setType(StructureInfo.Type type)

Type of the structure.

Parameters:

type - New value for the property.

getEnumerations

public java.util.Map<java.lang.String,EnumerationInfo> getEnumerations()

Metamodel information of all the enumeration elements contained in the structure element. The key in the Map is the identifier of the enumeration element and the value is the metamodel information of the enumeration element.

Returns:

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

setEnumerations

public void setEnumerations(java.util.Map<java.lang.String,EnumerationInfo> enumerations)

Metamodel information of all the enumeration elements contained in the structure element. The key in the Map is the identifier of the enumeration element and the value is the metamodel information of the enumeration element.

Parameters:

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

getConstants

public java.util.Map<java.lang.String,ConstantInfo> getConstants()

Metamodel information of all the constant elements contained in the structure element. The key in the Map is the name of the constant element and the value in the Map is the metamodel information for the constant element.

Returns:

The current value of the property.

setConstants

public void setConstants(java.util.Map<java.lang.String,ConstantInfo> constants)

Metamodel information of all the constant elements contained in the structure element. The key in the Map is the name of the constant element and the value in the Map is the metamodel information for the constant element.

Parameters:

constants - New value for the property.

getFields

public java.util.List<FieldInfo> getFields()

Metamodel information of all the field elements. The order of the field elements in the list matches the order in which the fields are defined in the service.

Returns:

The current value of the property.

setFields

public void setFields(java.util.List<FieldInfo> fields)

Metamodel information of all the field elements. The order of the field elements in the list matches the order in which the fields are defined in the service.

Parameters:

fields - New value for the property.

getMetadata

public java.util.Map<java.lang.String,ElementMap> getMetadata()

Generic metadata elements for the structure element. The key in the Map is the name of the metadata element and the value is the data associated with that metadata element.

The MetadataIdentifier contains possible string values for keys in the Map.

Returns:

The current value of the property.

setMetadata

public void setMetadata(java.util.Map<java.lang.String,ElementMap> metadata)

Generic metadata elements for the structure element. The key in the Map is the name of the metadata element and the value is the data associated with that metadata element.

The MetadataIdentifier contains possible string values for keys in the Map.

Parameters:

metadata - New value for the property.

getDocumentation

public java.lang.String getDocumentation()

English language documentation for a structure element. It can contain HTML markup and Javadoc tags. The first sentence of the structure documentation is a complete sentence that identifies the structure by name and summarizes the purpose of the structure.

Returns:

The current value of the property.

setDocumentation

public void setDocumentation(java.lang.String documentation)

English language documentation for a structure element. It can contain HTML markup and Javadoc tags. The first sentence of the structure documentation is a complete sentence that identifies the structure by name and summarizes the purpose of the structure.

Parameters:

documentation - New value for the property.

_getType

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

Description copied from interface: StaticStructure

WARNING: Internal method, subject to change in future versions. Returns StructType instance representing the static bindings type for this Structure.

Specified by:

_getType in interface StaticStructure

Returns:

the static bindings StructType

_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

_updateDataValue

protected void _updateDataValue(StructValue structValue)

_validate

public void _validate()

Description copied from interface: StaticStructure

Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding 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:

all fields of the union required for that value of the discriminant are set fields of the union that are not allowed for that value of the discriminant are not set any other fields of the structure (not participating in the union) do not affect the validation result

Specified by:

_validate in interface 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()

Description copied from interface: StaticStructure

Returns a string representation of this structure. The result is pretty printed in order to be easy to read. It is intended to be used for different debugging/tracing purposes, e.g. dumping structures into logging traces.

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.

Specified by:

toString in interface StaticStructure

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this static structure instance

_hasTypeNameOf

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

Description copied from interface: Structure

Checks that the runtime type name matches the type name from the binding class.

Specified by:

_hasTypeNameOf in interface Structure

Parameters:

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

Returns:

true if this structures type name matches exactly the provided class type name.

_convertTo

public <T extends Structure> T _convertTo(java.lang.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.

_setDynamicField

public void _setDynamicField(java.lang.String fieldName,
                    DataValue fieldValue)

Description copied from interface: StaticStructure

Sets a dynamic field value. The dynamic filed is extra filed that is not part of the static fields of the structure.

Specified by:

_setDynamicField in interface StaticStructure

Parameters:

fieldName - canonical name of the dynamic field to set

fieldValue - the value of the field

_getDynamicField

public DataValue _getDynamicField(java.lang.String fieldName)

Description copied from interface: StaticStructure

Get dynamic filed value. Works only on dynamic fields.

Specified by:

_getDynamicField in interface StaticStructure

Parameters:

fieldName - the canonical name of the dynamic field

Returns:

the DataValue of the dynamic field

_getDynamicFieldNames

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

Description copied from interface: StaticStructure

Get the names of the dynamic fields in the structure.

Specified by:

_getDynamicFieldNames in interface StaticStructure

Returns:

set of the canonical field names for the dynamic fields

_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()

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

_getCanonicalTypeName

public static java.lang.String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static StructureInfo _newInstance(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