org.lightcouch

Class Document

java.lang.Object

org.lightcouch.Document

Direct Known Subclasses:

DesignDocument, ReplicatorDocument

public class Document
extends java.lang.Object

Convenient base class for CouchDB documents, defines the basic id, revision properties, and attachments.

Since:

0.0.2

Author:

Ahmed Yehia

Constructor Summary

Constructors

Constructor and Description
Document()
Document(Document other) Copy contructor that does a deep copy

Method Summary

Modifier and Type	Method and Description
void	addAttachment(java.lang.String name, Attachment attachment) Adds an in-line document attachment.
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,Attachment>	getAttachments()
java.lang.String	getId()
java.lang.String	getRevision()
int	hashCode()
void	setAttachments(java.util.Map<java.lang.String,Attachment> attachments)
void	setId(java.lang.String id)
void	setRevision(java.lang.String revision)

Methods inherited from class java.lang.Object

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

Constructor Detail

Document

public Document()

Document

public Document(Document other)

Copy contructor that does a deep copy

Parameters:

other - The document to copy.

Method Detail

getId

public java.lang.String getId()

getRevision

public java.lang.String getRevision()

getAttachments

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

setId

public void setId(java.lang.String id)

setRevision

public void setRevision(java.lang.String revision)

setAttachments

public void setAttachments(java.util.Map<java.lang.String,Attachment> attachments)

addAttachment

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

Adds an in-line document attachment.

Parameters:

name - The attachment file name

attachment - The attachment instance

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object