com.vmware.vapi.bindings

Interface StaticStructure

All Superinterfaces:

Structure

All Known Implementing Classes:

AlreadyExists, AlreadyInDesiredState, ArgumentLocations, AuthenticationScheme, Canceled, ConcurrentChange, DynamicID, Error, FeatureInUse, FileLocations, InternalServerError, InvalidArgument, InvalidElementConfiguration, InvalidElementType, InvalidRequest, InvocationRequest, InvocationResult, LocalizableMessage, LocalizationParam, NestedLocalizableMessage, NotAllowedInCurrentState, NotFound, OperationNotFound, OperationTypes.DataDefinition, OperationTypes.Info, ProviderTypes.Info, ResourceBusy, ResourceInaccessible, ResourceInUse, SecurityPrincipal, ServiceTypes.Info, ServiceUnavailable, TimedOut, TransientIndication, UnableToAllocateResource, Unauthenticated, Unauthorized, UnexpectedInput, Unsupported, UnverifiedPeer

public interface StaticStructure
extends Structure

Interface implemented by all generated static bindings structures.

A static structure provides getters/setters for access to the fields known at generation time. It may contain additional dynamic fields which can be accessed using method from this interface.

Method Summary

Modifier and Type	Method and Description
DataValue	_getDynamicField(String fieldName) Get a dynamic field value, doesn't allow access to static fields (which have getters/setters).
Set<String>	_getDynamicFieldNames() Get the names of the dynamic fields in the structure.
StructType	_getType() WARNING: Internal method, subject to change in future versions.
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.
String	toString() Returns a string representation of this structure.

Methods inherited from interface com.vmware.vapi.bindings.Structure

_convertTo, _getCanonicalName, _getDataValue, _hasTypeNameOf

Method Detail

_getType

StructType _getType()

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

Returns:

the static bindings StructType

_validate

void _validate()

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

Throws:

CoreException - if some constraint is not satisfied

toString

String toString()

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.

Overrides:

toString in class Object

Returns:

a string representation of this static structure instance

_setDynamicField

void _setDynamicField(String fieldName,
                      DataValue fieldValue)

Sets a dynamic field value. The dynamic filed is extra filed that is not part of the static structure definition, i.e. not represented with getter/setter.

Parameters:

fieldName - canonical name of the dynamic field to set

fieldValue - the value of the field

Throws:

BindingsException - in case there is a field in the static structure definition with that name

_getDynamicField

DataValue _getDynamicField(String fieldName)

Get a dynamic field value, doesn't allow access to static fields (which have getters/setters).

Parameters:

fieldName - the canonical name of the dynamic field

Returns:

the DataValue of the dynamic field

Throws:

BindingsException - if there is no dynamic field with that name

_getDynamicFieldNames

Set<String> _getDynamicFieldNames()

Get the names of the dynamic fields in the structure.

Returns:

set of the canonical field names for the dynamic fields