com.aerospike.client

Class Bin

java.lang.Object

com.aerospike.client.Bin

public final class Bin
extends Object

Column name/value pair.

Field Summary

Fields

Modifier and Type	Field and Description
String	name Bin name.
Value	value Bin value.

Constructor Summary

Constructors

Constructor and Description
Bin(String name, boolean value) Constructor, specifying bin name and boolean value.
Bin(String name, byte value) Constructor, specifying bin name and byte value.
Bin(String name, byte[] value) Constructor, specifying bin name and byte array value.
Bin(String name, byte[] value, int offset, int length) Constructor, specifying bin name and byte array segment value.
Bin(String name, double value) Constructor, specifying bin name and double value.
Bin(String name, float value) Constructor, specifying bin name and float value.
Bin(String name, int value) Constructor, specifying bin name and integer value.
Bin(String name, List<?> value) Create bin with a list value.
Bin(String name, long value) Constructor, specifying bin name and long value.
Bin(String name, Map<?,?> value) Create bin with a map value.
Bin(String name, Object value) Constructor, specifying bin name and object value.
Bin(String name, String value) Constructor, specifying bin name and string value.
Bin(String name, Value value) Constructor, specifying bin name and value.

Method Summary

Modifier and Type	Method and Description
static Bin	asBlob(String name, Object value) Create bin with a blob value.
static Bin	asGeoJSON(String name, String value) Create bin with a GeoJSON value.
static Bin	asNull(String name) Create bin with a null value.
boolean	equals(Object obj) Compare Bin for equality.
int	hashCode() Return hash code for Bin.
String	toString() Return string representation of bin.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

name

public final String name

Bin name. Current limit is 14 characters.

value

public final Value value

Bin value.

Constructor Detail

Bin

public Bin(String name,
           String value)

Constructor, specifying bin name and string value. For servers configured as "single-bin", enter a null or empty name.

Parameters:

name - bin name, current limit is 14 characters

value - bin value

Bin

public Bin(String name,
           byte[] value)

Constructor, specifying bin name and byte array value. For servers configured as "single-bin", enter a null or empty name.

Parameters:

name - bin name, current limit is 14 characters

value - bin value

Bin

public Bin(String name,
           byte[] value,
           int offset,
           int length)

Constructor, specifying bin name and byte array segment value. For servers configured as "single-bin", enter a null or empty name.

Parameters:

name - bin name, current limit is 14 characters

value - byte array value

offset - byte array segment offset

length - byte array segment length

Bin

public Bin(String name,
           byte value)

Constructor, specifying bin name and byte value. For servers configured as "single-bin", enter a null or empty name.

Parameters:

name - bin name, current limit is 14 characters

value - bin value

Bin

public Bin(String name,
           int value)

Constructor, specifying bin name and integer value. The server will convert all integers to longs. For servers configured as "single-bin", enter a null or empty name.

Parameters:

name - bin name, current limit is 14 characters

value - bin value

Bin

public Bin(String name,
           long value)

Constructor, specifying bin name and long value. For servers configured as "single-bin", enter a null or empty name.

Parameters:

name - bin name, current limit is 14 characters

value - bin value

Bin

public Bin(String name,
           double value)

Constructor, specifying bin name and double value. Aerospike server versions >= 3.6.0 natively support floating point values. If your cluster supports floating point values, then this is always the correct constructor for double. Remember to also set Value.UseDoubleType to true;

If your cluster does not support floating point, the value is converted to long bits. On reads, it's important to call Record.getDouble(String name) to indicate that the long returned by the server should be converted back to a double. If the same bin name holds different types for different records, then this constructor should not be used because there is no way to know when reading if the long should be converted to a double. Instead, use Bin(String name, Object value) which converts the double to a java serialized blob.

 double value = 22.7;
 Bin bin = new Bin("mybin", (Object) value);
 

This is slower and not portable to other languages, but the double type is preserved, so a Double will be returned without knowing if a conversion should be made.

For servers configured as "single-bin", enter a null or empty name.

Parameters:

name - bin name, current limit is 14 characters

value - bin value

Bin

public Bin(String name,
           float value)

Constructor, specifying bin name and float value. Aerospike server versions >= 3.6.0 natively support floating point values. If your cluster supports floating point values, then this is always the correct constructor for float. Remember to also set Value.UseDoubleType to true;

If your cluster does not support floating point, the value is converted to long bits. On reads, it's important to call Record.getFloat(String name) to indicate that the long returned by the server should be converted back to a float. If the same bin name holds different types for different records, then this constructor should not be used because there is no way to know when reading if the long should be converted to a float. Instead, use Bin(String name, Object value) which converts the float to a java serialized blob.

 float value = 11.7;
 Bin bin = new Bin("mybin", (Object) value);
 

This is slower and not portable to other languages, but the float type is preserved, so a Float will be returned without knowing if a conversion should be made.

For servers configured as "single-bin", enter a null or empty name.

Parameters:

name - bin name, current limit is 14 characters

value - bin value

Bin

public Bin(String name,
           boolean value)

Constructor, specifying bin name and boolean value. For servers configured as "single-bin", enter a null or empty name.

Parameters:

name - bin name, current limit is 14 characters

value - bin value

Bin

public Bin(String name,
           List<?> value)

Create bin with a list value. The list value will be serialized as a server list type.

If connecting to Aerospike 2 servers, use the following instead:

 
 Bin bin = new Bin(name, (Object)list);
 
 

For servers configured as "single-bin", enter a null or empty name.

Parameters:

name - bin name, current limit is 14 characters

value - bin value

Bin

public Bin(String name,
           Map<?,?> value)

Create bin with a map value. The map value will be serialized as a server map type. For servers configured as "single-bin", enter a null or empty name.

Parameters:

name - bin name, current limit is 14 characters

value - bin value

Bin

public Bin(String name,
           Value value)

Constructor, specifying bin name and value. For servers configured as "single-bin", enter a null or empty name.

Parameters:

name - bin name, current limit is 14 characters

value - bin value

Bin

public Bin(String name,
           Object value)

Constructor, specifying bin name and object value. This is the slowest of the Bin constructors because the type must be determined using multiple "instanceof" checks.

For servers configured as "single-bin", enter a null or empty name.

Parameters:

name - bin name, current limit is 14 characters

value - bin value

Method Detail

asBlob

public static Bin asBlob(String name,
                         Object value)

Create bin with a blob value. The value will be java serialized. This method is faster than the bin Object constructor because the blob is converted directly instead of using multiple "instanceof" type checks with a blob default.

For servers configured as "single-bin", enter a null or empty name.

Parameters:

name - bin name, current limit is 14 characters

value - bin value

asNull

public static Bin asNull(String name)

Create bin with a null value. This is useful for bin deletions within a record. For servers configured as "single-bin", enter a null or empty name.

Parameters:

name - bin name, current limit is 14 characters

asGeoJSON

public static Bin asGeoJSON(String name,
                            String value)

Create bin with a GeoJSON value.

Parameters:

name - bin name, current limit is 14 characters

value - bin value

toString

public String toString()

Return string representation of bin.

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Compare Bin for equality.

Overrides:

equals in class Object

hashCode

public int hashCode()

Return hash code for Bin.

Overrides:

hashCode in class Object