com.couchbase.lite

Class SavedRevision

java.lang.Object

com.couchbase.lite.Revision

com.couchbase.lite.SavedRevision

public final class SavedRevision
extends Revision

Stores information about a revision -- its docID, revID, and whether it's deleted. It can also store the sequence number and document contents (they can be added after creation).

Field Summary

Fields inherited from class com.couchbase.lite.Revision

document

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SavedRevision(Database database, RevisionInternal revision) Constructor
protected	SavedRevision(Database database, RevisionInternal revision, java.lang.String parentRevID) Constructor - (instancetype) initForValidationWithDatabase: (CBLDatabase*)db revision: (CBL_Revision*)rev parentRevisionID: (NSString*)parentRevID
protected	SavedRevision(Document document, RevisionInternal revision) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	arePropertiesAvailable() Has this object fetched its contents from the database yet?
UnsavedRevision	createRevision() Creates a new mutable child revision whose properties and attachments are initially identical to this one's, which you can modify and then save.
SavedRevision	createRevision(java.util.Map<java.lang.String,java.lang.Object> properties) Creates and saves a new revision with the given properties.
SavedRevision	deleteDocument() Deletes the document by creating a new deletion-marker revision.
Document	getDocument() Get the document this is a revision of
java.lang.String	getId() Gets the Revision's id.
SavedRevision	getParent() Gets the parent Revision.
java.lang.String	getParentId() Gets the parent Revision's id.
java.util.Map<java.lang.String,java.lang.Object>	getProperties() The contents of this revision of the document.
java.util.List<SavedRevision>	getRevisionHistory() Returns the history of this document as an array of CBLRevisions, in forward order.
long	getSequence()
boolean	isDeletion() Does this revision mark the deletion of its document? (In other words, does it have a "_deleted" property?)
protected boolean	loadProperties()

Methods inherited from class com.couchbase.lite.Revision

equals, generationFromRevID, getAttachment, getAttachmentMetadata, getAttachmentNames, getAttachments, getDatabase, getGeneration, getProperty, getUserProperties, hashCode, isGone, setParentRevisionID, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SavedRevision

protected SavedRevision(Document document,
                        RevisionInternal revision)

Constructor

SavedRevision

protected SavedRevision(Database database,
                        RevisionInternal revision)

Constructor

SavedRevision

protected SavedRevision(Database database,
                        RevisionInternal revision,
                        java.lang.String parentRevID)

Constructor - (instancetype) initForValidationWithDatabase: (CBLDatabase*)db revision: (CBL_Revision*)rev parentRevisionID: (NSString*)parentRevID

Method Detail

getDocument

public Document getDocument()

Get the document this is a revision of

Overrides:

getDocument in class Revision

arePropertiesAvailable

public boolean arePropertiesAvailable()

Has this object fetched its contents from the database yet?

getRevisionHistory

public java.util.List<SavedRevision> getRevisionHistory()
                                                 throws CouchbaseLiteException

Description copied from class: Revision

Returns the history of this document as an array of CBLRevisions, in forward order. Older revisions are NOT guaranteed to have their properties available.

Specified by:

getRevisionHistory in class Revision

Throws:

CouchbaseLiteException

createRevision

public UnsavedRevision createRevision()

Creates a new mutable child revision whose properties and attachments are initially identical to this one's, which you can modify and then save.

createRevision

public SavedRevision createRevision(java.util.Map<java.lang.String,java.lang.Object> properties)
                             throws CouchbaseLiteException

Creates and saves a new revision with the given properties. This will fail with a 412 error if the receiver is not the current revision of the document.

Throws:

CouchbaseLiteException

getId

public java.lang.String getId()

Description copied from class: Revision

Gets the Revision's id. In the case of an unsaved revision, may return null.

Specified by:

getId in class Revision

isDeletion

public boolean isDeletion()

Description copied from class: Revision

Does this revision mark the deletion of its document? (In other words, does it have a "_deleted" property?)

Overrides:

isDeletion in class Revision

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

The contents of this revision of the document. Any keys in the dictionary that begin with "_", such as "_id" and "_rev", contain CouchbaseLite metadata.

Specified by:

getProperties in class Revision

Returns:

contents of this revision of the document.

deleteDocument

public SavedRevision deleteDocument()
                             throws CouchbaseLiteException

Deletes the document by creating a new deletion-marker revision.

Returns:

Throws:

CouchbaseLiteException

getParent

public SavedRevision getParent()

Description copied from class: Revision

Gets the parent Revision.

Specified by:

getParent in class Revision

getParentId

public java.lang.String getParentId()

Description copied from class: Revision

Gets the parent Revision's id.

Specified by:

getParentId in class Revision

getSequence

public long getSequence()

Specified by:

getSequence in class Revision

loadProperties

protected boolean loadProperties()