Revision (couchbase-lite-java-core API)

java.lang.Object
- com.couchbase.lite.Revision

Direct Known Subclasses:

SavedRevision, UnsavedRevision
```
public abstract class Revision
extends java.lang.Object
```
A Couchbase Lite Document 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
Modifier and Type Field and Description

protected Document document
The document this is a revision of

protected java.lang.String parentRevID
The ID of the parentRevision.

Fields
Modifier and Type	Field and Description
`protected Document`	`document` The document this is a revision of
`protected java.lang.String`	`parentRevID` The ID of the parentRevision.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Revision(Document document)
Constructor

Constructors
Modifier	Constructor and Description
`protected`	`Revision(Document document)` Constructor

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)` Compare this revision to the given revision to check for equality.
`static int`	`generationFromRevID(java.lang.String revID)`
`Attachment`	`getAttachment(java.lang.String name)` Looks up the attachment with the given name (without fetching its contents yet).
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getAttachmentMetadata()`
`java.util.List<java.lang.String>`	`getAttachmentNames()` The names of all attachments
`java.util.List<Attachment>`	`getAttachments()` All attachments, as Attachment objects.
`Database`	`getDatabase()` Get the revision's owning database.
`Document`	`getDocument()` Get the document this is a revision of.
`protected int`	`getGeneration()` Generation number: 1 for a new document, 2 for the 2nd revision, ...
`abstract java.lang.String`	`getId()` Gets the Revision's id.
`abstract SavedRevision`	`getParent()` Gets the parent Revision.
`abstract java.lang.String`	`getParentId()` Gets the parent Revision's id.
`abstract java.util.Map<java.lang.String,java.lang.Object>`	`getProperties()` The contents of this revision of the document.
`java.lang.Object`	`getProperty(java.lang.String key)` Shorthand for getProperties().get(key)
`abstract java.util.List<SavedRevision>`	`getRevisionHistory()` Returns the history of this document as an array of CBLRevisions, in forward order.
`protected abstract long`	`getSequence()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getUserProperties()` The user-defined properties, without the ones reserved by CouchDB.
`int`	`hashCode()` Custom hashCode based on the hash code of the Document Id and the Revision Id
`boolean`	`isDeletion()` Does this revision mark the deletion of its document? (In other words, does it have a "_deleted" property?)
`boolean`	`isGone()` Does this revision mark the deletion or removal (from available channels) of its document? (In other words, does it have a "_deleted_ or "_removed" property?)
`protected void`	`setParentRevisionID(java.lang.String parentRevID)`
`java.lang.String`	`toString()` Returns a string representation of this Revision, including the Document Id, the Revision Id and whether or not this Revision is a deletion.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - document
```
protected Document document
```
    The document this is a revision of
  - parentRevID
```
protected java.lang.String parentRevID
```
    The ID of the parentRevision.
- Constructor Detail
  - Revision
```
protected Revision(Document document)
```
    Constructor
- Method Detail
  - getDatabase
```
public Database getDatabase()
```
    Get the revision's owning database.
  - getDocument
```
public Document getDocument()
```
    Get the document this is a revision of.
  - getId
```
public abstract java.lang.String getId()
```
    Gets the Revision's id. In the case of an unsaved revision, may return null.
  - isDeletion
```
public boolean isDeletion()
```
    Does this revision mark the deletion of its document? (In other words, does it have a "_deleted" property?)
  - getProperties
```
public abstract 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.
    
    Returns:
    
    contents of this revision of the document.
  - getUserProperties
```
public java.util.Map<java.lang.String,java.lang.Object> getUserProperties()
```
    The user-defined properties, without the ones reserved by CouchDB. This is based on -properties, with every key whose name starts with "_" removed.
    
    Returns:
    
    user-defined properties, without the ones reserved by CouchDB.
  - getAttachmentNames
```
public java.util.List<java.lang.String> getAttachmentNames()
```
    The names of all attachments
  - getAttachments
```
public java.util.List<Attachment> getAttachments()
```
    All attachments, as Attachment objects.
  - getProperty
```
public java.lang.Object getProperty(java.lang.String key)
```
    Shorthand for getProperties().get(key)
  - getAttachment
```
public Attachment getAttachment(java.lang.String name)
```
    Looks up the attachment with the given name (without fetching its contents yet).
  - getParent
```
public abstract SavedRevision getParent()
```
    Gets the parent Revision.
  - getParentId
```
public abstract java.lang.String getParentId()
```
    Gets the parent Revision's id.
  - getRevisionHistory
```
public abstract java.util.List<SavedRevision> getRevisionHistory()
                                                          throws CouchbaseLiteException
```
    Returns the history of this document as an array of CBLRevisions, in forward order. Older revisions are NOT guaranteed to have their properties available.
    
    Throws:
    
    CouchbaseLiteException
  - isGone
```
public boolean isGone()
```
    Does this revision mark the deletion or removal (from available channels) of its document? (In other words, does it have a "_deleted_ or "_removed" property?)
  - equals
```
public boolean equals(java.lang.Object o)
```
    Compare this revision to the given revision to check for equality. The comparison makes sure that both revisions have the same revision ID.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    o - the revision to check for equality against
    
    Returns:
    
    true if equal, false otherwise
  - hashCode
```
public int hashCode()
```
    Custom hashCode based on the hash code of the Document Id and the Revision Id
    
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this Revision, including the Document Id, the Revision Id and whether or not this Revision is a deletion.
    
    Overrides:
    
    toString in class java.lang.Object
  - getAttachmentMetadata
```
protected java.util.Map<java.lang.String,java.lang.Object> getAttachmentMetadata()
```
  - setParentRevisionID
```
protected void setParentRevisionID(java.lang.String parentRevID)
```
  - getSequence
```
protected abstract long getSequence()
```
  - getGeneration
```
protected int getGeneration()
```
    Generation number: 1 for a new document, 2 for the 2nd revision, ... Extracted from the numeric prefix of the revID.
  - generationFromRevID
```
public static int generationFromRevID(java.lang.String revID)
```

Class Revision

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

document

parentRevID

Constructor Detail

Revision

Method Detail

getDatabase

getDocument

getId

isDeletion

getProperties

getUserProperties

getAttachmentNames

getAttachments

getProperty

getAttachment

getParent

getParentId

getRevisionHistory

isGone

equals

hashCode

toString

getAttachmentMetadata

setParentRevisionID

getSequence

getGeneration

generationFromRevID