com.vmware.vapi.data

Class StructValue

java.lang.Object

com.vmware.vapi.data.StructValue

All Implemented Interfaces:

DataValue, Serializable

Direct Known Subclasses:

ErrorValue

public class StructValue
extends Object
implements DataValue

Thread-safety: Instances of this class are not thread-safe.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StructValue(String name)

Method Summary

Modifier and Type	Method and Description
void	accept(ValueVisitor visitor)
StructValue	copy()
boolean	equals(Object other)
boolean	getBoolean(String field)
double	getDouble(String field)
DataValue	getField(String field) Gets the value for a field with given name.
Set<String>	getFieldNames()
Map<String,DataValue>	getFields()
long	getInteger(String field)
ListValue	getList(String field) Gets the list value for a field with given name.
String	getName()
OptionalValue	getOptional(String field)
char[]	getSecret(String field)
String	getString(String fieldName)
StructValue	getStruct(String field)
DataType	getType()
boolean	hasField(String field)
int	hashCode()
void	setField(String field, boolean value)
void	setField(String field, char[] value)
void	setField(String field, DataValue value)
void	setField(String field, double value)
void	setField(String field, long value)
void	setField(String field, String value)
void	setOptionalField(String field, boolean value)
void	setOptionalField(String field, Boolean value)
void	setOptionalField(String field, double value)
void	setOptionalField(String field, Double value)
void	setOptionalField(String field, long value)
void	setOptionalField(String field, Long value)
void	setOptionalField(String field, String value)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StructValue

public StructValue(String name)

Parameters:

name - the canonical name of the structure type. cannot be null

Method Detail

getType

public DataType getType()

Specified by:

getType in interface DataValue

getName

public String getName()

getFieldNames

public Set<String> getFieldNames()

hasField

public boolean hasField(String field)

getField

public DataValue getField(String field)

Gets the value for a field with given name.

Parameters:

field - name of the field

Returns:

DataValue representing the value of the field

Throws:

CoreException - if field with the specified name is not present

getFields

public Map<String,DataValue> getFields()

getInteger

public long getInteger(String field)

getDouble

public double getDouble(String field)

getBoolean

public boolean getBoolean(String field)

getString

public String getString(String fieldName)

Parameters:

fieldName - name of the field to fetch

Returns:

String representing the value of the field

Throws:

CoreException - if field with the specified name is not present or its type is not StringValue

getSecret

public char[] getSecret(String field)

getOptional

public OptionalValue getOptional(String field)

getList

public ListValue getList(String field)

Gets the list value for a field with given name.

Parameters:

field - name of the field

Returns:

ListValue representing the value of the field

Throws:

CoreException - if field with the specified name is not present or its type is not list

getStruct

public StructValue getStruct(String field)

setField

public void setField(String field,
                     DataValue value)

setField

public void setField(String field,
                     long value)

setField

public void setField(String field,
                     boolean value)

setField

public void setField(String field,
                     double value)

setField

public void setField(String field,
                     String value)

setField

public void setField(String field,
                     char[] value)

setOptionalField

public void setOptionalField(String field,
                             Long value)

setOptionalField

public void setOptionalField(String field,
                             Boolean value)

setOptionalField

public void setOptionalField(String field,
                             Double value)

setOptionalField

public void setOptionalField(String field,
                             String value)

setOptionalField

public void setOptionalField(String field,
                             long value)

setOptionalField

public void setOptionalField(String field,
                             boolean value)

setOptionalField

public void setOptionalField(String field,
                             double value)

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 Object

accept

public void accept(ValueVisitor visitor)

Specified by:

accept in interface DataValue

copy

public StructValue copy()

Specified by:

copy in interface DataValue

Returns:

a deep copy of this data value instance. this operation is NOT thread-safe and might throw ConcurrentModificationException if the DataValue is modified at the time of coping.