com.cloudant.sync.datastore

Class DocumentRevisionBuilder

java.lang.Object

com.cloudant.sync.datastore.DocumentRevisionBuilder

public class DocumentRevisionBuilder
extends java.lang.Object

Build DocumentRevisions in a chained manner.

Constructor Summary

Constructors

Constructor and Description
DocumentRevisionBuilder()

Method Summary

Modifier and Type	Method and Description
BasicDocumentRevision	build() Builds and returns the BasicDocumentRevision for this builder.
BasicDocumentRevision	buildLocalDocument() Builds and returns the DocumentRevision for this builder, as a local document.
MutableDocumentRevision	buildMutable() Builds and returns the MutableDocumentRevision for this builder.
ProjectedDocumentRevision	buildProjected() Builds and returns the ProjectedDocumentRevision for this builder.
static BasicDocumentRevision	buildRevisionFromMap(java.net.URI documentURI, java.util.Map<java.lang.String,? extends java.lang.Object> map) Builds a BasicDocumentRevision from a Map of values from a CouchDB instance
BasicDocumentRevision	buildStub() Builds and returns the stub DocumentRevision for this builder.
DocumentRevisionBuilder	setAttachments(java.util.List<? extends Attachment> attachments) Sets the attachments associated with the document for this builder.
DocumentRevisionBuilder	setBody(DocumentBody body) Sets the document body for this builder.
DocumentRevisionBuilder	setCurrent(boolean current) Sets whether this builder is creating the winning revision.
DocumentRevisionBuilder	setDatastore(Datastore datastore) Sets the datastore for this builder.
DocumentRevisionBuilder	setDeleted(boolean deleted) Sets whether this builder is creating a deleted revsion.
DocumentRevisionBuilder	setDocId(java.lang.String docId) Sets the document ID for this builder.
DocumentRevisionBuilder	setInternalId(long internalId) Sets the internal ID for this builder.
DocumentRevisionBuilder	setParent(long parent) Sets the parent sequence number for this builder.
DocumentRevisionBuilder	setRevId(java.lang.String revId) Sets the revision ID for this builder.
DocumentRevisionBuilder	setSequence(long sequence) Sets the sequence number for this builder.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentRevisionBuilder

public DocumentRevisionBuilder()

Method Detail

build

public BasicDocumentRevision build()

Builds and returns the BasicDocumentRevision for this builder.

Returns:

the BasicDocumentRevision for this builder

buildLocalDocument

public BasicDocumentRevision buildLocalDocument()

Builds and returns the DocumentRevision for this builder, as a local document.

Returns:

the DocumentRevision for this builder as a local document

buildStub

public BasicDocumentRevision buildStub()

Builds and returns the stub DocumentRevision for this builder.

A "stub" object has document and revision IDs, but no content/body.

Returns:

the stub DocumentRevision for this builder

setDocId

public DocumentRevisionBuilder setDocId(java.lang.String docId)

Sets the document ID for this builder.

Parameters:

docId - document ID

Returns:

the builder object for chained calls

setRevId

public DocumentRevisionBuilder setRevId(java.lang.String revId)

Sets the revision ID for this builder.

Parameters:

revId - revision ID

Returns:

the builder object for chained calls

setBody

public DocumentRevisionBuilder setBody(DocumentBody body)

Sets the document body for this builder.

Parameters:

body - document revision body

Returns:

the builder object for chained calls

setCurrent

public DocumentRevisionBuilder setCurrent(boolean current)

Sets whether this builder is creating the winning revision.

Parameters:

current - whether this document revision is the winning revision

Returns:

the builder object for chained calls

setDeleted

public DocumentRevisionBuilder setDeleted(boolean deleted)

Sets whether this builder is creating a deleted revsion.

Parameters:

deleted - whether this revision is deleted

Returns:

the builder object for chained calls

setInternalId

public DocumentRevisionBuilder setInternalId(long internalId)

Sets the internal ID for this builder.

Parameters:

internalId - revision internal ID

Returns:

the builder object for chained calls

setSequence

public DocumentRevisionBuilder setSequence(long sequence)

Sets the sequence number for this builder.

Parameters:

sequence - sequence number

Returns:

the builder object for chained calls

setParent

public DocumentRevisionBuilder setParent(long parent)

Sets the parent sequence number for this builder.

Parameters:

parent - parent sequence number

Returns:

the builder object for chained calls

setAttachments

public DocumentRevisionBuilder setAttachments(java.util.List<? extends Attachment> attachments)

Sets the attachments associated with the document for this builder.

Parameters:

attachments - list of attachments associated with the document

Returns:

the builder object for chained calls

setDatastore

public DocumentRevisionBuilder setDatastore(Datastore datastore)

Sets the datastore for this builder.

Parameters:

datastore - the datastore

Returns:

the builder object for chained calls

buildMutable

public MutableDocumentRevision buildMutable()

Builds and returns the MutableDocumentRevision for this builder.

Returns:

MutableDocumentRevision for this builder.

buildProjected

public ProjectedDocumentRevision buildProjected()

Builds and returns the ProjectedDocumentRevision for this builder.

Returns:

ProjectedDocumentRevision for this builder.

buildRevisionFromMap

public static BasicDocumentRevision buildRevisionFromMap(java.net.URI documentURI,
                                                         java.util.Map<java.lang.String,? extends java.lang.Object> map)
                                                  throws java.io.IOException

Builds a BasicDocumentRevision from a Map of values from a CouchDB instance

Parameters:

documentURI - The URI of the document

map - The map of key value pairs fom the CouchDB server

Returns:

A complete document revision representing the data from the Map

Throws:

java.io.IOException - If attachments fail to be decoded correctly.