org.apache.jackrabbit.oak.plugins.document

Class MemoryDiffCache

java.lang.Object

org.apache.jackrabbit.oak.plugins.document.MemoryDiffCache

public class MemoryDiffCache
extends Object

An in-memory diff cache implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	MemoryDiffCache.MemoryEntry

Field Summary

Fields

Modifier and Type	Field and Description
protected Cache<PathRev,StringValue>	diffCache Diff cache.
protected CacheStats	diffCacheStats

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MemoryDiffCache(DocumentNodeStoreBuilder<?> builder)

Method Summary

Modifier and Type	Method and Description
String	getChanges(RevisionVector from, RevisionVector to, String path, org.apache.jackrabbit.oak.plugins.document.DiffCache.Loader loader) Returns a jsop diff for the child nodes at the given path.
Iterable<CacheStats>	getStats()
org.apache.jackrabbit.oak.plugins.document.DiffCache.Entry	newEntry(RevisionVector from, 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

Field Detail

diffCache

protected final Cache<PathRev,StringValue> diffCache

Diff cache. Key: PathRev, value: StringValue

diffCacheStats

protected final CacheStats diffCacheStats

Constructor Detail

MemoryDiffCache

protected MemoryDiffCache(DocumentNodeStoreBuilder<?> builder)

Method Detail

getChanges

@CheckForNull
public String getChanges(@Nonnull
                                        RevisionVector from,
                                        @Nonnull
                                        RevisionVector to,
                                        @Nonnull
                                        String path,
                                        @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

@Nonnull
public org.apache.jackrabbit.oak.plugins.document.DiffCache.Entry newEntry(@Nonnull
                                                                                     RevisionVector from,
                                                                                     @Nonnull
                                                                                     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

@Nonnull
public Iterable<CacheStats> getStats()

Returns:

the statistics for this cache.