com.vmware.vapi.data

Class OptionalDefinition

java.lang.Object

com.vmware.vapi.data.DataDefinition

com.vmware.vapi.data.OptionalDefinition

public class OptionalDefinition
extends DataDefinition

An OptionalDefinition instance defines an optional type with a specific element type.

Constructor Summary

Constructors

Constructor and Description
OptionalDefinition(DataDefinition elementType) Constructor to create a optional-definition with the specified element type.

Method Summary

Methods

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	getElementType() Return the data-definition for the element type of this optional-definition.
DataType	getType() Returns the DataType for this type.
int	hashCode()
OptionalValue	newInstance() Create and return a new OptionalValue using this optional definition.
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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OptionalDefinition

public OptionalDefinition(DataDefinition elementType)

Constructor to create a optional-definition with the specified element type.

Parameters:

elementType - data-definition for the element of the optional-definition

Throws:

IllegalArgumentException - if elementType is null

Method Detail

getType

public DataType getType()

Returns the DataType for this type.

Specified by:

getType in class DataDefinition

Returns:

the DataType for this type

newInstance

public OptionalValue newInstance()

Create and return a new OptionalValue using this optional definition.

Returns:

an empty optional value.

getElementType

public DataDefinition getElementType()

Return the data-definition for the element type of this optional-definition.

Returns:

the data-definition for the element type of this optional-definition

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 the type of the optional value content if it is set/present.

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

Overrides:

toString in class DataDefinition

accept

public void accept(DefinitionVisitor visitor)

Applies a visitor to this data-definition.

Specified by:

accept in class DataDefinition

Parameters:

visitor - the visitor operating on this data-definition