org.apache.jackrabbit.oak.plugins.document.persistentCache

Enum CacheType

java.lang.Object

java.lang.Enum<CacheType>

org.apache.jackrabbit.oak.plugins.document.persistentCache.CacheType

All Implemented Interfaces:

Serializable, Comparable<CacheType>

public enum CacheType
extends Enum<CacheType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHILDREN
DIFF
DOCUMENT
LOCAL_DIFF
NODE
PREV_DOCUMENT

Field Summary

Fields

Modifier and Type	Field and Description
static CacheType[]	VALUES

Method Summary

Modifier and Type	Method and Description
abstract <K> int	compareKeys(K a, K b)
abstract <K> K	keyFromString(String key)
abstract <K> String	keyToString(K key)
abstract <K> boolean	shouldCache(DocumentNodeStore store, K key)
abstract <V> V	valueFromString(DocumentNodeStore store, DocumentStore docStore, String value)
static CacheType	valueOf(String name) Returns the enum constant of this type with the specified name.
static CacheType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
abstract <V> String	valueToString(V value)

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NODE

public static final CacheType NODE

CHILDREN

public static final CacheType CHILDREN

DIFF

public static final CacheType DIFF

DOCUMENT

public static final CacheType DOCUMENT

PREV_DOCUMENT

public static final CacheType PREV_DOCUMENT

LOCAL_DIFF

public static final CacheType LOCAL_DIFF

Field Detail

VALUES

public static final CacheType[] VALUES

Method Detail

values

public static CacheType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CacheType c : CacheType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CacheType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

keyToString

public abstract <K> String keyToString(K key)

keyFromString

public abstract <K> K keyFromString(String key)

compareKeys

public abstract <K> int compareKeys(K a,
                                    K b)

valueToString

public abstract <V> String valueToString(V value)

valueFromString

public abstract <V> V valueFromString(DocumentNodeStore store,
                                      DocumentStore docStore,
                                      String value)

shouldCache

public abstract <K> boolean shouldCache(DocumentNodeStore store,
                                        K key)