com.vmware.vapi.metadata.metamodel

Class ServiceInfo

java.lang.Object

com.vmware.vapi.metadata.metamodel.ServiceInfo

All Implemented Interfaces:

StaticStructure, Structure, Serializable

public final class ServiceInfo
extends Object
implements Serializable, StaticStructure

The ServiceInfo class contains the metamodel information of all the operation elements, structure elements and enumeration elements containted in a service element.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceInfo.Builder Builder class for ServiceInfo.

Constructor Summary

Constructors

Constructor and Description
ServiceInfo() Default constructor.

Method Summary

Methods

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.
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 ServiceInfo	_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)
Map<String,ConstantInfo>	getConstants() Metamodel information of all the constant elements contained in the service element.
String	getDocumentation() English language documentation for the service element.
Map<String,EnumerationInfo>	getEnumerations() Metamodel information of all the enumeration elements contained in the service element.
Map<String,ElementMap>	getMetadata() Generic metadata elements for the service element.
String	getName() Dot separated name of the service element.
Map<String,OperationInfo>	getOperations() Metamodel information of all the operation elements contained in the service element.
Map<String,StructureInfo>	getStructures() Metamodel information of all the structure elements contained in the service element.
int	hashCode()
void	setConstants(Map<String,ConstantInfo> constants) Metamodel information of all the constant elements contained in the service element.
void	setDocumentation(String documentation) English language documentation for the service element.
void	setEnumerations(Map<String,EnumerationInfo> enumerations) Metamodel information of all the enumeration elements contained in the service element.
void	setMetadata(Map<String,ElementMap> metadata) Generic metadata elements for the service element.
void	setName(String name) Dot separated name of the service element.
void	setOperations(Map<String,OperationInfo> operations) Metamodel information of all the operation elements contained in the service element.
void	setStructures(Map<String,StructureInfo> structures) Metamodel information of all the structure elements contained in the service element.
String	toString() Returns a string representation of this structure.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ServiceInfo

public ServiceInfo()

Default constructor.

Method Detail

getName

public String getName()

Dot separated name of the service 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(String name)

Dot separated name of the service 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.

getOperations

public Map<String,OperationInfo> getOperations()

Metamodel information of all the operation elements contained in the service element. The key in the Map is the identifier of the operation element and the value in the Map is the metamodel information for the operation 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.operation. 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.operation.

setOperations

public void setOperations(Map<String,OperationInfo> operations)

Metamodel information of all the operation elements contained in the service element. The key in the Map is the identifier of the operation element and the value in the Map is the metamodel information for the operation element.

Parameters:

operations - 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.operation. 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.operation.

getStructures

public Map<String,StructureInfo> getStructures()

Metamodel information of all the structure elements contained in the service element. The key in the Map is the identifier of the structure element and the value in the Map is the metamodel information for the structure 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.structure. 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.structure.

setStructures

public void setStructures(Map<String,StructureInfo> structures)

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

Parameters:

structures - 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.structure. 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.structure.

getEnumerations

public Map<String,EnumerationInfo> getEnumerations()

Metamodel information of all the enumeration elements contained in the service element. The key in the Map is the identifier of the enumeration element and the value in the Map is the metamodel information for 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(Map<String,EnumerationInfo> enumerations)

Metamodel information of all the enumeration elements contained in the service element. The key in the Map is the identifier of the enumeration element and the value in the Map is the metamodel information for 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 Map<String,ConstantInfo> getConstants()

Metamodel information of all the constant elements contained in the service 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 contant element.

Returns:

The current value of the property.

setConstants

public void setConstants(Map<String,ConstantInfo> constants)

Metamodel information of all the constant elements contained in the service 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 contant element.

Parameters:

constants - New value for the property.

getMetadata

public Map<String,ElementMap> getMetadata()

Generic metadata elements for the service 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(Map<String,ElementMap> metadata)

Generic metadata elements for the service 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 String getDocumentation()

English language documentation for the service element. It can contain HTML markup and Javadoc tags. The first sentence of the service documentation is a complete sentence that identifies the service by name and summarizes the purpose of the service. The remaining part of the documentation provides a summary of how to use the operations defined in the service.

Returns:

The current value of the property.

setDocumentation

public void setDocumentation(String documentation)

English language documentation for the service element. It can contain HTML markup and Javadoc tags. The first sentence of the service documentation is a complete sentence that identifies the service by name and summarizes the purpose of the service. The remaining part of the documentation provides a summary of how to use the operations defined in the service.

Parameters:

documentation - New value for the property.

_getType

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

Description copied from interface: StaticStructure

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

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

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public 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 Object

Returns:

a string representation of this static structure instance

_hasTypeNameOf

public boolean _hasTypeNameOf(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(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(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(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 Set<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 API, subject to change in future versions.

Returns:

StructType instance representing the static bindings type for this Structure.

_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

_getCanonicalTypeName

public static String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static ServiceInfo _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.

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