com.vmware.vapi.data

Class OptionalValue

java.lang.Object

com.vmware.vapi.data.OptionalValue

All Implemented Interfaces:

DataValue, java.io.Serializable

public final class OptionalValue
extends java.lang.Object
implements DataValue

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static OptionalValue	UNSET OptionalValue instance which is not set, i.e.

Constructor Summary

Constructors

Constructor and Description
OptionalValue()
OptionalValue(boolean value)
OptionalValue(java.lang.Boolean value)
OptionalValue(char[] value)
OptionalValue(DataValue value)
OptionalValue(double value)
OptionalValue(java.lang.Double value)
OptionalValue(long value)
OptionalValue(java.lang.Long value)
OptionalValue(java.lang.String value)

Method Summary

Modifier and Type	Method and Description
void	accept(ValueVisitor visitor)
OptionalValue	copy()
boolean	equals(java.lang.Object o)
boolean	getBoolean()
boolean	getBooleanOrElse(boolean orElse)
java.lang.Boolean	getBooleanOrNull()
double	getDouble()
double	getDoubleOrElse(double orElse)
java.lang.Double	getDoubleOrNull()
long	getInteger()
long	getIntegerOrElse(long orElse)
java.lang.Long	getIntegerOrNull()
ListValue	getList()
OptionalValue	getOptional()
char[]	getSecret()
char[]	getSecretOrElse(char[] orElse)
char[]	getSecretOrNull()
java.lang.String	getString()
java.lang.String	getStringOrElse(java.lang.String orElse)
java.lang.String	getStringOrNull()
StructValue	getStruct()
DataType	getType()
DataValue	getValue()
int	hashCode()
boolean	isSet()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

UNSET

public static final OptionalValue UNSET

OptionalValue instance which is not set, i.e. getValue() is guaranteed to return null.

This immutable instance can be safely used in any context to avoid excessive class instantiation.

Constructor Detail

OptionalValue

public OptionalValue()

OptionalValue

public OptionalValue(DataValue value)

OptionalValue

public OptionalValue(boolean value)

OptionalValue

public OptionalValue(long value)

OptionalValue

public OptionalValue(double value)

OptionalValue

public OptionalValue(java.lang.String value)

OptionalValue

public OptionalValue(char[] value)

OptionalValue

public OptionalValue(java.lang.Boolean value)

OptionalValue

public OptionalValue(java.lang.Long value)

OptionalValue

public OptionalValue(java.lang.Double value)

Method Detail

getType

public DataType getType()

Specified by:

getType in interface DataValue

isSet

public boolean isSet()

getValue

public DataValue getValue()

Returns:

the content of this OptionalValue if it holds one or null if it is not set.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getInteger

public long getInteger()

getIntegerOrElse

public long getIntegerOrElse(long orElse)

getIntegerOrNull

public java.lang.Long getIntegerOrNull()

getDouble

public double getDouble()

getDoubleOrElse

public double getDoubleOrElse(double orElse)

getDoubleOrNull

public java.lang.Double getDoubleOrNull()

getBoolean

public boolean getBoolean()

getBooleanOrElse

public boolean getBooleanOrElse(boolean orElse)

getBooleanOrNull

public java.lang.Boolean getBooleanOrNull()

getString

public java.lang.String getString()

getStringOrElse

public java.lang.String getStringOrElse(java.lang.String orElse)

getStringOrNull

public java.lang.String getStringOrNull()

getSecret

public char[] getSecret()

getSecretOrElse

public char[] getSecretOrElse(char[] orElse)

getSecretOrNull

public char[] getSecretOrNull()

getOptional

public OptionalValue getOptional()

getList

public ListValue getList()

getStruct

public StructValue getStruct()

accept

public void accept(ValueVisitor visitor)

Specified by:

accept in interface DataValue

copy

public OptionalValue 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.