com.basho.riak.client.core.query.links

Class RiakLink

java.lang.Object

com.basho.riak.client.core.query.links.RiakLink

public class RiakLink
extends Object

Models a link from one object to another in Riak.

Links are metadata that establish one-way relationships between objects in Riak. They can be used to loosely model graph like relationships between objects in Riak.

Data in Riak is character asSet agnostic; it's simply raw bytes. Methods are provided here to either use your default character asSet or supply a specific one to convert to and from Strings.

Since:

1.0

Author:

Russel Brown , Brian Roach

Constructor Summary

Constructors

Constructor and Description
RiakLink(BinaryValue bucket, BinaryValue key, BinaryValue tag) Create a RiakLink from the specified parameters.
RiakLink(RiakLink riakLink) Create a RiakLink that is a copy of another RiakLink.
RiakLink(String bucket, String key, String tag) Create a RiakLink from the specified parameters.
RiakLink(String bucket, String key, String tag, Charset charset) Create a RiakLink from the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getBucket() Get the bucket for this RiakLink as a String
String	getBucket(Charset charset) Get the bucket for this RiakLink as a String
BinaryValue	getBucketAsBytes() Get the bucket as a wrapped byte array
String	getKey() Get the key for this RiakLink as a String
String	getKey(Charset charset) Get the key for this RiakLink as a String
BinaryValue	getKeyAsBytes() Return the key as a wrapped byte array
String	getTag() Get the tag for this RiakLink as a String
String	getTag(Charset charset) Get the tag for this RiakLink as a String
BinaryValue	getTagAsBytes() Get the tag as bytes
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RiakLink

public RiakLink(String bucket,
                String key,
                String tag)

Create a RiakLink from the specified parameters.

The values are stored internally as bytes. The default Charset will be used to convert the supplied Strings

Parameters:

bucket - the bucket name

key - the key

tag - the link tag

RiakLink

public RiakLink(String bucket,
                String key,
                String tag,
                Charset charset)

Create a RiakLink from the specified parameters.

The values are stored internally as bytes. The supplied Charset will be used to convert the supplied Strings

Parameters:

bucket - the bucket

key - the key

tag - the link tag

charset - the character asSet for the supplied Strings

RiakLink

public RiakLink(BinaryValue bucket,
                BinaryValue key,
                BinaryValue tag)

Create a RiakLink from the specified parameters.

Parameters:

bucket - the bucket name

key - the key

tag - the link tag

RiakLink

public RiakLink(RiakLink riakLink)

Create a RiakLink that is a copy of another RiakLink.

Parameters:

riakLink - the RiakLink to copy

Method Detail

getBucket

public String getBucket()

Get the bucket for this RiakLink as a String

The bucket is stored internally as bytes. The default Charset is used to convert to a String

Returns:

the bucket as a String encoded using the default Charset

getBucket

public String getBucket(Charset charset)

Get the bucket for this RiakLink as a String

The bucket is stored internally as bytes. The supplied Charset is used to convert to a String

Returns:

the bucket as a String encoded using the supplied Charset

getBucketAsBytes

public BinaryValue getBucketAsBytes()

Get the bucket as a wrapped byte array

Returns:

the bucket name in a BinaryValue

getKey

public String getKey()

Get the key for this RiakLink as a String

The key is stored internally as bytes. The default Charset is used to convert to a String

Returns:

the key as a String encoded using the default Charset

getKey

public String getKey(Charset charset)

Get the key for this RiakLink as a String

The key is stored internally as bytes. The supplied Charset is used to convert to a String

Returns:

the key as a String encoded using the supplied Charset

getKeyAsBytes

public BinaryValue getKeyAsBytes()

Return the key as a wrapped byte array

Returns:

the key in a BinaryValue

getTag

public String getTag()

Get the tag for this RiakLink as a String

The tag is stored internally as bytes. The default Charset is used to convert to a String

Returns:

the tag as a String encoded using the default Charset

getTag

public String getTag(Charset charset)

Get the tag for this RiakLink as a String

The tag is stored internally as bytes. The supplied Charset is used to convert to a String

Returns:

the tag as a String encoded using the supplied Charset

getTagAsBytes

public BinaryValue getTagAsBytes()

Get the tag as bytes

Returns:

the tag in a BinaryValue

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