com.basho.riak.client.core.query.UserMetadata

Class RiakUserMetadata

java.lang.Object

com.basho.riak.client.core.query.UserMetadata.RiakUserMetadata

public class RiakUserMetadata
extends Object

A threadsafe container for user metadata.

Arbitrary user metadata can be attached to an object in Riak. These are simply key/value pairs meaningful outside of the actual value of the object. This container allows the user to manipulate that data.

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:

2.0

Author:

Brian Roach

See Also:

RiakObject.getUserMeta()

Constructor Summary

Constructors

Constructor and Description
RiakUserMetadata()

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear all user metadata entries.
boolean	containsKey(String key) Determine if a specific usermeta entry is present.
boolean	containsKey(String key, Charset charset) Determine if a specific usermeta entry is present.
BinaryValue	get(BinaryValue key) Get a user metadata entry.
String	get(String key) Get a user metadata entry.
String	get(String key, Charset charset) Get a user metadata entry.
Set<Map.Entry<BinaryValue,BinaryValue>>	getUserMetadata() Get the user metadata entries
boolean	isEmpty() Determine if usermeta is present.
void	put(BinaryValue key, BinaryValue value) Set a user metadata entry using raw bytes.
RiakUserMetadata	put(Map<String,String> metaMap)
void	put(String key, String value) Set a user metadata entry.
void	put(String key, String value, Charset charset) Set a user metadata entry.
void	remove(BinaryValue key)
void	remove(String key)
void	remove(String key, Charset charset)
int	size() Get the number of user metadata entries.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RiakUserMetadata

public RiakUserMetadata()

Method Detail

isEmpty

public boolean isEmpty()

Determine if usermeta is present.

Returns:

true if there are no entries, false otherwise.

containsKey

public boolean containsKey(String key)

Determine if a specific usermeta entry is present.

This method uses the default Charset to convert the supplied key.

Parameters:

key - the metadata key

Returns:

true if the entry is present, false otherwise.

containsKey

public boolean containsKey(String key,
                  Charset charset)

Determine if a specific usermeta entry is present.

This method uses the supplied Charset to convert the supplied key.

Parameters:

key - the metadata key

Returns:

true if the entry is present, false otherwise.

get

public String get(String key)

Get a user metadata entry.

This method and its RiakUserMetadata.put(java.lang.String, java.lang.String) counterpart use the default Charset to convert the Strings.

Parameters:

key - the key for the user metadata entry as a String encoded using the default Charset

Returns:

the value for the entry converted to a String using the default Charset

get

public String get(String key,
         Charset charset)

Get a user metadata entry.

This method and its RiakUserMetadata.put(java.lang.String, java.lang.String, java.nio.charset.Charset) counterpart use the supplied Charset to convert the Strings.

Parameters:

key - the key for the user metadata entry as a String encoded using the supplied Charset

Returns:

the value for the entry converted to a String using the supplied Charset

get

public BinaryValue get(BinaryValue key)

Get a user metadata entry.

This method and its RiakUserMetadata.put(com.basho.riak.client.core.util.BinaryValue, com.basho.riak.client.core.util.BinaryValue) allow access to the raw bytes.

Parameters:

key - the key for the user metadata entry

Returns:

the value for the entry

getUserMetadata

public Set<Map.Entry<BinaryValue,BinaryValue>> getUserMetadata()

Get the user metadata entries

This method allows access to the user metadata entries directly as raw bytes. The Set is an unmodifiable view of all the entries.

Returns:

an unmodifiable view of all the entries.

put

public void put(String key,
       String value)

Set a user metadata entry.

This method and its RiakUserMetadata.get(java.lang.String) counterpart use the default Charset to convert the Strings.

Parameters:

key - the key for the user metadata entry as a String encoded using the default Charset

value - the value for the entry as a String encoded using the default Charset

put

public void put(String key,
       String value,
       Charset charset)

Set a user metadata entry.

This method and its RiakUserMetadata.get(java.lang.String, java.nio.charset.Charset) counterpart use the supplied Charset to convert the Strings.

Parameters:

key - the key for the user metadata entry as a String encoded using the supplied Charset

value - the value for the entry as a String encoded using the supplied Charset

put

public void put(BinaryValue key,
       BinaryValue value)

Set a user metadata entry using raw bytes.

This method and its RiakUserMetadata.get(com.basho.riak.client.core.util.BinaryValue) counterpart all access to the user metadata raw bytes

Parameters:

key - the key for the user metadata entry

value - the value for the entry

remove

public void remove(BinaryValue key)

remove

public void remove(String key,
          Charset charset)

remove

public void remove(String key)

put

public RiakUserMetadata put(Map<String,String> metaMap)

clear

public void clear()

Clear all user metadata entries.

size

public int size()

Get the number of user metadata entries.

Returns:

the number of entries