com.couchbase.client.java.datastructures

Class CouchbaseMap<E>

java.lang.Object

java.util.AbstractMap<String,E>

com.couchbase.client.java.datastructures.CouchbaseMap<E>

Type Parameters:

E - the type of values in the map (restricted to JsonObject.

All Implemented Interfaces:

Map<String,E>

@Stability.Committed
public class CouchbaseMap<E>
extends AbstractMap<String,E>

A CouchbaseMap is a Map backed by a Couchbase document (more specifically a JSON object). Null keys are NOT permitted, and keys are restricted to String. Values in a CouchbaseMap are restricted to the types that a JSON objects can contain. JSON sub-objects and sub-arrays can be represented as JsonObject and JsonArray respectively.

Since:

2.3.6

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
CouchbaseMap(String id, Collection collection, Class<E> entityType, MapOptions options) Create a new CouchbaseMap, backed by the document identified by id in the given Couchbase bucket.

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<String,E>>	entrySet()
E	get(Object key)
E	put(String key, E value)
E	remove(Object key)
int	size()

Methods inherited from class java.util.AbstractMap

clone, equals, hashCode, isEmpty, keySet, putAll, toString, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

CouchbaseMap

public CouchbaseMap(String id,
                    Collection collection,
                    Class<E> entityType,
                    MapOptions options)

Create a new CouchbaseMap, backed by the document identified by id in the given Couchbase bucket. Note that if the document already exists, its content will be used as initial content for this collection. Otherwise it is created empty.

Parameters:

id - the id of the Couchbase document to back the map.

collection - the Collection through which to interact with the document.

entityType - a Class describing the type of objects used as values in this Map.

options - a MapOptions to use for all operations on this instance of the map.

Method Detail

put

public E put(String key,
             E value)

Specified by:

put in interface Map<String,E>

Overrides:

put in class AbstractMap<String,E>

get

public E get(Object key)

Specified by:

get in interface Map<String,E>

Overrides:

get in class AbstractMap<String,E>

remove

public E remove(Object key)

Specified by:

remove in interface Map<String,E>

Overrides:

remove in class AbstractMap<String,E>

clear

public void clear()

Specified by:

clear in interface Map<String,E>

Overrides:

clear in class AbstractMap<String,E>

entrySet

public Set<Map.Entry<String,E>> entrySet()

Specified by:

entrySet in interface Map<String,E>

Specified by:

entrySet in class AbstractMap<String,E>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,E>

Overrides:

containsKey in class AbstractMap<String,E>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,E>

Overrides:

containsValue in class AbstractMap<String,E>

size

public int size()

Specified by:

size in interface Map<String,E>

Overrides:

size in class AbstractMap<String,E>