com.vmware.vapi.bindings.type

Class StructType

java.lang.Object

com.vmware.vapi.bindings.type.StructType

All Implemented Interfaces:

Type

Direct Known Subclasses:

ErrorType

public class StructType
extends Object
implements Type

Description of a structure type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StructType.FieldNameDetails Field name details structure.

Constructor Summary

Constructors

Constructor and Description
StructType(String name, Map<String,Type> fields, Class<?> bindingClass, List<com.vmware.vapi.internal.data.ConstraintValidator> validators, boolean isModel, List<String> modelKeyFields, Map<String,StructType.FieldNameDetails> fieldNameDetails) Constructor overload for compatibility with bindings generated with older version of vAPI generator.
StructType(String name, Map<String,Type> fields, Class<?> bindingClass, List<com.vmware.vapi.internal.data.ConstraintValidator> validators, boolean isModel, List<String> modelKeyFields, Map<String,StructType.FieldNameDetails> fieldNameDetails, String discriminator, String discriminatedBy) Constructor.

Method Summary

Modifier and Type	Method and Description
void	accept(TypeVisitor visitor) Accepts a type visitor and dispatches to the appropriate visitor method, depending on class of the individual type.
Class<?>	getBindingClass() Returns a class which represents the Java language binding of this structure.
String	getDiscriminatedBy() Returns the value which identifies this structure when used in a discriminator field.
String	getDiscriminator() Returns the name of the field in this structure which serves as type discriminator.
Type	getField(String field) Returns the type of the specified structure field.
Type	getFieldByJavaName(String javaName) Returns the type of the specified structure field by its mixed case (java) name.
StructType.FieldNameDetails	getFieldNameDetails(String canonicalName) Get field name details by the field canonical name.
Set<String>	getFieldNames() Returns the names of the structure fields in no particular order.
Iterable<String>	getFieldWithSetterNames() Returns the names of the structure fields, which do have setters, in no particular order.
Method	getGetterMethodForField(String fieldName) Get the Method representing the getter for the specified field in the the binding class for the structure.
List<String>	getModelKeyFields() Get array specifying model key fields names for the model.
String	getName() Returns the name of the structure.
Method	getSetterMethodForField(String fieldName) Get the Method representing the setter for the specified field in the the binding class for the structure.
boolean	isModel() Check if the structure is marked as model.
void	validate(StructValue structValue) Enforces all static (defined in the IDL) or dynamic constrains defined over this structure.
void	validate(StructValue structValue, MethodIdentifier methodId) Enforces all static (defined in the IDL) or dynamic constrains defined over this structure.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StructType

public StructType(String name,
                  Map<String,Type> fields,
                  Class<?> bindingClass,
                  List<com.vmware.vapi.internal.data.ConstraintValidator> validators,
                  boolean isModel,
                  List<String> modelKeyFields,
                  Map<String,StructType.FieldNameDetails> fieldNameDetails)

Constructor overload for compatibility with bindings generated with older version of vAPI generator.

StructType

public StructType(String name,
                  Map<String,Type> fields,
                  Class<?> bindingClass,
                  List<com.vmware.vapi.internal.data.ConstraintValidator> validators,
                  boolean isModel,
                  List<String> modelKeyFields,
                  Map<String,StructType.FieldNameDetails> fieldNameDetails,
                  String discriminator,
                  String discriminatedBy)

Constructor.

Parameters:

name - name of the structure

fields - types of the structure fields

bindingClass - Java language binding of the structure type

validators - validators for constraints defined for in this StructType; may be null

isModel - true iff the structure is marked as model

modelKeyFields - list of the model primary key fields

fieldNameDetails - map of field name details, the key is the field canonical name, the value is instance of the StructType.FieldNameDetails

discriminator - name of a field which serves as discriminator; may be null when no discriminator is present; if not null field with such name must be present in fields map;

discriminatedBy - value identifying this structure when used in a discriminator field; may be null if no such value is present; if not null, the discriminator must not be null as well

Throws:

IllegalArgumentException - if some pre-condition for this method (described per above) is violated

Method Detail

getName

public String getName()

Returns the name of the structure.

Returns:

name of the structure

getDiscriminator

public String getDiscriminator()

Returns the name of the field in this structure which serves as type discriminator.

Returns:

the name of the field, or null if such is not present

getDiscriminatedBy

public String getDiscriminatedBy()

Returns the value which identifies this structure when used in a discriminator field.

Returns:

the value identifying this structure, or null if such is not available

See Also:

getDiscriminator()

getFieldNames

public Set<String> getFieldNames()

Returns the names of the structure fields in no particular order.

Returns:

names of structure fields

getFieldWithSetterNames

public Iterable<String> getFieldWithSetterNames()

Returns the names of the structure fields, which do have setters, in no particular order.

Returns:

names of structure fields

getField

public Type getField(String field)

Returns the type of the specified structure field.

Parameters:

field - canonical name of a structure field; must not be null

Returns:

type of the structure field

getFieldByJavaName

public Type getFieldByJavaName(String javaName)

Returns the type of the specified structure field by its mixed case (java) name.

Parameters:

javaName - mixed case name of a structure field; must not be null

Returns:

type of the structure field or null if there is no field with the specified name

getModelKeyFields

public List<String> getModelKeyFields()

Get array specifying model key fields names for the model.

Returns:

array of field names or null if the structure is not model

getGetterMethodForField

public Method getGetterMethodForField(String fieldName)

Get the Method representing the getter for the specified field in the the binding class for the structure.

Parameters:

fieldName - name of the field; must not be null

Returns:

the getter method

Throws:

ConverterException - if no method is available for the specified field name

getSetterMethodForField

public Method getSetterMethodForField(String fieldName)

Get the Method representing the setter for the specified field in the the binding class for the structure.

Parameters:

fieldName - name of the field; must not be null

Returns:

the setter method

Throws:

ConverterException - if no method is available for the specified field name

validate

public void validate(StructValue structValue)

Enforces all static (defined in the IDL) or dynamic constrains defined over this structure. This method will not recursively validate the structures inside the structValue.

Parameters:

structValue - struct value to validate; cannot be null

Throws:

ConstraintValidationException - if the constraint is not satisfied

validate

public void validate(StructValue structValue,
                     MethodIdentifier methodId)

Enforces all static (defined in the IDL) or dynamic constrains defined over this structure.

Parameters:

structValue - struct value to validate; must not be null

methodId - the method invocation in which context the dataValue was passed (as a parameter). must not be null

Throws:

ConstraintValidationException - if the constraint is not satisfied

getBindingClass

public Class<?> getBindingClass()

Returns a class which represents the Java language binding of this structure.

Returns:

language binding class

isModel

public boolean isModel()

Check if the structure is marked as model.

Returns:

if the structure is marked as model

accept

public void accept(TypeVisitor visitor)

Description copied from interface: Type

Accepts a type visitor and dispatches to the appropriate visitor method, depending on class of the individual type.

Specified by:

accept in interface Type

Parameters:

visitor - type visitor

getFieldNameDetails

public StructType.FieldNameDetails getFieldNameDetails(String canonicalName)

Get field name details by the field canonical name.

Parameters:

canonicalName - the field canonical name; must not be null.

Returns:

the field name details or null if no details are available