RevisionVector (Jackrabbit Oak 1.27-SNAPSHOT API)

java.lang.Object
- org.apache.jackrabbit.oak.plugins.document.RevisionVector

All Implemented Interfaces:

Comparable<RevisionVector>, Iterable<Revision>, CacheValue
```
public final class RevisionVector
extends Object
implements Iterable<Revision>, Comparable<RevisionVector>, CacheValue
```
A vector of revisions. Instances of this class are immutable and methods like update(Revision) create a new instance as needed. This class implements Comparable. While compareTo(RevisionVector) provides a total order of revision vector instances, this order is unrelated to when changes are visible in a DocumentNodeStore cluster. Do not use this method to determine whether a given revision vector happened before or after another!

Constructor Summary

Constructors
Constructor and Description
`RevisionVector(@NotNull Iterable<Revision> revisions)`
`RevisionVector(Revision... revisions)`
`RevisionVector(@NotNull Set<Revision> revisions)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RevisionVector`	`asBranchRevision(int clusterId)` A clone of this revision vector with the revision for the given clusterId set to a branch revision.
`String`	`asString()` Returns a string representation of this revision vector, which can be parsed again by `fromString(String)`.
`RevisionVector`	`asTrunkRevision()` Returns a revision vector where all revision elements are turned into trunk revisions.
`int`	`compareTo(@NotNull RevisionVector other)`
`RevisionVector`	`difference(RevisionVector vector)` Returns the difference of this and the other vector.
`boolean`	`equals(Object o)`
`static RevisionVector`	`fromString(String s)` Creates a revision vector from a string representation as returned by `asString()`.
`@NotNull Revision`	`getBranchRevision()`
`int`	`getDimensions()` Returns the dimensions of this revision vector.
`int`	`getMemory()` The estimated amount of memory used by this object, in bytes.
`Revision`	`getRevision(int clusterId)` Returns the revision element with the given clusterId or `null` if there is no such revision in this vector.
`int`	`hashCode()`
`boolean`	`isBranch()`
`boolean`	`isRevisionNewer(@NotNull Revision revision)` Returns `true` if the given revision is newer than the revision element with the same clusterId in the vector.
`Iterator<Revision>`	`iterator()`
`RevisionVector`	`pmax(@NotNull RevisionVector vector)` Calculates the parallel maximum of this and the given `vector`.
`RevisionVector`	`pmin(@NotNull RevisionVector vector)` Calculates the parallel minimum of this and the given `vector`.
`RevisionVector`	`remove(int clusterId)` Returns a RevisionVector without the revision element with the given `clusterId`.
`String`	`toString()`
`StringBuilder`	`toStringBuilder(StringBuilder sb)` Appends the string representation of this revision vector to the passed `StringBuilder`.
`RevisionVector`	`update(@NotNull Revision revision)` Creates a new revision vector with based on this vector and the given `revision`.

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - RevisionVector
```
public RevisionVector(@NotNull
                      Revision... revisions)
```
  - RevisionVector
```
public RevisionVector(@NotNull
                      @NotNull Iterable<Revision> revisions)
```
  - RevisionVector
```
public RevisionVector(@NotNull
                      @NotNull Set<Revision> revisions)
```
- Method Detail
  - update
```
public RevisionVector update(@NotNull
                             @NotNull Revision revision)
```
    Creates a new revision vector with based on this vector and the given revision. If this vector contains a revision with the same clusterId as revision, the returned vector will have the revision updated with the given one. Otherwise the returned vector will have all elements of this vector plus the given revision.
    
    Parameters:
    
    revision - the revision set to use for the new vector.
    
    Returns:
    
    the resulting revision vector.
  - remove
```
public RevisionVector remove(int clusterId)
```
    Returns a RevisionVector without the revision element with the given clusterId.
    
    Parameters:
    
    clusterId - the clusterId of the revision to remove.
    
    Returns:
    
    RevisionVector without the revision element.
  - pmin
```
public RevisionVector pmin(@NotNull
                           @NotNull RevisionVector vector)
```
    Calculates the parallel minimum of this and the given vector.
    
    Parameters:
    
    vector - the other vector.
    
    Returns:
    
    the parallel minimum of the two.
  - pmax
```
public RevisionVector pmax(@NotNull
                           @NotNull RevisionVector vector)
```
    Calculates the parallel maximum of this and the given vector.
    
    Parameters:
    
    vector - the other vector.
    
    Returns:
    
    the parallel maximum of the two.
  - difference
```
public RevisionVector difference(RevisionVector vector)
```
    Returns the difference of this and the other vector. The returned vector contains all revisions of this vector that are not contained in the other vector.
    
    Parameters:
    
    vector - the other vector.
    
    Returns:
    
    the difference of the two vectors.
  - isRevisionNewer
```
public boolean isRevisionNewer(@NotNull
                               @NotNull Revision revision)
```
    Returns true if the given revision is newer than the revision element with the same clusterId in the vector. The given revision is also considered newer if there is no revision element with the same clusterId in this vector.
    
    Parameters:
    
    revision - the revision to check.
    
    Returns:
    
    true if considered newer, false otherwise.
  - isBranch
```
public boolean isBranch()
```
    Returns:
    
    true if any of the revisions in this vector is a branch revision, false otherwise.
  - getBranchRevision
```
@NotNull
public @NotNull Revision getBranchRevision()
```
    Returns:
    
    the first branch revision in this vector.
    
    Throws:
    
    IllegalStateException - if this vector does not contain a branch revision.
  - getRevision
```
public Revision getRevision(int clusterId)
```
    Returns the revision element with the given clusterId or null if there is no such revision in this vector.
    
    Parameters:
    
    clusterId - a clusterId.
    
    Returns:
    
    the revision element with the given clusterId or null if none exists.
  - asString
```
public String asString()
```
    Returns a string representation of this revision vector, which can be parsed again by fromString(String).
    
    Returns:
    
    a string representation of this revision vector.
  - toStringBuilder
```
public StringBuilder toStringBuilder(StringBuilder sb)
```
    Appends the string representation of this revision vector to the passed StringBuilder. The string representation is the same as returned by asString().
    
    Parameters:
    
    sb - the StringBuilder this revision vector is appended to.
    
    Returns:
    
    the passed StringBuilder object.
  - fromString
```
public static RevisionVector fromString(String s)
```
    Creates a revision vector from a string representation as returned by asString().
    
    Parameters:
    
    s - the string representation of a revision vector.
    
    Returns:
    
    the revision vector.
    
    Throws:
    
    IllegalArgumentException - if the string is malformed
  - asTrunkRevision
```
public RevisionVector asTrunkRevision()
```
    Returns a revision vector where all revision elements are turned into trunk revisions.
    
    Returns:
    
    a trunk representation of this revision vector.
  - asBranchRevision
```
public RevisionVector asBranchRevision(int clusterId)
```
    A clone of this revision vector with the revision for the given clusterId set to a branch revision.
    
    Parameters:
    
    clusterId - the clusterId of the revision to be turned into a branch revision.
    
    Returns:
    
    the revision vector with the branch revision.
    
    Throws:
    
    IllegalArgumentException - if there is no revision element with the given clusterId.
  - getDimensions
```
public int getDimensions()
```
    Returns the dimensions of this revision vector. That is, the number of revision elements in this vector.
    
    Returns:
    
    the number of revision elements in this vector.
  - getMemory
```
public int getMemory()
```
    Description copied from interface: CacheValue
    
    The estimated amount of memory used by this object, in bytes.
    
    Specified by:
    
    getMemory in interface CacheValue
    
    Returns:
    
    the estimated number of bytes
  - compareTo
```
public int compareTo(@NotNull
                     @NotNull RevisionVector other)
```
    Specified by:
    
    compareTo in interface Comparable<RevisionVector>
  - iterator
```
public Iterator<Revision> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Revision>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class RevisionVector

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

RevisionVector

RevisionVector

RevisionVector

Method Detail

update

remove

pmin

pmax

difference

isRevisionNewer

isBranch

getBranchRevision

getRevision

asString

toStringBuilder

fromString

asTrunkRevision

asBranchRevision

getDimensions

getMemory

compareTo

iterator

toString

equals

hashCode