com.basho.riak.client.core.query.crdt.types

Class RiakMap

java.lang.Object

com.basho.riak.client.core.query.crdt.types.RiakDatatype

com.basho.riak.client.core.query.crdt.types.RiakMap

public class RiakMap
extends RiakDatatype

Representation of the Riak map datatype.

This is an immutable map returned when querying Riak for a map datatype.

Since:

2.0

Author:

Dave Rusek

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RiakMap.MapEntry A RiakMap entry (key/value pair).

Constructor Summary

Constructors

Constructor and Description
RiakMap(List<RiakMap.MapEntry> mapEntries)

Method Summary

Methods

Modifier and Type	Method and Description
List<RiakDatatype>	get(BinaryValue key) Returns the value(s) to which the specified key is mapped, or null if the map contains no mapping for the key.
RiakCounter	getCounter(BinaryValue key) Returns a RiakCounter to which the specified key is mapped, or null if no RiakCounter is present.
RiakCounter	getCounter(String key) Returns a RiakCounter to which the specified key is mapped, or null if no RiakCounter is present.
RiakFlag	getFlag(BinaryValue key) Returns a RiakFlag to which the specified key is mapped, or null if no RiakFlag is present.
RiakFlag	getFlag(String key) Returns a RiakFlag to which the specified key is mapped, or null if no RiakFlag is present.
RiakMap	getMap(BinaryValue key) Returns a RiakMap to which the specified key is mapped, or null if no RiakMap is present.
RiakMap	getMap(String key) Returns a RiakMap to which the specified key is mapped, or null if no RiakMap is present.
RiakRegister	getRegister(BinaryValue key) Returns a RiakRegister to which the specified key is mapped, or null if no RiakRegister is present.
RiakRegister	getRegister(String key) Returns a RiakRegister to which the specified key is mapped, or null if no RiakRegister is present.
RiakSet	getSet(BinaryValue key) Returns a RiakSet to which the specified key is mapped, or null if no RiakSet is present.
RiakSet	getSet(String key) Returns a RiakSet to which the specified key is mapped, or null if no RiakSet is present.
Map<BinaryValue,List<RiakDatatype>>	view() Get this RiakMap as a Map.

Methods inherited from class com.basho.riak.client.core.query.crdt.types.RiakDatatype

getAsCounter, getAsFlag, getAsMap, getAsRegister, getAsSet, isCounter, isFlag, isMap, isRegister, isSet

Methods inherited from class java.lang.Object

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

Constructor Detail

RiakMap

public RiakMap(List<RiakMap.MapEntry> mapEntries)

Method Detail

get

public List<RiakDatatype> get(BinaryValue key)

Returns the value(s) to which the specified key is mapped, or null if the map contains no mapping for the key.

Parameters:

key - key whose associated value(s) is to be returned.

Returns:

a List containing one or more datatypes, or null if this map contains no mapping for the key.

getMap

public RiakMap getMap(BinaryValue key)

Returns a RiakMap to which the specified key is mapped, or null if no RiakMap is present.

Parameters:

key - key whose associated RiakMap is to be returned.

Returns:

a RiakMap, or null if one is not present.

getMap

public RiakMap getMap(String key)

Returns a RiakMap to which the specified key is mapped, or null if no RiakMap is present.

Parameters:

key - key whose associated RiakMap is to be returned.

Returns:

a RiakMap, or null if one is not present.

getSet

public RiakSet getSet(BinaryValue key)

Returns a RiakSet to which the specified key is mapped, or null if no RiakSet is present.

Parameters:

key - key whose associated RiakSet is to be returned.

Returns:

a RiakSet, or null if one is not present.

getSet

public RiakSet getSet(String key)

Returns a RiakSet to which the specified key is mapped, or null if no RiakSet is present.

Parameters:

key - key whose associated RiakSet is to be returned.

Returns:

a RiakSet, or null if one is not present.

getCounter

public RiakCounter getCounter(BinaryValue key)

Returns a RiakCounter to which the specified key is mapped, or null if no RiakCounter is present.

Parameters:

key - key whose associated RiakCounter is to be returned.

Returns:

a RiakCounter, or null if one is not present.

getCounter

public RiakCounter getCounter(String key)

Returns a RiakCounter to which the specified key is mapped, or null if no RiakCounter is present.

Parameters:

key - key whose associated RiakCounter is to be returned.

Returns:

a RiakCounter, or null if one is not present.

getFlag

public RiakFlag getFlag(BinaryValue key)

Returns a RiakFlag to which the specified key is mapped, or null if no RiakFlag is present.

Parameters:

key - key whose associated RiakFlag is to be returned.

Returns:

a RiakFlag, or null if one is not present.

getFlag

public RiakFlag getFlag(String key)

Returns a RiakFlag to which the specified key is mapped, or null if no RiakFlag is present.

Parameters:

key - key whose associated RiakFlag is to be returned.

Returns:

a RiakFlag, or null if one is not present.

getRegister

public RiakRegister getRegister(BinaryValue key)

Returns a RiakRegister to which the specified key is mapped, or null if no RiakRegister is present.

Parameters:

key - key whose associated RiakRegister is to be returned.

Returns:

a RiakRegister, or null if one is not present.

getRegister

public RiakRegister getRegister(String key)

Returns a RiakRegister to which the specified key is mapped, or null if no RiakRegister is present.

Parameters:

key - key whose associated RiakRegister is to be returned.

Returns:

a RiakRegister, or null if one is not present.

view

public Map<BinaryValue,List<RiakDatatype>> view()

Get this RiakMap as a Map. The returned Map is unmodifiable.

Specified by:

view in class RiakDatatype

Returns:

a read-only view of the RiakMap.