com.aerospike.client

Class Value

java.lang.Object

com.aerospike.client.Value

Direct Known Subclasses:

Value.BlobValue, Value.BooleanValue, Value.ByteSegmentValue, Value.BytesValue, Value.ByteValue, Value.DoubleValue, Value.FloatValue, Value.GeoJSONValue, Value.HLLValue, Value.InfinityValue, Value.IntegerValue, Value.ListValue, Value.LongValue, Value.MapValue, Value.NullValue, Value.SortedMapValue, Value.StringValue, Value.ValueArray, Value.WildcardValue

public abstract class Value
extends Object

Polymorphic value classes used to efficiently serialize objects into the wire protocol.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Value.BlobValue Blob value.
static class	Value.BooleanValue Boolean value.
static class	Value.ByteSegmentValue Byte segment value.
static class	Value.BytesValue Byte array value.
static class	Value.ByteValue Byte value.
static class	Value.DoubleValue Double value.
static class	Value.FloatValue Float value.
static class	Value.GeoJSONValue GeoJSON value.
static class	Value.HLLValue HyperLogLog value.
static class	Value.InfinityValue Infinity value.
static class	Value.IntegerValue Integer value.
static class	Value.ListValue List value.
static class	Value.LongValue Long value.
static class	Value.MapValue Map value.
static class	Value.NullValue Empty value.
static class	Value.SortedMapValue Sorted map value.
static class	Value.StringValue String value.
static class	Value.ValueArray Value array.
static class	Value.WildcardValue Wildcard value.

Field Summary

Fields

Modifier and Type	Field and Description
static Value	INFINITY Infinity value to be used in CDT range comparisons only.
static Value	NULL Null value.
static Value	WILDCARD Wildcard value to be used in CDT range comparisons only.

Constructor Summary

Constructors

Constructor and Description
Value()

Method Summary

Modifier and Type	Method and Description
abstract int	estimateSize() Calculate number of bytes necessary to serialize the value in the wire protocol.
static Value	get(boolean value) Get boolean value instance.
static Value	get(byte value) Get byte value instance.
static Value	get(byte[] value) Get byte array or null value instance.
static Value	get(byte[] value, int type) Get byte array with type or null value instance.
static Value	get(byte[] value, int offset, int length) Get byte segment or null value instance.
static Value	get(ByteBuffer bb) Get byte segment or null value instance.
static Value	get(double value) Get double value instance.
static Value	get(float value) Get float value instance.
static Value	get(int value) Get integer value instance.
static Value	get(List<?> value) Get list or null value instance.
static Value	get(List<? extends Map.Entry<?,?>> value, MapOrder mapOrder) Get sorted map or null value instance.
static Value	get(long value) Get long value instance.
static Value	get(Map<?,?> value) Get map or null value instance.
static Value	get(Object value) Determine value given generic object.
static Value	get(String value) Get string or null value instance.
static Value	get(Value[] value) Get value array instance.
static Value	getAsBlob(Object value) Get blob or null value instance.
static Value	getAsGeoJSON(String value) Get GeoJSON or null value instance.
static Value	getAsHLL(byte[] value) Get HyperLogLog or null value instance.
static Value	getAsNull() Get null value instance.
static Value	getFromRecordObject(Object value) Get value from Record object.
abstract org.luaj.vm2.LuaValue	getLuaValue(com.aerospike.client.lua.LuaInstance instance) Return value as an Object.
abstract Object	getObject() Return original value as an Object.
abstract int	getType() Get wire protocol value type.
abstract void	pack(com.aerospike.client.util.Packer packer) Serialize the value using MessagePack.
int	toInteger() Return value as an integer.
long	toLong() Return value as a long.
void	validateKeyType() Validate if value type can be used as a key.
abstract int	write(byte[] buffer, int offset) Serialize the value in the wire protocol.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NULL

public static final Value NULL

Null value.

INFINITY

public static final Value INFINITY

Infinity value to be used in CDT range comparisons only.

WILDCARD

public static final Value WILDCARD

Wildcard value to be used in CDT range comparisons only.

Constructor Detail

Value

public Value()

Method Detail

get

public static Value get(String value)

Get string or null value instance.

get

public static Value get(byte[] value)

Get byte array or null value instance.

get

public static Value get(byte[] value,
                        int type)

Get byte array with type or null value instance.

get

public static Value get(byte[] value,
                        int offset,
                        int length)

Get byte segment or null value instance.

get

public static Value get(ByteBuffer bb)

Get byte segment or null value instance.

get

public static Value get(byte value)

Get byte value instance.

get

public static Value get(int value)

Get integer value instance.

get

public static Value get(long value)

Get long value instance.

get

public static Value get(double value)

Get double value instance.

get

public static Value get(float value)

Get float value instance.

get

public static Value get(boolean value)

Get boolean value instance.

get

public static Value get(List<?> value)

Get list or null value instance.

get

public static Value get(Map<?,?> value)

Get map or null value instance.

get

public static Value get(List<? extends Map.Entry<?,?>> value,
                        MapOrder mapOrder)

Get sorted map or null value instance.

get

public static Value get(Value[] value)

Get value array instance.

getAsBlob

public static Value getAsBlob(Object value)

Get blob or null value instance.

getAsGeoJSON

public static Value getAsGeoJSON(String value)

Get GeoJSON or null value instance.

getAsHLL

public static Value getAsHLL(byte[] value)

Get HyperLogLog or null value instance.

getAsNull

public static Value getAsNull()

Get null value instance.

get

public static Value get(Object value)

Determine value given generic object. This is the slowest of the Value get() methods. Useful when copying records from one cluster to another.

getFromRecordObject

public static Value getFromRecordObject(Object value)

Get value from Record object. Useful when copying records from one cluster to another.

estimateSize

public abstract int estimateSize()
                          throws AerospikeException

Calculate number of bytes necessary to serialize the value in the wire protocol.

Throws:

AerospikeException

write

public abstract int write(byte[] buffer,
                          int offset)
                   throws AerospikeException

Serialize the value in the wire protocol.

Throws:

AerospikeException

pack

public abstract void pack(com.aerospike.client.util.Packer packer)

Serialize the value using MessagePack.

validateKeyType

public void validateKeyType()
                     throws AerospikeException

Validate if value type can be used as a key.

Throws:

AerospikeException - if type can't be used as a key.

getType

public abstract int getType()

Get wire protocol value type.

getObject

public abstract Object getObject()

Return original value as an Object.

getLuaValue

public abstract org.luaj.vm2.LuaValue getLuaValue(com.aerospike.client.lua.LuaInstance instance)

Return value as an Object.

toInteger

public int toInteger()

Return value as an integer.

toLong

public long toLong()

Return value as a long.