com.adobe.cq.social.srp.internal

Class AbstractCache<Y,X>

java.lang.Object

com.adobe.cq.social.srp.internal.AbstractCache<Y,X>

Type Parameters:

Y - the lookup key

X - the type of the items in the cache.

Direct Known Subclasses:

CountCache, FacetCache, ProviderCache, StringListCache

public abstract class AbstractCache<Y,X>
extends java.lang.Object

A simple request cache.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_CACHE_ON by default, use caching.
static long	DEFAULT_CACHE_TTL by default leave items in the cache this long.
static int	DEFAULT_CONCURRENCY_LEVEL default concurrency level
static int	DEFAULT_MAX_CACHE_SIZE by default, allow this many items in the cache.
static int	DEFAULT_START_CACHE_SIZE default initial cache size

Constructor Summary

Constructors

Constructor and Description
AbstractCache()
AbstractCache(int concurrencyLevel, int cacheStartSize, int cacheMaxSize, long ttl)

Method Summary

Modifier and Type	Method and Description
void	clear()
CacheEntry<X>	get(java.lang.Object key)
java.util.Set<Y>	keySet()
abstract void	merge(Y key, X doc, X returnedResult) merge the doc into the current cached item, if it exists.
void	put(Y key, CacheEntry<X> doc)
void	remove(java.lang.Object key)
void	removeAll(java.lang.Iterable<?> keys)
void	setCacheMode(boolean mode) Enables or disables the cache.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CACHE_ON

public static final boolean DEFAULT_CACHE_ON

by default, use caching.

See Also:

Constant Field Values

DEFAULT_CACHE_TTL

public static final long DEFAULT_CACHE_TTL

by default leave items in the cache this long.

See Also:

Constant Field Values

DEFAULT_START_CACHE_SIZE

public static final int DEFAULT_START_CACHE_SIZE

default initial cache size

See Also:

Constant Field Values

DEFAULT_MAX_CACHE_SIZE

public static final int DEFAULT_MAX_CACHE_SIZE

by default, allow this many items in the cache.

See Also:

Constant Field Values

DEFAULT_CONCURRENCY_LEVEL

public static final int DEFAULT_CONCURRENCY_LEVEL

default concurrency level

See Also:

Constant Field Values

Constructor Detail

AbstractCache

public AbstractCache(int concurrencyLevel,
                     int cacheStartSize,
                     int cacheMaxSize,
                     long ttl)

Parameters:

concurrencyLevel - cache concurreny level

cacheStartSize - starting cache size

cacheMaxSize - the initial size of the cache.

ttl - expiration time for cache entries in milliseconds

AbstractCache

public AbstractCache()

Method Detail

put

public void put(Y key,
                CacheEntry<X> doc)

remove

public void remove(java.lang.Object key)

removeAll

public void removeAll(java.lang.Iterable<?> keys)

merge

public abstract void merge(Y key,
                           X doc,
                           X returnedResult)

merge the doc into the current cached item, if it exists. How you merge depends on the type of the cache entry, thus this is abstract.

Parameters:

key - the key into the cache

doc - the changed items

returnedResult - the returned result

get

public CacheEntry<X> get(java.lang.Object key)

setCacheMode

public void setCacheMode(boolean mode)

Enables or disables the cache.

Parameters:

mode - true if the cache should be enabled. False otherwise.

keySet

public java.util.Set<Y> keySet()

clear

public void clear()