MutableDocument (Couchbase Lite 2.0.0-299)

java.lang.Object
- com.couchbase.lite.Document
- - com.couchbase.lite.MutableDocument

All Implemented Interfaces:

Iterable<String>
```
public final class MutableDocument
extends Document
```
A Couchbase Lite Document. A document has key/value properties like a Map.

Constructor Summary

Constructors
Constructor and Description
`MutableDocument()` Creates a new Document object with a new random UUID.
`MutableDocument(Map<String,Object> data)` Initializes a new CBLDocument object with a new random UUID and the dictionary as the content.
`MutableDocument(String id)` Creates a new Document object with the given ID.
`MutableDocument(String id, Map<String,Object> data)` Initializes a new Document object with a given ID and the dictionary as the content.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(String key)`
`int`	`count()`
`MutableArray`	`getArray(String key)` Get a property's value as a Array, which is a mapping object of an array value.
`Blob`	`getBlob(String key)`
`boolean`	`getBoolean(String key)`
`Date`	`getDate(String key)`
`MutableDictionary`	`getDictionary(String key)` Get a property's value as a Dictionary, which is a mapping object of an dictionary value.
`double`	`getDouble(String key)`
`float`	`getFloat(String key)`
`int`	`getInt(String key)`
`List<String>`	`getKeys()`
`long`	`getLong(String key)`
`Number`	`getNumber(String key)`
`String`	`getString(String key)`
`Object`	`getValue(String key)`
`boolean`	`isDeleted()` Is the document deleted?
`MutableDocument`	`remove(String key)` Removes the mapping for a key from this Dictionary
`MutableDocument`	`setArray(String key, Array value)` Set an Array value for the given key
`MutableDocument`	`setBlob(String key, Blob value)` Set a Blob value for the given key
`MutableDocument`	`setBoolean(String key, boolean value)` Set a boolean value for the given key
`MutableDocument`	`setData(Map<String,Object> data)` Set a dictionary as a content.
`MutableDocument`	`setDate(String key, Date value)` Set a Date value for the given key
`MutableDocument`	`setDictionary(String key, Dictionary value)` Set a Dictionary value for the given key
`MutableDocument`	`setDouble(String key, double value)` Set a double value for the given key
`MutableDocument`	`setFloat(String key, float value)` Set a float value for the given key
`MutableDocument`	`setInt(String key, int value)` Set a integer value for the given key
`MutableDocument`	`setLong(String key, long value)` Set a long value for the given key
`MutableDocument`	`setNumber(String key, Number value)` Set a Number value for the given key
`MutableDocument`	`setString(String key, String value)` Set a String value for the given key
`MutableDocument`	`setValue(String key, Object value)` Set an object value by key.
`Map<String,Object>`	`toMap()`
`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, getSequence, getString, getValue, hashCode, iterator, toMap

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- 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(String id)
```
    Creates a new Document object with the given ID. If a null ID value is given, 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.
  - MutableDocument
```
public MutableDocument(Map<String,Object> data)
```
    Initializes a new CBLDocument object with a new random UUID and the dictionary as the content. 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:
    
    data - the Map object
  - MutableDocument
```
public MutableDocument(String id,
                       Map<String,Object> data)
```
    Initializes a new Document object with a given ID and the dictionary as the content. If a null ID value is given, 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
- Method Detail
  - toMutable
```
public MutableDocument toMutable()
```
    Returns the copy of this MutableDocument object.
    
    Overrides:
    
    toMutable in class Document
    
    Returns:
    
    The MutableDocument object
  - isDeleted
```
public boolean isDeleted()
```
    Is the document deleted?
    
    Overrides:
    
    isDeleted in class Document
    
    Returns:
    
    true if deleted, false otherwise
  - setData
```
public MutableDocument setData(Map<String,Object> data)
```
    Set a dictionary as a content. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. The List and Map must contain only the above types. Setting the new dictionary content will replace the current data including the existing Array and Dictionary objects.
    
    Parameters:
    
    data - the dictionary object.
    
    Returns:
    
    this Document instance
  - setValue
```
public MutableDocument setValue(String key,
                                Object value)
```
    Set an object value by key. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. The List and Map must contain only the above types. An Date object will be converted to an ISO-8601 format string.
    
    Parameters:
    
    key - the key.
    
    value - the Object value.
    
    Returns:
    
    this Document instance
  - setString
```
public MutableDocument setString(String key,
                                 String value)
```
    Set a String value for the given key
    
    Parameters:
    
    key - the key.
    
    key - the String value.
    
    Returns:
    
    this MutableDocument instance
  - setNumber
```
public MutableDocument setNumber(String key,
                                 Number value)
```
    Set a Number value for the given key
    
    Parameters:
    
    key - the key.
    
    key - the Number value.
    
    Returns:
    
    this MutableDocument instance
  - setInt
```
public MutableDocument setInt(String key,
                              int value)
```
    Set a integer value for the given key
    
    Parameters:
    
    key - the key.
    
    key - the integer value.
    
    Returns:
    
    this MutableDocument instance
  - setLong
```
public MutableDocument setLong(String key,
                               long value)
```
    Set a long value for the given key
    
    Parameters:
    
    key - the key.
    
    key - the long value.
    
    Returns:
    
    this MutableDocument instance
  - setFloat
```
public MutableDocument setFloat(String key,
                                float value)
```
    Set a float value for the given key
    
    Parameters:
    
    key - the key.
    
    key - the float value.
    
    Returns:
    
    this MutableDocument instance
  - setDouble
```
public MutableDocument setDouble(String key,
                                 double value)
```
    Set a double value for the given key
    
    Parameters:
    
    key - the key.
    
    key - the double value.
    
    Returns:
    
    this MutableDocument instance
  - setBoolean
```
public MutableDocument setBoolean(String key,
                                  boolean value)
```
    Set a boolean value for the given key
    
    Parameters:
    
    key - the key.
    
    key - the boolean value.
    
    Returns:
    
    this MutableDocument instance
  - setBlob
```
public MutableDocument setBlob(String key,
                               Blob value)
```
    Set a Blob value for the given key
    
    Parameters:
    
    key - the key.
    
    key - the Blob value.
    
    Returns:
    
    this MutableDocument instance
  - setDate
```
public MutableDocument setDate(String key,
                               Date value)
```
    Set a Date value for the given key
    
    Parameters:
    
    key - the key.
    
    key - the Date value.
    
    Returns:
    
    this MutableDocument instance
  - setArray
```
public MutableDocument setArray(String key,
                                Array value)
```
    Set an Array value for the given key
    
    Parameters:
    
    key - the key.
    
    key - the Array value.
    
    Returns:
    
    this MutableDocument instance
  - setDictionary
```
public MutableDocument setDictionary(String key,
                                     Dictionary value)
```
    Set a Dictionary value for the given key
    
    Parameters:
    
    key - the key.
    
    key - the Dictionary value.
    
    Returns:
    
    this MutableDocument instance
  - remove
```
public MutableDocument remove(String key)
```
    Removes the mapping for a key from this Dictionary
    
    Parameters:
    
    key - the key.
    
    Returns:
    
    this MutableDocument instance
  - getArray
```
public MutableArray getArray(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.
    
    Overrides:
    
    getArray in class Document
    
    Parameters:
    
    key - the key.
    
    Returns:
    
    the Array object.
  - getDictionary
```
public MutableDictionary getDictionary(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.
    
    Overrides:
    
    getDictionary in class Document
    
    Parameters:
    
    key - the key.
    
    Returns:
    
    the Dictionary object or null if the key doesn't exist.
  - count
```
public int count()
```
  - getKeys
```
public List<String> getKeys()
```
  - getValue
```
public Object getValue(String key)
```
  - getString
```
public String getString(String key)
```
  - getNumber
```
public Number getNumber(String key)
```
  - getInt
```
public int getInt(String key)
```
  - getLong
```
public long getLong(String key)
```
  - getFloat
```
public float getFloat(String key)
```
  - getDouble
```
public double getDouble(String key)
```
  - getBoolean
```
public boolean getBoolean(String key)
```
  - getBlob
```
public Blob getBlob(String key)
```
  - getDate
```
public Date getDate(String key)
```
  - toMap
```
public Map<String,Object> toMap()
```
  - contains
```
public boolean contains(String key)
```

Class MutableDocument

Constructor Summary

Method Summary

Methods inherited from class com.couchbase.lite.Document

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

MutableDocument

MutableDocument

MutableDocument

MutableDocument

Method Detail

toMutable

isDeleted

setData

setValue

setString

setNumber

setInt

setLong

setFloat

setDouble

setBoolean

setBlob

setDate

setArray

setDictionary

remove

getArray

getDictionary

count

getKeys

getValue

getString

getNumber

getInt

getLong

getFloat

getDouble

getBoolean

getBlob

getDate

toMap

contains