Package com.yahoo.jrt

Class Value

java.lang.Object

com.yahoo.jrt.Value

Direct Known Subclasses:

DataArray, DataValue, DoubleArray, DoubleValue, FloatArray, FloatValue, Int16Array, Int16Value, Int32Array, Int32Value, Int64Array, Int64Value, Int8Array, Int8Value, StringArray, StringValue

public abstract class Value
extends java.lang.Object

A single value that may be either a parameter or a return value associated with a Request. Multiple values are bundled together with the Values class. The value type identifiers are defined by the RPC protocol. Each identifier matches the value of an ASCII character (listed after the Java class for the type).

Most Value subclasses that are constructed from a Java array will not copy the array. This enables the same data to back multiple Value objects, but it also means that the application should be careful not to change the backing data under the feet of a Value object.

Field Summary

Fields

Modifier and Type	Field	Description
static byte	DATA	type identifier for DataValue (x)
static byte	DATA_ARRAY	type identifier for DataArray (X)
static byte	DOUBLE	type identifier for DoubleValue (d)
static byte	DOUBLE_ARRAY	type identifier for DoubleArray (D)
static byte	FLOAT	type identifier for FloatValue (f)
static byte	FLOAT_ARRAY	type identifier for FloatArray (F)
static byte	INT16	type identifier for Int16Value (h)
static byte	INT16_ARRAY	type identifier for Int16Array (H)
static byte	INT32	type identifier for Int32Value (i)
static byte	INT32_ARRAY	type identifier for Int32Array (I)
static byte	INT64	type identifier for Int64Value (l)
static byte	INT64_ARRAY	type identifier for Int64Array (L)
static byte	INT8	type identifier for Int8Value (b)
static byte	INT8_ARRAY	type identifier for Int8Array (B)
static byte	STRING	type identifier for StringValue (s)
static byte	STRING_ARRAY	type identifier for StringArray (S)

Constructor Summary

Constructors

Constructor	Description
Value()

Method Summary

Modifier and Type	Method	Description
byte[]	asData()	Interpret this value as a DataValue and return the contents as an appropriate Java type
byte[][]	asDataArray()	Interpret this value as a DataArray and return the contents as an appropriate Java type
double	asDouble()	Interpret this value as a DoubleValue and return the contents as an appropriate Java type
double[]	asDoubleArray()	Interpret this value as a DoubleArray and return the contents as an appropriate Java type
float	asFloat()	Interpret this value as a FloatValue and return the contents as an appropriate Java type
float[]	asFloatArray()	Interpret this value as a FloatArray and return the contents as an appropriate Java type
short	asInt16()	Interpret this value as a Int16Value and return the contents as an appropriate Java type
short[]	asInt16Array()	Interpret this value as a Int16Array and return the contents as an appropriate Java type
int	asInt32()	Interpret this value as a Int32Value and return the contents as an appropriate Java type
int[]	asInt32Array()	Interpret this value as a Int32Array and return the contents as an appropriate Java type
long	asInt64()	Interpret this value as a Int64Value and return the contents as an appropriate Java type
long[]	asInt64Array()	Interpret this value as a Int64Array and return the contents as an appropriate Java type
byte	asInt8()	Interpret this value as a Int8Value and return the contents as an appropriate Java type
byte[]	asInt8Array()	Interpret this value as a Int8Array and return the contents as an appropriate Java type
java.lang.String	asString()	Interpret this value as a StringValue and return the contents as an appropriate Java type
java.lang.String[]	asStringArray()	Interpret this value as a StringArray and return the contents as an appropriate Java type
com.yahoo.text.Utf8Array	asUtf8Array()	Interpret this value as a StringValue and return the contents as an appropriate Java type
abstract int	count()	Obtain the number of entries stored in this value.
abstract java.lang.String	toString()	Force a proper toString
abstract byte	type()	Obtain the type identifier for this value

Methods inherited from class java.lang.Object

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

Field Detail

INT8

public static final byte INT8

type identifier for Int8Value (b)

See Also:

Constant Field Values

INT8_ARRAY

public static final byte INT8_ARRAY

type identifier for Int8Array (B)

See Also:

Constant Field Values

INT16

public static final byte INT16

type identifier for Int16Value (h)

See Also:

Constant Field Values

INT16_ARRAY

public static final byte INT16_ARRAY

type identifier for Int16Array (H)

See Also:

Constant Field Values

INT32

public static final byte INT32

type identifier for Int32Value (i)

See Also:

Constant Field Values

INT32_ARRAY

public static final byte INT32_ARRAY

type identifier for Int32Array (I)

See Also:

Constant Field Values

INT64

public static final byte INT64

type identifier for Int64Value (l)

See Also:

Constant Field Values

INT64_ARRAY

public static final byte INT64_ARRAY

type identifier for Int64Array (L)

See Also:

Constant Field Values

FLOAT

public static final byte FLOAT

type identifier for FloatValue (f)

See Also:

Constant Field Values

FLOAT_ARRAY

public static final byte FLOAT_ARRAY

type identifier for FloatArray (F)

See Also:

Constant Field Values

DOUBLE

public static final byte DOUBLE

type identifier for DoubleValue (d)

See Also:

Constant Field Values

DOUBLE_ARRAY

public static final byte DOUBLE_ARRAY

type identifier for DoubleArray (D)

See Also:

Constant Field Values

STRING

public static final byte STRING

type identifier for StringValue (s)

See Also:

Constant Field Values

STRING_ARRAY

public static final byte STRING_ARRAY

type identifier for StringArray (S)

See Also:

Constant Field Values

DATA

public static final byte DATA

type identifier for DataValue (x)

See Also:

Constant Field Values

DATA_ARRAY

public static final byte DATA_ARRAY

type identifier for DataArray (X)

See Also:

Constant Field Values

Constructor Detail

Value

public Value()

Method Detail

type

public abstract byte type()

Obtain the type identifier for this value

Returns:

type identifier

count

public abstract int count()

Obtain the number of entries stored in this value. This is 1 for basic data types and the size of the array for array types.

Returns:

the number of entries stored in this value

asInt8

public byte asInt8()

Interpret this value as a Int8Value and return the contents as an appropriate Java type

Returns:

the value contained in this object as a Java type

Throws:

java.lang.ClassCastException - if this is not a Int8Value

asInt8Array

public byte[] asInt8Array()

Interpret this value as a Int8Array and return the contents as an appropriate Java type

Returns:

the value contained in this object as a Java type

Throws:

java.lang.ClassCastException - if this is not a Int8Array

asInt16

public short asInt16()

Interpret this value as a Int16Value and return the contents as an appropriate Java type

Returns:

the value contained in this object as a Java type

Throws:

java.lang.ClassCastException - if this is not a Int16Value

asInt16Array

public short[] asInt16Array()

Interpret this value as a Int16Array and return the contents as an appropriate Java type

Returns:

the value contained in this object as a Java type

Throws:

java.lang.ClassCastException - if this is not a Int16Array

asInt32

public int asInt32()

Interpret this value as a Int32Value and return the contents as an appropriate Java type

Returns:

the value contained in this object as a Java type

Throws:

java.lang.ClassCastException - if this is not a Int32Value

asInt32Array

public int[] asInt32Array()

Interpret this value as a Int32Array and return the contents as an appropriate Java type

Returns:

the value contained in this object as a Java type

Throws:

java.lang.ClassCastException - if this is not a Int32Array

asInt64

public long asInt64()

Interpret this value as a Int64Value and return the contents as an appropriate Java type

Returns:

the value contained in this object as a Java type

Throws:

java.lang.ClassCastException - if this is not a Int64Value

asInt64Array

public long[] asInt64Array()

Interpret this value as a Int64Array and return the contents as an appropriate Java type

Returns:

the value contained in this object as a Java type

Throws:

java.lang.ClassCastException - if this is not a Int64Array

asFloat

public float asFloat()

Interpret this value as a FloatValue and return the contents as an appropriate Java type

Returns:

the value contained in this object as a Java type

Throws:

java.lang.ClassCastException - if this is not a FloatValue

asFloatArray

public float[] asFloatArray()

Interpret this value as a FloatArray and return the contents as an appropriate Java type

Returns:

the value contained in this object as a Java type

Throws:

java.lang.ClassCastException - if this is not a FloatArray

asDouble

public double asDouble()

Interpret this value as a DoubleValue and return the contents as an appropriate Java type

Returns:

the value contained in this object as a Java type

Throws:

java.lang.ClassCastException - if this is not a DoubleValue

asDoubleArray

public double[] asDoubleArray()

Interpret this value as a DoubleArray and return the contents as an appropriate Java type

Returns:

the value contained in this object as a Java type

Throws:

java.lang.ClassCastException - if this is not a DoubleArray

asString

public java.lang.String asString()

Interpret this value as a StringValue and return the contents as an appropriate Java type

Returns:

the value contained in this object as a Java type

Throws:

java.lang.ClassCastException - if this is not a StringValue

asUtf8Array

public com.yahoo.text.Utf8Array asUtf8Array()

Interpret this value as a StringValue and return the contents as an appropriate Java type

Returns:

the value contained in this object as a Java type

Throws:

java.lang.ClassCastException - if this is not a Utf8Array

asStringArray

public java.lang.String[] asStringArray()

Interpret this value as a StringArray and return the contents as an appropriate Java type

Returns:

the value contained in this object as a Java type

Throws:

java.lang.ClassCastException - if this is not a StringArray

asData

public byte[] asData()

Interpret this value as a DataValue and return the contents as an appropriate Java type

Returns:

the value contained in this object as a Java type

Throws:

java.lang.ClassCastException - if this is not a DataValue

asDataArray

public byte[][] asDataArray()

Interpret this value as a DataArray and return the contents as an appropriate Java type

Returns:

the value contained in this object as a Java type

Throws:

java.lang.ClassCastException - if this is not a DataArray

toString

public abstract java.lang.String toString()

Force a proper toString

Overrides:

toString in class java.lang.Object