org.apache.jackrabbit.oak.plugins.document

Class LocalDiffCache

java.lang.Object

org.apache.jackrabbit.oak.plugins.document.LocalDiffCache

public class LocalDiffCache
extends Object

A diff cache, which is pro-actively filled after a commit.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocalDiffCache.Diff

Method Summary

Modifier and Type	Method and Description
String	getChanges(@NotNull RevisionVector from, @NotNull RevisionVector to, @NotNull String path, @Nullable org.apache.jackrabbit.oak.plugins.document.DiffCache.Loader loader) Returns a jsop diff for the child nodes at the given path.
@NotNull Iterable<org.apache.jackrabbit.oak.cache.CacheStats>	getStats()
@NotNull org.apache.jackrabbit.oak.plugins.document.DiffCache.Entry	newEntry(@NotNull RevisionVector from, @NotNull RevisionVector to, boolean local) Starts a new cache entry for the diff cache.

Methods inherited from class java.lang.Object

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

Method Detail

getChanges

public String getChanges(@NotNull
                         @NotNull RevisionVector from,
                         @NotNull
                         @NotNull RevisionVector to,
                         @NotNull
                         @NotNull String path,
                         @Nullable
                         @Nullable org.apache.jackrabbit.oak.plugins.document.DiffCache.Loader loader)

Returns a jsop diff for the child nodes at the given path. The returned String may contain the following changes on child nodes:

• Changed child nodes: e.g. ^"foo":{}
• Added child nodes: e.g. +"bar":{}
• Removed child nodes: e.g. -"baz"

A null value indicates that this cache does not have an entry for the given revision range at the path.

Parameters:

from - the from revision.

to - the to revision.

path - the path of the parent node.

loader - an optional loader for the cache entry.

Returns:

the diff or null if unknown and no loader was passed.

newEntry

@NotNull
public @NotNull org.apache.jackrabbit.oak.plugins.document.DiffCache.Entry newEntry(@NotNull
                                                                                             @NotNull RevisionVector from,
                                                                                             @NotNull
                                                                                             @NotNull RevisionVector to,
                                                                                             boolean local)

Starts a new cache entry for the diff cache. Actual changes are added to the entry with the Entry#append(String, String) method.

Parameters:

from - the from revision.

to - the to revision.

local - true indicates that the entry results from a local change, false if it results from an external change

Returns:

the cache entry.

getStats

@NotNull
public @NotNull Iterable<org.apache.jackrabbit.oak.cache.CacheStats> getStats()

Returns:

the statistics for this cache.