com.basho.riak.client.core.query

Class Namespace

java.lang.Object

com.basho.riak.client.core.query.Namespace

public class Namespace
extends Object

Encapsulates a Riak bucket type and bucket name.

Riak 2.0 introduced bucket types, which form a namespace in Riak when combined with a bucket name. This class encapsulates those two items for use with operations.

Buckets in Riak are automatically created for a type if they do not yet exist. Bucket types, on the other hand, are not. Anything other than the default bucket type must be explicitly created using the riak_admin command line tool.

Bucket types can only be in UTF-8. Bucket names have no restrictions.

Buckets in the default bucket type can not hold CRDTs (e.g. Maps, Counters, Sets, etc).

Since:

2.0

Author:

Brian Roach

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_BUCKET_TYPE The default bucket type in Riak.

Constructor Summary

Constructors

Constructor and Description
Namespace(BinaryValue bucketName) Construct a new Namespace with the provided bucket name and the default bucket type.
Namespace(BinaryValue bucketType, BinaryValue bucketName) Construct a new Namespace with the provided bucket type and name.
Namespace(String bucketName) Construct a Namespace with the provided bucket name and the default bucket type.
Namespace(String bucketName, Charset charset) Construct a Namespace with the provided bucket name and the default bucket type.
Namespace(String bucketType, String bucketName) Construct a new Namespace with the provided bucket type and name.
Namespace(String bucketType, String bucketName, Charset charset) Construct a new Namespace with the provided bucket type and name.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
BinaryValue	getBucketName() Returns the bucket name for this Namespace.
String	getBucketNameAsString() Get the bucket name for this Namespace as a String.
String	getBucketNameAsString(Charset charset) Get the bucket name for this Namespace as a String.
BinaryValue	getBucketType() Returns the bucket type for this Namespace.
String	getBucketTypeAsString() Get the bucket type for this Namespace as a String.
String	getBucketTypeAsString(Charset charset) Get the bucket type for this Namespace as a String.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUCKET_TYPE

public static final String DEFAULT_BUCKET_TYPE

The default bucket type in Riak. The Riak default bucket type. The type is "default"

See Also:

Constant Field Values

Constructor Detail

Namespace

public Namespace(BinaryValue bucketType,
         BinaryValue bucketName)

Construct a new Namespace with the provided bucket type and name.

Parameters:

bucketType - The bucket type in Riak. This must be UTF-8 encoded.

bucketName - The bucket in Riak.

Namespace

public Namespace(String bucketType,
         String bucketName,
         Charset charset)

Construct a new Namespace with the provided bucket type and name.

The supplied bucket type will be converted to bytes using UTF-8.

The supplied bucket name is converted to bytes using the supplied charset.

Parameters:

bucketType - The bucket type in Riak. This must be a valid UTF-8 string.

bucketName - The name of the bucket in Riak.

charset - the charset used to convert the bucket name to bytes.

Namespace

public Namespace(String bucketType,
         String bucketName)

Construct a new Namespace with the provided bucket type and name.

The bucket type will be converted to bytes using UTF-8.

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

Parameters:

bucketType - The bucket type in Riak.

bucketName - The bucket in Riak

Namespace

public Namespace(BinaryValue bucketName)

Construct a new Namespace with the provided bucket name and the default bucket type.

The Namespace will use the default bucket type and the bucket name provided.

Parameters:

bucketName - the bucket name in Riak.

See Also:

DEFAULT_BUCKET_TYPE

Namespace

public Namespace(String bucketName,
         Charset charset)

Construct a Namespace with the provided bucket name and the default bucket type.

The Namespace will use the default bucket type and the bucket name provided.

The supplied bucket name will be converted to bytes using the supplied charset.

Parameters:

bucketName - the name of the bucket.

charset - the charset to use to convert the string to bytes.

See Also:

DEFAULT_BUCKET_TYPE

Namespace

public Namespace(String bucketName)

Construct a Namespace with the provided bucket name and the default bucket type.

The Namespace will use the default bucket type and the bucket name provided.

The supplied bucket name will be converted to bytes using the default charset.

Parameters:

bucketName - the name of the bucket.

See Also:

DEFAULT_BUCKET_TYPE

Method Detail

getBucketType

public BinaryValue getBucketType()

Returns the bucket type for this Namespace.

Returns:

the Riak bucket type.

getBucketTypeAsString

public String getBucketTypeAsString()

Get the bucket type for this Namespace as a String.

The default Charset is used to convert to a String.

Returns:

The bucket type for this Namespace as a String.

getBucketTypeAsString

public String getBucketTypeAsString(Charset charset)

Get the bucket type for this Namespace as a String.

The supplied Charset is used to convert to a String.

Parameters:

charset - The Charset used to convert to a String.

Returns:

The bucket type for this Namespace as a String.

getBucketName

public BinaryValue getBucketName()

Returns the bucket name for this Namespace.

Returns:

the Riak bucket name.

getBucketNameAsString

public String getBucketNameAsString()

Get the bucket name for this Namespace as a String.

The default Charset is used.

Returns:

the key for this Location as a String.

getBucketNameAsString

public String getBucketNameAsString(Charset charset)

Get the bucket name for this Namespace as a String.

The supplied Charset is used.

Parameters:

charset - the Charset used to convert to a String.

Returns:

the key for this Location as a String.

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