Class CouchbaseMap<V>
java.lang.Object
java.util.AbstractMap<String,V>
com.couchbase.client.java.datastructures.collections.CouchbaseMap<V>
- Type Parameters:
V
- the type of values in the map (restricted toJsonObject
.
@Committed @Public public class CouchbaseMap<V> extends AbstractMap<String,V>
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
- Author:
- Simon Baslé, Subhashni Balakrishnan
-
Nested Class Summary
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>
-
Constructor Summary
Constructors Constructor Description CouchbaseMap(String id, Bucket bucket)
CouchbaseMap(String id, Bucket bucket, Map<String,? extends V> data)
-
Method Summary
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 Details
-
CouchbaseMap
Create a newCouchbaseMap
, backed by the document identified byid
in the given Couchbasebucket
. 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.bucket
- theBucket
through which to interact with the document.
-
CouchbaseMap
Create a newCouchbaseMap
, backed by the document identified byid
in the given Couchbasebucket
. Note that if the document already exists, its content is reset to the values copied from the givendata
Map. A null or empty data map will re-initialize any pre-existing document to an empty content.- Parameters:
id
- the id of the Couchbase document to back the list.bucket
- theBucket
through which to interact with the document.data
- Map of the elements to initially store in the CouchbaseMap.
-
-
Method Details
-
put
-
get
-
remove
-
clear
public void clear() -
entrySet
-
containsKey
- Specified by:
containsKey
in interfaceMap<String,V>
- Overrides:
containsKey
in classAbstractMap<String,V>
-
containsValue
- Specified by:
containsValue
in interfaceMap<String,V>
- Overrides:
containsValue
in classAbstractMap<String,V>
-
size
public int size()
-