Document (Couchbase Lite 2.0.0-186)

java.lang.Object
- com.couchbase.lite.ReadOnlyDictionary
- - com.couchbase.lite.ReadOnlyDocument
  - - com.couchbase.lite.Document

All Implemented Interfaces:

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

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(String key)` Tests whether a property exists or not.
`int`	`count()` Gets a number of the entries in the dictionary.
`Array`	`getArray(String key)` Get a property's value as a Array, which is a mapping object of an array value.
`Blob`	`getBlob(String key)` Gets a property's value as a Blob.
`boolean`	`getBoolean(String key)` Gets a property's value as a boolean.
`Date`	`getDate(String key)` Gets a property's value as a Date.
`Dictionary`	`getDictionary(String key)` Get a property's value as a Dictionary, which is a mapping object of an dictionary value.
`double`	`getDouble(String key)` Gets a property's value as an double.
`float`	`getFloat(String key)` Gets a property's value as an float.
`int`	`getInt(String key)` Gets a property's value as an int.
`List<String>`	`getKeys()`
`long`	`getLong(String key)` Gets a property's value as an long.
`Number`	`getNumber(String key)` Gets a property's value as a Number.
`Object`	`getObject(String key)` Gets a property's value as an object.
`String`	`getString(String key)` Gets a property's value as a String.
`Document`	`remove(String key)` Removes the mapping for a key from this Dictionary
`Document`	`set(Map<String,Object> dictionary)` Set a dictionary as a content.
`Document`	`setArray(String key, Array value)`
`Document`	`setBlob(String key, Blob value)`
`Document`	`setBoolean(String key, boolean value)`
`protected void`	`setC4Doc(com.couchbase.lite.CBLC4Doc c4doc)`
`Document`	`setDate(String key, Date value)`
`Document`	`setDictionary(String key, Dictionary value)`
`Document`	`setDouble(String key, double value)`
`Document`	`setFloat(String key, float value)`
`Document`	`setInt(String key, int value)`
`Document`	`setLong(String key, long value)`
`Document`	`setNumber(String key, Number value)`
`Document`	`setObject(String key, Object value)` Set an object value by key.
`Document`	`setString(String key, String value)`
`Map<String,Object>`	`toMap()` Gets content of the current object as an Map.

Methods inherited from class com.couchbase.lite.ReadOnlyDocument
finalize, getId, getSequence, isDeleted, toString

Methods inherited from class com.couchbase.lite.ReadOnlyDictionary
fleeceEncode, getData, iterator, setData

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

- Constructor Detail
  - Document
```
public Document()
```
    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.
  - Document
```
public Document(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.
  - Document
```
public Document(Map<String,Object> dictionary)
```
    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:
    
    dictionary - the Map object
  - Document
```
public Document(String id,
                Map<String,Object> dictionary)
```
    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.
    
    dictionary - the Map object
- Method Detail
  - set
```
public Document set(Map<String,Object> dictionary)
```
    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:
    
    dictionary - the dictionary object.
    
    Returns:
    
    this Document instance
  - setObject
```
public Document setObject(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 Document setString(String key,
                          String value)
```
  - setNumber
```
public Document setNumber(String key,
                          Number value)
```
  - setInt
```
public Document setInt(String key,
                       int value)
```
  - setLong
```
public Document setLong(String key,
                        long value)
```
  - setFloat
```
public Document setFloat(String key,
                         float value)
```
  - setDouble
```
public Document setDouble(String key,
                          double value)
```
  - setBoolean
```
public Document setBoolean(String key,
                           boolean value)
```
  - setBlob
```
public Document setBlob(String key,
                        Blob value)
```
  - setDate
```
public Document setDate(String key,
                        Date value)
```
  - setArray
```
public Document setArray(String key,
                         Array value)
```
  - setDictionary
```
public Document setDictionary(String key,
                              Dictionary value)
```
  - remove
```
public Document remove(String key)
```
    Removes the mapping for a key from this Dictionary
    
    Parameters:
    
    key - the key.
    
    Returns:
    
    this Document instance
  - getArray
```
public Array 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 ReadOnlyDictionary
    
    Parameters:
    
    key - the key.
    
    Returns:
    
    the Array object.
  - getDictionary
```
public Dictionary 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 ReadOnlyDictionary
    
    Parameters:
    
    key - the key.
    
    Returns:
    
    the Dictionary object or null if the key doesn't exist.
  - count
```
public int count()
```
    Gets a number of the entries in the dictionary.
    
    Overrides:
    
    count in class ReadOnlyDictionary
    
    Returns:
  - getKeys
```
public List<String> getKeys()
```
    Overrides:
    
    getKeys in class ReadOnlyDictionary
  - getObject
```
public Object getObject(String key)
```
    Gets a property's value as an object. The object types are Blob, Array, Dictionary, Number, or String based on the underlying data type; or nil if the property value is null or the property doesn't exist.
    
    Overrides:
    
    getObject in class ReadOnlyDictionary
    
    Parameters:
    
    key - the key.
    
    Returns:
    
    the object value or nil.
  - getString
```
public String getString(String key)
```
    Gets a property's value as a String. Returns null if the value doesn't exist, or its value is not a String.
    
    Overrides:
    
    getString in class ReadOnlyDictionary
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the String or null.
  - getNumber
```
public Number getNumber(String key)
```
    Gets a property's value as a Number. Returns null if the value doesn't exist, or its value is not a Number.
    
    Overrides:
    
    getNumber in class ReadOnlyDictionary
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the Number or nil.
  - getInt
```
public int getInt(String key)
```
    Gets a property's value as an int. Floating point values will be rounded. The value `true` is returned as 1, `false` as 0. Returns 0 if the value doesn't exist or does not have a numeric value.
    
    Overrides:
    
    getInt in class ReadOnlyDictionary
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the int value.
  - getLong
```
public long getLong(String key)
```
    Gets a property's value as an long. Floating point values will be rounded. The value `true` is returned as 1, `false` as 0. Returns 0 if the value doesn't exist or does not have a numeric value.
    
    Overrides:
    
    getLong in class ReadOnlyDictionary
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the long value.
  - getFloat
```
public float getFloat(String key)
```
    Gets a property's value as an float. Integers will be converted to float. The value `true` is returned as 1.0, `false` as 0.0. Returns 0.0 if the value doesn't exist or does not have a numeric value.
    
    Overrides:
    
    getFloat in class ReadOnlyDictionary
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the float value.
  - getDouble
```
public double getDouble(String key)
```
    Gets a property's value as an double. Integers will be converted to double. The value `true` is returned as 1.0, `false` as 0.0. Returns 0.0 if the property doesn't exist or does not have a numeric value.
    
    Overrides:
    
    getDouble in class ReadOnlyDictionary
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the double value.
  - getBoolean
```
public boolean getBoolean(String key)
```
    Gets a property's value as a boolean. Returns true if the value exists, and is either `true` or a nonzero number.
    
    Overrides:
    
    getBoolean in class ReadOnlyDictionary
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the boolean value.
  - getBlob
```
public Blob getBlob(String key)
```
    Gets a property's value as a Blob. Returns null if the value doesn't exist, or its value is not a Blob.
    
    Overrides:
    
    getBlob in class ReadOnlyDictionary
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the Blob value or null.
  - getDate
```
public Date getDate(String key)
```
    Gets a property's value as a Date. JSON does not directly support dates, so the actual property value must be a string, which is then parsed according to the ISO-8601 date format (the default used in JSON.) Returns null if the value doesn't exist, is not a string, or is not parseable as a date. NOTE: This is not a generic date parser! It only recognizes the ISO-8601 format, with or without milliseconds.
    
    Overrides:
    
    getDate in class ReadOnlyDictionary
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the Date value or null.
  - toMap
```
public Map<String,Object> toMap()
```
    Gets content of the current object as an Map. The values contained in the returned Map object are all JSON based values.
    
    Overrides:
    
    toMap in class ReadOnlyDictionary
    
    Returns:
    
    the Map object representing the content of the current object in the JSON format.
  - contains
```
public boolean contains(String key)
```
    Tests whether a property exists or not. This can be less expensive than getObject(String), because it does not have to allocate an Object for the property value.
    
    Overrides:
    
    contains in class ReadOnlyDictionary
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the boolean value representing whether a property exists or not.
  - setC4Doc
```
protected void setC4Doc(com.couchbase.lite.CBLC4Doc c4doc)
```
    Overrides:
    
    setC4Doc in class ReadOnlyDocument

Class Document

Constructor Summary

Method Summary

Methods inherited from class com.couchbase.lite.ReadOnlyDocument

Methods inherited from class com.couchbase.lite.ReadOnlyDictionary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Document

Document

Document

Document

Method Detail

set

setObject

setString

setNumber

setInt

setLong

setFloat

setDouble

setBoolean

setBlob

setDate

setArray

setDictionary

remove

getArray

getDictionary

count

getKeys

getObject

getString

getNumber

getInt

getLong

getFloat

getDouble

getBoolean

getBlob

getDate

toMap

contains

setC4Doc