com.vmware.vapi.data

Class DataDefinition

java.lang.Object

com.vmware.vapi.data.DataDefinition

Direct Known Subclasses:

AnyErrorDefinition, BlobDefinition, BooleanDefinition, DoubleDefinition, DynamicStructDefinition, IntegerDefinition, ListDefinition, OpaqueDefinition, OptionalDefinition, SecretDefinition, StringDefinition, StructDefinition, StructRefDefinition, VoidDefinition

public abstract class DataDefinition
extends Object

The DataDefinition class is an abstract base class for all types in the vAPI run-time type system.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataDefinition() Constructor for (typically implicit) use by derived class constructors.

Method Summary

Modifier and Type	Method and Description
abstract 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
abstract DataType	getType() Returns the DataType for this type.
String	toString()
List<Message>	validate(DataValue value) Validates that the specified DataValue is an instance of this data definition.
boolean	validInstanceOf(DataValue value) Validates that the specified DataValue is an instance of this data-definition.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataDefinition

protected DataDefinition()

Constructor for (typically implicit) use by derived class constructors.

Method Detail

getType

public abstract DataType getType()

Returns the DataType for this type.

Returns:

the DataType for this type

accept

public abstract void accept(DefinitionVisitor visitor)

Applies a visitor to this data-definition.

Parameters:

visitor - the visitor operating on this data-definition

validInstanceOf

public boolean validInstanceOf(DataValue value)

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

Parameters:

value - the data value to validate

Returns:

true if the value is an instance of this data definition, false otherwise

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.

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)

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

Parameters:

value - the value to check

toString

public String toString()

Overrides:

toString in class Object