com.cloudant.sync.datastore

Class BasicDocumentRevision

java.lang.Object

com.cloudant.sync.datastore.BasicDocumentRevision

All Implemented Interfaces:

DocumentRevision, java.lang.Comparable<BasicDocumentRevision>

Direct Known Subclasses:

ProjectedDocumentRevision

public class BasicDocumentRevision
extends java.lang.Object
implements DocumentRevision, java.lang.Comparable<BasicDocumentRevision>

Revision of a document.

Method Summary

Modifier and Type	Method and Description
byte[]	asBytes() Returns the JSON body of the document revision as a byte array.
java.util.Map<java.lang.String,java.lang.Object>	asMap() Returns the JSON body of the document revision as a Map object.
int	compareTo(BasicDocumentRevision o)
boolean	equals(java.lang.Object that)
java.util.Map<java.lang.String,Attachment>	getAttachments()
DocumentBody	getBody()
int	getGeneration()
java.lang.String	getId()
long	getParent() Returns the sequence number of this revision's parent revision.
java.lang.String	getRevision()
long	getSequence() Returns the sequence number of this revision.
int	hashCode()
void	initialiseSequence(long sequence)
boolean	isCurrent()
boolean	isDeleted()
MutableDocumentRevision	mutableCopy() Return a mutable copy of this DocumentRevision.
void	setDeleted(boolean deleted)
void	setId(java.lang.String id)
void	setRevision(java.lang.String revision)
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface DocumentRevision

Returns:

the unique identifier of the document

setId

public void setId(java.lang.String id)

getRevision

public java.lang.String getRevision()

Specified by:

getRevision in interface DocumentRevision

Returns:

the revision ID of this document revision

setRevision

public void setRevision(java.lang.String revision)

getBody

public DocumentBody getBody()

Specified by:

getBody in interface DocumentRevision

Returns:

the DocumentBody of the document

isCurrent

public boolean isCurrent()

Returns:

true if this revision is the current winner for the document.

getParent

public long getParent()

Returns the sequence number of this revision's parent revision.

If this number is less than or equal to zero, it means this revision is the root of a document tree. A document may have more than one tree, under certain circumstances, such as two documents with the same ID being created in different datastores that are later replicated across.

Returns:

the sequence number of this revision's parent revision.

asMap

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

Returns the JSON body of the document revision as a Map object.

This Map includes reserved fields such as _id and _rev. Changing the byte array may affect the DocumentRevision, as only a shallow copy is returned.

Returns:

the JSON body of the document revision as a Map object.

asBytes

public byte[] asBytes()

Returns the JSON body of the document revision as a byte array.

This byte array includes reserved fields such as _id and _rev. Changing the byte array does not affect the document revisions contents.

Returns:

the JSON body of the document revision as a byte array.

isDeleted

public boolean isDeleted()

Returns:

true if this revision is marked deleted.

setDeleted

public void setDeleted(boolean deleted)

getSequence

public long getSequence()

Returns the sequence number of this revision.

The sequence number is unique across the database, it is updated for every modification to the datastore.

Returns:

the sequence number of this revision.

initialiseSequence

public void initialiseSequence(long sequence)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getGeneration

public int getGeneration()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object that)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(BasicDocumentRevision o)

Specified by:

compareTo in interface java.lang.Comparable<BasicDocumentRevision>

mutableCopy

public MutableDocumentRevision mutableCopy()

Return a mutable copy of this DocumentRevision.

The mutable copy can be used to change the body and attachments.

Mutable copies can be created or updated in the datastore by calling the appropriate methods on the Datastore

.

Returns:

a mutable copy of the document revision

See Also:

Datastore.createDocumentFromRevision(MutableDocumentRevision), Datastore.updateDocumentFromRevision(MutableDocumentRevision)

getAttachments

public java.util.Map<java.lang.String,Attachment> getAttachments()

Specified by:

getAttachments in interface DocumentRevision