Document (Couchbase Lite 2.0.0-299)

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

All Implemented Interfaces:

Iterable<String>

Direct Known Subclasses:

MutableDocument
```
public class Document
extends Object
implements Iterable<String>
```
Readonly version of the Document.

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.
`boolean`	`equals(Object o)`
`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 a 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.
`String`	`getId()` return the document's ID.
`int`	`getInt(String key)` Gets a property's value as an int.
`List<String>`	`getKeys()` Get an List containing all keys, or an empty List if the document has no properties.
`long`	`getLong(String key)` Gets a property's value as an long.
`Number`	`getNumber(String key)` Gets a property's value as a Number.
`long`	`getSequence()` Return the sequence number of the document in the database.
`String`	`getString(String key)` Gets a property's value as a String.
`Object`	`getValue(String key)` Gets a property's value as an object.
`int`	`hashCode()`
`boolean`	`isDeleted()` Return whether the document is deleted
`Iterator<String>`	`iterator()` Gets an iterator over the keys of the document's properties
`Map<String,Object>`	`toMap()` Gets content of the current object as an Map.
`MutableDocument`	`toMutable()` Return a mutable copy of the document

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

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

- Method Detail
  - getId
```
public String getId()
```
    return the document's ID.
    
    Returns:
    
    the document's ID
  - getSequence
```
public long getSequence()
```
    Return the sequence number of the document in the database. This indicates how recently the document has been changed: every time any document is updated, the database assigns it the next sequential sequence number. Thus, if a document's `sequence` property changes that means it's been changed (on-disk); and if one document's `sequence` is greater than another's, that means it was changed more recently.
    
    Returns:
    
    the sequence number of the document in the database.
  - isDeleted
```
public boolean isDeleted()
```
    Return whether the document is deleted
    
    Returns:
    
    true if deleted, false otherwise
  - toMutable
```
public MutableDocument toMutable()
```
    Return a mutable copy of the document
    
    Returns:
    
    the MutableDocument instance
  - count
```
public int count()
```
    Gets a number of the entries in the dictionary.
    
    Returns:
  - getKeys
```
public List<String> getKeys()
```
    Get an List containing all keys, or an empty List if the document has no properties.
    
    Returns:
    
    all keys
  - getValue
```
public Object getValue(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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the Date value or null.
  - 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.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    The Array object or null.
  - getDictionary
```
public Dictionary getDictionary(String key)
```
    Get a property's value as a Dictionary, which is a mapping object of a Dictionary value. Returns null if the property doesn't exists, or its value is not a Dictionary.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    The Dictionary object 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.
    
    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 getValue(String), because it does not have to allocate an Object for the property value.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the boolean value representing whether a property exists or not.
  - iterator
```
public Iterator<String> iterator()
```
    Gets an iterator over the keys of the document's properties
    
    Specified by:
    
    iterator in interface Iterable<String>
    
    Returns:
    
    The key iterator
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Document

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

getId

getSequence

isDeleted

toMutable

count

getKeys

getValue

getString

getNumber

getInt

getLong

getFloat

getDouble

getBoolean

getBlob

getDate

getArray

getDictionary

toMap

contains

iterator

equals

hashCode