com.basho.riak.client.core.query

Class Location

java.lang.Object

com.basho.riak.client.core.query.Location

public final class Location
extends Object

Encapsulates a key and Namespace.

Many client operations locate a piece of information in Riak via a bucket type, bucket name, and a key. This class encapsulates these three items by combining a Namespace with a key and is used with most client operations.

Riak itself is character set agnostic; everything is stored as bytes. The convenience methods in this class rely on either the default Charset or a supplied one to convert Strings to a byte[].

Since:

2.0

Author:

Brian Roach

Constructor Summary

Constructors

Constructor and Description
Location(Namespace namespace, BinaryValue key) Construct a new Location with the provided Namespace and key.
Location(Namespace namespace, String key) Construct a new Location with the provided namespace and key.
Location(Namespace namespace, String key, Charset charset) Construct a new Location with the provided Namespace and key.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
BinaryValue	getKey() Returns the key for this location.
String	getKeyAsString() Get the key for this location as a String.
String	getKeyAsString(Charset charset) Get the key for this location as a String.
Namespace	getNamespace() Return the Namespace for this location.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Location

public Location(Namespace namespace,
                BinaryValue key)

Construct a new Location with the provided Namespace and key.

Parameters:

namespace - The namespace for this location.

key - The key for this location.

Location

public Location(Namespace namespace,
                String key,
                Charset charset)

Construct a new Location with the provided Namespace and key.

The supplied string is converted to bytes using the supplied charset.

Parameters:

namespace - The namespace for this location.

key - The key for this location.

charset - the charset for the key

Location

public Location(Namespace namespace,
                String key)

Construct a new Location with the provided namespace and key.

The supplied string is converted to bytes using the default charset.

Parameters:

namespace - The namespace for this location.

key - The key for this location.

Method Detail

getKey

public BinaryValue getKey()

Returns the key for this location.

Returns:

the Riak Key.

getKeyAsString

public String getKeyAsString()

Get the key for this location as a String.

The default character set is used.

Returns:

the key for this location as a String

getKeyAsString

public String getKeyAsString(Charset charset)

Get the key for this location as a String.

The supplied character set is used.

Parameters:

charset - The Charset used to convert to a String.

Returns:

the key for this Location as a String.

getNamespace

public Namespace getNamespace()

Return the Namespace for this location.

Returns:

the namespace.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object