com.basho.riak.client.core.util

Class BinaryValue

java.lang.Object

com.basho.riak.client.core.util.BinaryValue

public final class BinaryValue
extends Object

Lightweight utility class for byte arrays.

In almost all cases Riak is character asSet agnostic when it comes to data; buckets, keys, values and metadata are all stored in Riak simply as bytes.

This utility class is used throughout the client in order to encapsulate and allow access to those bytes by the user when the data is generally representative of a String so that any character asSet may be used.

Thread Safety:
If you are using this class directly keep in mind that any modification to the wrapped byte[] post creation via either a retained reference to the array after calling unsafeCreate() or accessing the array directly via unsafeGetValue() will lead to undefined behavior in regard to thread safety and visibility.

Since:

2.0

Author:

Brian Roach

Method Summary

Modifier and Type	Method and Description
static BinaryValue	create(byte[] data) Create a BinaryValue containing a copy of the supplied byte[]
static BinaryValue	create(String data) Create a BinaryValue containing a copy of the supplied String encoded using the default character asSet.
static BinaryValue	create(String data, Charset charset) Create a BinaryValue containing a copy of the supplied string encoded using the supplied Charset.
static BinaryValue	createFromUtf8(String data) Create a BinaryValue containing a copy of the supplied String encoded using UTF-8.
boolean	equals(Object other)
byte[]	getValue() Return a copy of the wrapped byte[]
int	hashCode()
int	length() Return the length of the wrapped byte[]
String	toString() Return the wrapped byte[] as a String.
String	toString(Charset charset) Return the wrapped byte[] as a String
String	toStringUtf8() Return the wrapped byte[] as a String.
static BinaryValue	unsafeCreate(byte[] data) Create a BinaryValue containing the supplied byte[]
byte[]	unsafeGetValue() Return the wrapped byte[]

Methods inherited from class java.lang.Object

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

Method Detail

create

public static BinaryValue create(byte[] data)

Create a BinaryValue containing a copy of the supplied byte[]

A copy of the supplied byte[] is made.

Parameters:

data - the byte[] to copy

Returns:

a new BinaryValue

create

public static BinaryValue create(String data)

Create a BinaryValue containing a copy of the supplied String encoded using the default character asSet.

Parameters:

data - the data to copy

Returns:

a new BinaryValue

createFromUtf8

public static BinaryValue createFromUtf8(String data)

Create a BinaryValue containing a copy of the supplied String encoded using UTF-8.

Parameters:

data - the data to copy

Returns:

a new BinaryValue

create

public static BinaryValue create(String data,
                                 Charset charset)

Create a BinaryValue containing a copy of the supplied string encoded using the supplied Charset.

Parameters:

data - the data to copy

charset - the charset to use for encoding

Returns:

a new BinaryValue

unsafeCreate

public static BinaryValue unsafeCreate(byte[] data)

Create a BinaryValue containing the supplied byte[]

The byte[] is not copied.

Parameters:

data - the byte[] to wrap

Returns:

a new BinaryValue
Thread Safety:
The supplied byte[] is not copied and the reference is used directly. Retaining a reference to this array and making subsequent changes will lead to undefined behavior in regard to thread safety and visibility.

getValue

public byte[] getValue()

Return a copy of the wrapped byte[]

Arrays.copyOf(byte[], int) is used to copy the internal byte[]

Returns:

a copy of the internal byte[]

unsafeGetValue

public byte[] unsafeGetValue()

Return the wrapped byte[]

Returns:

the internal byte[]
Thread Safety:
This method exposes the internal byte[] directly. Modifying the contents of this array will lead to undefined behavior in regard to thread safety and visibility.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Return the wrapped byte[] as a String.

The default character asSet is used for encoding.

Overrides:

toString in class Object

Returns:

a String created using the default Charset

toStringUtf8

public String toStringUtf8()

Return the wrapped byte[] as a String.

UTF-8 is used for encoding.

Returns:

a String created using the UTF-8 Charset

toString

public String toString(Charset charset)

Return the wrapped byte[] as a String

The supplied Charset is used to convert the bytes.

Returns:

a String created using the supplied Charset

length

public int length()

Return the length of the wrapped byte[]

Returns:

the length.