Package com.couchbase.lite
Class MutableDocument
- java.lang.Object
-
- com.couchbase.lite.Document
-
- com.couchbase.lite.MutableDocument
-
- All Implemented Interfaces:
DictionaryInterface
,MutableDictionaryInterface
,java.lang.Iterable<java.lang.String>
public final class MutableDocument extends Document implements MutableDictionaryInterface
A Couchbase Lite Document. A document has key/value properties like a Map.
-
-
Constructor Summary
Constructors Constructor Description MutableDocument()
Creates a new Document object with a new random UUID.MutableDocument(java.lang.String id)
Creates a new Document with the given ID.MutableDocument(java.lang.String id, java.lang.String json)
Creates a new Document with the given ID and content from the passed JSON string.MutableDocument(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> data)
Creates a new Document with a given ID and content from the passed Map.MutableDocument(java.util.Map<java.lang.String,java.lang.Object> data)
Creates a new Document with a new random UUID and the map as the content.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MutableArray
getArray(java.lang.String key)
Get a property's value as a Array, which is a mapping object of an array value.MutableDictionary
getDictionary(java.lang.String key)
Get a property's value as a Dictionary, which is a mapping object of an dictionary value.MutableDocument
remove(java.lang.String key)
Removes the mapping for a key from this DictionaryMutableDocument
setArray(java.lang.String key, Array value)
Set an Array value for the given keyMutableDocument
setBlob(java.lang.String key, Blob value)
Set a Blob value for the given keyMutableDocument
setBoolean(java.lang.String key, boolean value)
Set a boolean value for the given keyMutableDocument
setData(java.util.Map<java.lang.String,java.lang.Object> data)
Populate a document with content from a Map.MutableDocument
setDate(java.lang.String key, java.util.Date value)
Set a Date value for the given keyMutableDocument
setDictionary(java.lang.String key, Dictionary value)
Set a Dictionary value for the given keyMutableDocument
setDouble(java.lang.String key, double value)
Set a double value for the given keyMutableDocument
setFloat(java.lang.String key, float value)
Set a float value for the given keyMutableDocument
setInt(java.lang.String key, int value)
Set a integer value for the given keyMutableDocument
setJSON(java.lang.String json)
Populate a document with content from a JSON string.MutableDocument
setLong(java.lang.String key, long value)
Set a long value for the given keyMutableDocument
setNumber(java.lang.String key, java.lang.Number value)
Set a Number value for the given keyMutableDocument
setString(java.lang.String key, java.lang.String value)
Set a String value for the given keyMutableDocument
setValue(java.lang.String key, java.lang.Object value)
Set an object value by key.java.lang.String
toJSON()
MutableDocument
toMutable()
Returns the copy of this MutableDocument object.-
Methods inherited from class com.couchbase.lite.Document
contains, count, equals, getBlob, getBoolean, getDate, getDouble, getFloat, getId, getInt, getKeys, getLong, getNumber, getRevisionID, getSequence, getString, getValue, hashCode, iterator, toMap, toString
-
-
-
-
Constructor Detail
-
MutableDocument
public MutableDocument()
Creates a new Document object with a new random UUID. The created document will be saved into a database when you call the Database's save(Document) method with the document object given.
-
MutableDocument
public MutableDocument(@Nullable java.lang.String id)
Creates a new Document with the given ID. If the id is null, the document will be created with a new random UUID. The created document will be saved into a database when you call the Database's save(Document) method with the document object given.- Parameters:
id
- the document ID or null.
-
MutableDocument
public MutableDocument(@NonNull java.util.Map<java.lang.String,java.lang.Object> data)
Creates a new Document with a new random UUID and the map as the content. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. If present, Lists, Maps and Dictionaries may contain only the above types. The created document will be saved into a database when you call Database.save(Document) with this document object.- Parameters:
data
- the Map object
-
MutableDocument
public MutableDocument(@Nullable java.lang.String id, @NonNull java.util.Map<java.lang.String,java.lang.Object> data)
Creates a new Document with a given ID and content from the passed Map. If the id is null, the document will be created with a new random UUID. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. The List and Map must contain only the above types. The created document will be saved into a database when you call the Database's save(Document) method with the document object given.- Parameters:
id
- the document ID.data
- the Map object
-
MutableDocument
public MutableDocument(@Nullable java.lang.String id, @NonNull java.lang.String json)
Creates a new Document with the given ID and content from the passed JSON string. If the id is null, the document will be created with a new random UUID. The created document will be saved into a database when you call the Database's save(Document) method with the document object given.- Parameters:
id
- the document ID or null.json
- the document content as a JSON string.
-
-
Method Detail
-
toMutable
@NonNull public MutableDocument toMutable()
Returns the copy of this MutableDocument object.
-
setData
@NonNull public MutableDocument setData(@NonNull java.util.Map<java.lang.String,java.lang.Object> data)
Populate a document with content from a Map. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. If present, Lists, Maps and Dictionaries may contain only the above types. Setting the document content will replace the current data including the existing Array and Dictionary objects.- Specified by:
setData
in interfaceMutableDictionaryInterface
- Parameters:
data
- the dictionary object.- Returns:
- this Document instance
-
setJSON
@NonNull public MutableDocument setJSON(@NonNull java.lang.String json)
Populate a document with content from a JSON string. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. If present, Lists, Maps and Dictionaries may contain only the above types. Setting the document content will replace the current data including the existing Array and Dictionary objects.- Specified by:
setJSON
in interfaceMutableDictionaryInterface
- Parameters:
json
- the dictionary object.- Returns:
- this Document instance
-
setValue
@NonNull public MutableDocument setValue(@NonNull java.lang.String key, @Nullable java.lang.Object value)
Set an object value by key. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. If present, Lists, Maps and Dictionaries may contain only the above types. An Date object will be converted to an ISO-8601 format string.- Specified by:
setValue
in interfaceMutableDictionaryInterface
- Parameters:
key
- the key.value
- the Object value.- Returns:
- this Document instance
-
setString
@NonNull public MutableDocument setString(@NonNull java.lang.String key, @Nullable java.lang.String value)
Set a String value for the given key- Specified by:
setString
in interfaceMutableDictionaryInterface
- Parameters:
key
- the key.value
- the String value.- Returns:
- this MutableDocument instance
-
setNumber
@NonNull public MutableDocument setNumber(@NonNull java.lang.String key, @Nullable java.lang.Number value)
Set a Number value for the given key- Specified by:
setNumber
in interfaceMutableDictionaryInterface
- Parameters:
key
- the key.value
- the Number value.- Returns:
- this MutableDocument instance
-
setInt
@NonNull public MutableDocument setInt(@NonNull java.lang.String key, int value)
Set a integer value for the given key- Specified by:
setInt
in interfaceMutableDictionaryInterface
- Parameters:
key
- the key.value
- the integer value.- Returns:
- this MutableDocument instance
-
setLong
@NonNull public MutableDocument setLong(@NonNull java.lang.String key, long value)
Set a long value for the given key- Specified by:
setLong
in interfaceMutableDictionaryInterface
- Parameters:
key
- the key.value
- the long value.- Returns:
- this MutableDocument instance
-
setFloat
@NonNull public MutableDocument setFloat(@NonNull java.lang.String key, float value)
Set a float value for the given key- Specified by:
setFloat
in interfaceMutableDictionaryInterface
- Parameters:
key
- the key.value
- the float value.- Returns:
- this MutableDocument instance
-
setDouble
@NonNull public MutableDocument setDouble(@NonNull java.lang.String key, double value)
Set a double value for the given key- Specified by:
setDouble
in interfaceMutableDictionaryInterface
- Parameters:
key
- the key.value
- the double value.- Returns:
- this MutableDocument instance
-
setBoolean
@NonNull public MutableDocument setBoolean(@NonNull java.lang.String key, boolean value)
Set a boolean value for the given key- Specified by:
setBoolean
in interfaceMutableDictionaryInterface
- Parameters:
key
- the key.value
- the boolean value.- Returns:
- this MutableDocument instance
-
setBlob
@NonNull public MutableDocument setBlob(@NonNull java.lang.String key, @Nullable Blob value)
Set a Blob value for the given key- Specified by:
setBlob
in interfaceMutableDictionaryInterface
- Parameters:
key
- the key.value
- the Blob value.- Returns:
- this MutableDocument instance
-
setDate
@NonNull public MutableDocument setDate(@NonNull java.lang.String key, @Nullable java.util.Date value)
Set a Date value for the given key- Specified by:
setDate
in interfaceMutableDictionaryInterface
- Parameters:
key
- the key.value
- the Date value.- Returns:
- this MutableDocument instance
-
setArray
@NonNull public MutableDocument setArray(@NonNull java.lang.String key, @Nullable Array value)
Set an Array value for the given key- Specified by:
setArray
in interfaceMutableDictionaryInterface
- Parameters:
key
- the key.value
- the Array value.- Returns:
- this MutableDocument instance
-
setDictionary
@NonNull public MutableDocument setDictionary(@NonNull java.lang.String key, @Nullable Dictionary value)
Set a Dictionary value for the given key- Specified by:
setDictionary
in interfaceMutableDictionaryInterface
- Parameters:
key
- the key.value
- the Dictionary value.- Returns:
- this MutableDocument instance
-
remove
@NonNull public MutableDocument remove(@NonNull java.lang.String key)
Removes the mapping for a key from this Dictionary- Specified by:
remove
in interfaceMutableDictionaryInterface
- Parameters:
key
- the key.- Returns:
- this MutableDocument instance
-
getArray
@Nullable public MutableArray getArray(@NonNull java.lang.String key)
Get a property's value as a Array, which is a mapping object of an array value. Returns null if the property doesn't exists, or its value is not an array.- Specified by:
getArray
in interfaceDictionaryInterface
- Specified by:
getArray
in interfaceMutableDictionaryInterface
- Overrides:
getArray
in classDocument
- Parameters:
key
- the key.- Returns:
- the Array object.
-
getDictionary
@Nullable public MutableDictionary getDictionary(@NonNull java.lang.String key)
Get a property's value as a Dictionary, which is a mapping object of an dictionary value. Returns null if the property doesn't exists, or its value is not an dictionary.- Specified by:
getDictionary
in interfaceDictionaryInterface
- Specified by:
getDictionary
in interfaceMutableDictionaryInterface
- Overrides:
getDictionary
in classDocument
- Parameters:
key
- the key.- Returns:
- the Dictionary object or null if the key doesn't exist.
-
toJSON
@NonNull public java.lang.String toJSON()
- Specified by:
toJSON
in interfaceDictionaryInterface
- Overrides:
toJSON
in classDocument
-
-