Package org.thymeleaf.cache

Class StandardCache<K,V>

java.lang.Object

org.thymeleaf.cache.StandardCache<K,V>

Type Parameters:

K - The type of the cache keys

V - The type of the cache values

All Implemented Interfaces:

ICache<K,V>

public final class StandardCache<K,V>
extends java.lang.Object
implements ICache<K,V>

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	StandardCache.CacheDataContainer<K,V>
(package private) static class	StandardCache.CacheEntry<V>

Field Summary

Fields

Modifier and Type	Field	Description
private StandardCache.CacheDataContainer<K,V>	dataContainer
private boolean	enableCounters
private ICacheEntryValidityChecker<? super K,? super V>	entryValidityChecker
private java.util.concurrent.atomic.AtomicLong	getCount
private java.util.concurrent.atomic.AtomicLong	hitCount
private long	lastExecution
private org.slf4j.Logger	logger
private int	maxSize
private java.util.concurrent.atomic.AtomicLong	missCount
private java.lang.String	name
private java.util.concurrent.atomic.AtomicLong	putCount
private static java.lang.String	REPORT_FORMAT
private static long	REPORT_INTERVAL
private boolean	traceExecution
private boolean	useSoftReferences

Constructor Summary

Constructors

Constructor	Description
StandardCache(java.lang.String name, boolean useSoftReferences, int initialCapacity, int maxSize, org.slf4j.Logger logger)
StandardCache(java.lang.String name, boolean useSoftReferences, int initialCapacity, int maxSize, ICacheEntryValidityChecker<? super K,? super V> entryValidityChecker, org.slf4j.Logger logger)
StandardCache(java.lang.String name, boolean useSoftReferences, int initialCapacity, int maxSize, ICacheEntryValidityChecker<? super K,? super V> entryValidityChecker, org.slf4j.Logger logger, boolean enableCounters)
StandardCache(java.lang.String name, boolean useSoftReferences, int initialCapacity, org.slf4j.Logger logger)
StandardCache(java.lang.String name, boolean useSoftReferences, int initialCapacity, ICacheEntryValidityChecker<? super K,? super V> entryValidityChecker, org.slf4j.Logger logger)

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear the entire cache.
void	clearKey(K key)	Clears a specific entry in the cache.
V	get(K key)	Retrieve a value from the cache.
V	get(K key, ICacheEntryValidityChecker<? super K,? super V> validityChecker)	Retrieve a value from the cache, using the specified validity checker to ensure the entry is still valid.
long	getGetCount()
long	getHitCount()
double	getHitRatio()
int	getMaxSize()
long	getMissCount()
double	getMissRatio()
java.lang.String	getName()
long	getPutCount()
boolean	getUseSoftReferences()
boolean	hasMaxSize()
private void	incrementReportEntity(java.util.concurrent.atomic.AtomicLong entity)
java.util.Set<K>	keySet()	Returns all the keys contained in this cache.
private void	outputReportIfNeeded()
void	put(K key, V value)	Insert a new value into the cache.
int	size()

Methods inherited from class java.lang.Object

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

Field Detail

REPORT_INTERVAL

private static final long REPORT_INTERVAL

See Also:

Constant Field Values

REPORT_FORMAT

private static final java.lang.String REPORT_FORMAT

See Also:

Constant Field Values

lastExecution

private volatile long lastExecution

name

private final java.lang.String name

useSoftReferences

private final boolean useSoftReferences

maxSize

private final int maxSize

dataContainer

private final StandardCache.CacheDataContainer<K,V> dataContainer

entryValidityChecker

private final ICacheEntryValidityChecker<? super K,? super V> entryValidityChecker

traceExecution

private final boolean traceExecution

enableCounters

private final boolean enableCounters

logger

private final org.slf4j.Logger logger

getCount

private final java.util.concurrent.atomic.AtomicLong getCount

putCount

private final java.util.concurrent.atomic.AtomicLong putCount

hitCount

private final java.util.concurrent.atomic.AtomicLong hitCount

missCount

private final java.util.concurrent.atomic.AtomicLong missCount

Constructor Detail

StandardCache

public StandardCache(java.lang.String name,
                     boolean useSoftReferences,
                     int initialCapacity,
                     org.slf4j.Logger logger)

StandardCache

public StandardCache(java.lang.String name,
                     boolean useSoftReferences,
                     int initialCapacity,
                     ICacheEntryValidityChecker<? super K,? super V> entryValidityChecker,
                     org.slf4j.Logger logger)

StandardCache

public StandardCache(java.lang.String name,
                     boolean useSoftReferences,
                     int initialCapacity,
                     int maxSize,
                     org.slf4j.Logger logger)

StandardCache

public StandardCache(java.lang.String name,
                     boolean useSoftReferences,
                     int initialCapacity,
                     int maxSize,
                     ICacheEntryValidityChecker<? super K,? super V> entryValidityChecker,
                     org.slf4j.Logger logger)

StandardCache

public StandardCache(java.lang.String name,
                     boolean useSoftReferences,
                     int initialCapacity,
                     int maxSize,
                     ICacheEntryValidityChecker<? super K,? super V> entryValidityChecker,
                     org.slf4j.Logger logger,
                     boolean enableCounters)

Method Detail

put

public void put(K key,
                V value)

Description copied from interface: ICache

Insert a new value into the cache.

Specified by:

put in interface ICache<K,V>

Parameters:

key - the key of the new entry

value - the value to be cached

get

public V get(K key)

Description copied from interface: ICache

Retrieve a value from the cache.

Specified by:

get in interface ICache<K,V>

Parameters:

key - the key of the value to be retrieved

Returns:

the retrieved value, or null if no value exists for the specified key.

get

public V get(K key,
             ICacheEntryValidityChecker<? super K,? super V> validityChecker)

Description copied from interface: ICache

Retrieve a value from the cache, using the specified validity checker to ensure the entry is still valid. If the cache already has a default validity checker, this method should override this setting and use the one specified instead.

Specified by:

get in interface ICache<K,V>

Parameters:

key - the key of the value to be retrieved

validityChecker - the validity checker to be used to ensure the entry is still valid.

Returns:

the retrieved value, or null if no value exists for the specified key.

keySet

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

Returns all the keys contained in this cache. Note this method might return keys for entries that are already invalid, so the result of calling get(Object) for these keys might be null.

Specified by:

keySet in interface ICache<K,V>

Returns:

the complete set of cache keys. Might include keys for already-invalid (non-cleaned) entries.

Since:

2.1.4

clear

public void clear()

Description copied from interface: ICache

Clear the entire cache.

Specified by:

clear in interface ICache<K,V>

clearKey

public void clearKey(K key)

Description copied from interface: ICache

Clears a specific entry in the cache.

Specified by:

clearKey in interface ICache<K,V>

Parameters:

key - the key of the entry to be cleared.

getName

public java.lang.String getName()

hasMaxSize

public boolean hasMaxSize()

getMaxSize

public int getMaxSize()

getUseSoftReferences

public boolean getUseSoftReferences()

size

public int size()

getPutCount

public long getPutCount()

getGetCount

public long getGetCount()

getHitCount

public long getHitCount()

getMissCount

public long getMissCount()

getHitRatio

public double getHitRatio()

getMissRatio

public double getMissRatio()

incrementReportEntity

private void incrementReportEntity(java.util.concurrent.atomic.AtomicLong entity)

outputReportIfNeeded

private void outputReportIfNeeded()