com.vmware.vapi.data

Class StructRefDefinition

java.lang.Object

com.vmware.vapi.data.DataDefinition

com.vmware.vapi.data.StructRefDefinition

public class StructRefDefinition
extends DataDefinition

Reference to a StructDefinition. If the reference is resolved, it is bound to a specific StructDefinition target. If the reference is unresolved, its target is null.

Thread-safety: Conditionally thread-safe. Resolving the reference via setTarget(StructDefinition) is not thread-safe.

Constructor Summary

Constructors

Constructor and Description
StructRefDefinition(String name) Creates an unresolved reference.
StructRefDefinition(StructDefinition structDefinition) Creates a resolved reference.

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 obj)
String	getName() Returns the structure name of this reference.
StructDefinition	getTarget() Returns the target structure definition of this reference.
DataType	getType() Returns the DataType for this type.
int	hashCode()
void	setTarget(StructDefinition structDefinition) Resolves the reference.
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

StructRefDefinition

public StructRefDefinition(String name)

Creates an unresolved reference.

Parameters:

name - structure name; must not be null

StructRefDefinition

public StructRefDefinition(StructDefinition structDefinition)

Creates a resolved reference.

Parameters:

structDefinition - structure definition; must not be null

Method Detail

getName

public String getName()

Returns the structure name of this reference.

Returns:

structure name; never null

getTarget

public StructDefinition getTarget()

Returns the target structure definition of this reference.

Returns:

the target of this reference; will be null for an unresolved reference

setTarget

public void setTarget(StructDefinition structDefinition)

Resolves the reference. An unresolved reference can be resolved exactly once. A resolved reference cannot be re-resolved.

Parameters:

structDefinition - structure definition; must not be null

Throws:

CoreException - if the reference is already resolved (already has a target) or if the name of the reference does not match the name of the definition

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

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

validate

public List<Message> validate(DataValue value)

Description copied from class: DataDefinition

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.

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

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