com.couchbase.lite

Class ReadOnlyDocument

java.lang.Object

com.couchbase.lite.ReadOnlyDictionary

com.couchbase.lite.ReadOnlyDocument

Direct Known Subclasses:

Document

public class ReadOnlyDocument
extends ReadOnlyDictionary

Readonly version of the Document.

Method Summary

Modifier and Type	Method and Description
String	getId() return the document's ID.
long	getSequence() Return the sequence number of the document in the database.
boolean	isDeleted() Return whether the document is deleted
protected void	setC4Doc(com.couchbase.lite.CBLC4Doc c4doc)
String	toString()

Methods inherited from class com.couchbase.lite.ReadOnlyDictionary

contains, count, fleeceEncode, getArray, getBlob, getBoolean, getData, getDate, getDictionary, getDouble, getFloat, getInt, getKeys, getLong, getNumber, getObject, getString, iterator, setData, toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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

toString

public String toString()

Overrides:

toString in class Object

setC4Doc

protected void setC4Doc(com.couchbase.lite.CBLC4Doc c4doc)
                 throws CouchbaseLiteException

Throws:

CouchbaseLiteException