com.couchbase.lite

Class UnsavedRevision

java.lang.Object

com.couchbase.lite.Revision

com.couchbase.lite.UnsavedRevision

public final class UnsavedRevision
extends Revision

An unsaved Couchbase Lite Document Revision.

Field Summary

Fields inherited from class com.couchbase.lite.Revision

document, parentRevID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UnsavedRevision(Document document, SavedRevision parentRevision) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	addAttachment(Attachment attachment, java.lang.String name) Creates or updates an attachment.
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.
protected long	getParentSequence()
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.
protected long	getSequence()
void	removeAttachment(java.lang.String name) Deletes any existing attachment with the given name.
SavedRevision	save() Saves the new revision to the database.
SavedRevision	save(boolean allowConflict) A special variant of -save: that always adds the revision, even if its parent is not the current revision of the document.
void	setAttachment(java.lang.String name, java.lang.String contentType, java.io.InputStream contentStream) Sets the attachment with the given name.
void	setAttachment(java.lang.String name, java.lang.String contentType, java.net.URL contentStreamURL) Sets the attachment with the given name.
void	setIsDeletion(boolean isDeletion) Set whether this revision is a deletion or not (eg, marks doc as deleted)
void	setProperties(java.util.Map<java.lang.String,java.lang.Object> properties) Set the properties for this revision
void	setUserProperties(java.util.Map<java.lang.String,java.lang.Object> userProperties) Sets the userProperties of the Revision.

Methods inherited from class com.couchbase.lite.Revision

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

Methods inherited from class java.lang.Object

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

Constructor Detail

UnsavedRevision

protected UnsavedRevision(Document document,
                          SavedRevision parentRevision)

Constructor

Method Detail

setIsDeletion

public void setIsDeletion(boolean isDeletion)

Set whether this revision is a deletion or not (eg, marks doc as deleted)

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

getSequence

protected long getSequence()

Specified by:

getSequence in class Revision

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.Object> properties)

Set the properties for this revision

save

public SavedRevision save()
                   throws CouchbaseLiteException

Saves the new revision to the database.

This will throw an exception with a 412 error if its parent (the revision it was created from) is not the current revision of the document.

Afterwards you should use the returned Revision instead of this object.

Returns:

A new Revision representing the saved form of the revision.

Throws:

CouchbaseLiteException

save

public SavedRevision save(boolean allowConflict)
                   throws CouchbaseLiteException

A special variant of -save: that always adds the revision, even if its parent is not the current revision of the document.

This can be used to resolve conflicts, or to create them. If you're not certain that's what you want to do, you should use the regular -save: method instead.

Throws:

CouchbaseLiteException

removeAttachment

public void removeAttachment(java.lang.String name)

Deletes any existing attachment with the given name. The attachment will be deleted from the database when the revision is saved.

Parameters:

name - The attachment name.

setUserProperties

public void setUserProperties(java.util.Map<java.lang.String,java.lang.Object> userProperties)

Sets the userProperties of the Revision. Set replaces all properties except for those with keys prefixed with '_'.

setAttachment

public void setAttachment(java.lang.String name,
                          java.lang.String contentType,
                          java.io.InputStream contentStream)

Sets the attachment with the given name. The Attachment data will be written to the Database when the Revision is saved.

Parameters:

name - The name of the Attachment to set.

contentType - The content-type of the Attachment.

contentStream - The Attachment content. The InputStream will be closed after it is no longer needed.

setAttachment

public void setAttachment(java.lang.String name,
                          java.lang.String contentType,
                          java.net.URL contentStreamURL)

Sets the attachment with the given name. The Attachment data will be written to the Database when the Revision is saved.

Parameters:

name - The name of the Attachment to set.

contentType - The content-type of the Attachment.

contentStreamURL - The URL that contains the Attachment content.

getProperties

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

Description copied from class: Revision

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.

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

getParentSequence

protected long getParentSequence()

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

addAttachment

protected void addAttachment(Attachment attachment,
                             java.lang.String name)

Creates or updates an attachment. The attachment data will be written to the database when the revision is saved.

Parameters:

attachment - A newly-created Attachment (not yet associated with any revision)

name - The attachment name.