com.vmware.vapi.data

Class StructDefinition

java.lang.Object

com.vmware.vapi.data.DataDefinition

com.vmware.vapi.data.StructDefinition

Direct Known Subclasses:

ErrorDefinition

public class StructDefinition
extends DataDefinition

Constructor Summary

Constructors

Constructor and Description
StructDefinition(String name, Map<String,DataDefinition> fields) Constructor.

Method Summary

Modifier and Type	Method and Description
void	accept(DefinitionVisitor visitor) Applies a visitor to this data-definition.
void	completeValue(DataValue value) Check the value to see if the data-definition can fill in any missing data before validation
boolean	equals(Object other)
DataDefinition	getField(String field)
Set<String>	getFieldNames()
String	getName()
DataType	getType() Returns the DataType for this type.
boolean	hasField(String field)
int	hashCode()
StructValue	newInstance()
String	toString()
List<Message>	validate(DataValue value) Validates that the specified DataValue is an instance of this data definition.

Methods inherited from class com.vmware.vapi.data.DataDefinition

validInstanceOf

Methods inherited from class java.lang.Object

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

Constructor Detail

StructDefinition

public StructDefinition(String name,
                        Map<String,DataDefinition> fields)

Constructor.

Parameters:

name - name for the structure; must not be null

fields - field names and definitions for the structure; must not be null

Throws:

IllegalArgumentException - if some of the arguments or the values in fields is null

Method Detail

getType

public DataType getType()

Description copied from class: DataDefinition

Returns the DataType for this type.

Specified by:

getType in class DataDefinition

Returns:

the DataType for this type

getName

public String getName()

getFieldNames

public Set<String> getFieldNames()

getField

public DataDefinition getField(String field)

hasField

public boolean hasField(String field)

newInstance

public StructValue newInstance()

validate

public List<Message> validate(DataValue value)

Validates that the specified DataValue is an instance of this data definition.

Validates that supplied value is not null and it's type matches the type of this definition.

In addition, validates that value's name matches this definition name and value's fields are valid for this definition fields.

Overrides:

validate in class DataDefinition

Parameters:

value - the DataValue to validate

Returns:

a list of messages describing validation problems; empty list indicates that validation was successful

completeValue

public void completeValue(DataValue value)

Description copied from class: DataDefinition

Check the value to see if the data-definition can fill in any missing data before validation

Overrides:

completeValue in class DataDefinition

Parameters:

value - the value to check

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Description copied from class: DataDefinition

Overrides:

toString in class DataDefinition

accept

public void accept(DefinitionVisitor visitor)

Description copied from class: DataDefinition

Applies a visitor to this data-definition.

Specified by:

accept in class DataDefinition

Parameters:

visitor - the visitor operating on this data-definition