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 to JsonObject.
All Implemented Interfaces:
Map<String,​V>

@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
  • Constructor Details

    • CouchbaseMap

      public CouchbaseMap​(String id, Bucket bucket)
      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.
      bucket - the Bucket through which to interact with the document.
    • CouchbaseMap

      public CouchbaseMap​(String id, Bucket bucket, Map<String,​? extends V> data)
      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 is reset to the values copied from the given data 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 - the Bucket through which to interact with the document.
      data - Map of the elements to initially store in the CouchbaseMap.
  • Method Details