Package com.github.benmanes.caffeine.cache

Class UnboundedLocalCache<K,V>

java.lang.Object

com.github.benmanes.caffeine.cache.UnboundedLocalCache<K,V>

All Implemented Interfaces:

LocalCache<K,V>, java.util.concurrent.ConcurrentMap<K,V>, java.util.Map<K,V>

final class UnboundedLocalCache<K,V>
extends java.lang.Object
implements LocalCache<K,V>

An in-memory cache that has no capabilities for bounding the map. This implementation provides a lightweight wrapper on top of ConcurrentHashMap.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	UnboundedLocalCache.EntryIterator<K,V>	An adapter to safely externalize the entry iterator.
(package private) static class	UnboundedLocalCache.EntrySetView<K,V>	An adapter to safely externalize the entries.
(package private) static class	UnboundedLocalCache.EntrySpliterator<K,V>	An adapter to safely externalize the entry spliterator.
(package private) static class	UnboundedLocalCache.KeyIterator<K>	An adapter to safely externalize the key iterator.
(package private) static class	UnboundedLocalCache.KeySetView<K>	An adapter to safely externalize the keys.
(package private) static class	UnboundedLocalCache.UnboundedLocalAsyncCache<K,V>
(package private) static class	UnboundedLocalCache.UnboundedLocalAsyncLoadingCache<K,V>
(package private) static class	UnboundedLocalCache.UnboundedLocalLoadingCache<K,V>
(package private) static class	UnboundedLocalCache.UnboundedLocalManualCache<K,V>
(package private) static class	UnboundedLocalCache.UnboundedPolicy<K,V>	An eviction policy that supports no boundings.
(package private) static class	UnboundedLocalCache.ValuesIterator<K,V>	An adapter to safely externalize the value iterator.
(package private) static class	UnboundedLocalCache.ValuesView<K,V>	An adapter to safely externalize the values.

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Field Summary

Fields

Modifier and Type	Field	Description
(package private) java.util.concurrent.ConcurrentHashMap<K,V>	data
(package private) @Nullable java.util.Set<java.util.Map.Entry<K,V>>	entrySet
(package private) java.util.concurrent.Executor	executor
(package private) boolean	isRecordingStats
(package private) @Nullable java.util.Set<K>	keySet
(package private) @Nullable RemovalListener<K,V>	removalListener
(package private) StatsCounter	statsCounter
(package private) Ticker	ticker
(package private) @Nullable java.util.Collection<V>	values
(package private) CacheWriter<K,V>	writer

Constructor Summary

Constructors

Constructor	Description
UnboundedLocalCache(Caffeine<? super K,? super V> builder, boolean async)

Method Summary

Modifier and Type	Method	Description
void	cleanUp()	See Cache.cleanUp().
void	clear()
V	compute(K key, java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction, boolean recordMiss, boolean recordLoad, boolean recordLoadFailure)	See ConcurrentMap.compute(K, java.util.function.BiFunction<? super K, ? super V, ? extends V>).
V	computeIfAbsent(K key, java.util.function.Function<? super K,? extends V> mappingFunction, boolean recordStats, boolean recordLoad)	See ConcurrentMap.computeIfAbsent(K, java.util.function.Function<? super K, ? extends V>).
@Nullable V	computeIfPresent(K key, java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<K,V>>	entrySet()
boolean	equals(java.lang.Object o)
long	estimatedSize()	See Cache.estimatedSize().
java.util.concurrent.Executor	executor()	Returns the Executor used by this cache.
Ticker	expirationTicker()	Returns the Ticker used by this cache for expiration.
void	forEach(java.util.function.BiConsumer<? super K,? super V> action)
@Nullable V	get(java.lang.Object key)
java.util.Map<K,V>	getAllPresent(java.lang.Iterable<?> keys)	See Cache.getAllPresent(java.lang.Iterable<?>).
@Nullable V	getIfPresent(java.lang.Object key, boolean recordStats)	See Cache.getIfPresent(Object).
@Nullable V	getIfPresentQuietly(java.lang.Object key, long[] writeTime)	See Cache.getIfPresent(Object).
int	hashCode()
boolean	hasRemovalListener()	Returns whether this cache notifies when an entry is removed.
boolean	hasWriteTime()	Returns whether the cache captures the write time of the entry.
boolean	isEmpty()
boolean	isRecordingStats()	Returns whether this cache has statistics enabled.
java.util.Set<K>	keySet()
V	merge(K key, V value, java.util.function.BiFunction<? super V,? super V,? extends V> remappingFunction)
void	notifyRemoval(@Nullable K key, @Nullable V value, RemovalCause cause)	Asynchronously sends a removal notification to the listener.
@Nullable V	put(K key, V value)
@Nullable V	put(K key, V value, boolean notifyWriter)	See Cache.put(Object, Object).
void	putAll(java.util.Map<? extends K,? extends V> map)
@Nullable V	putIfAbsent(K key, V value)
(package private) V	remap(K key, java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)	A Map.compute(Object, BiFunction) that does not directly record any cache statistics.
RemovalListener<K,V>	removalListener()	Returns the RemovalListener used by this cache.
@Nullable V	remove(java.lang.Object key)
boolean	remove(java.lang.Object key, java.lang.Object value)
@Nullable V	replace(K key, V value)
boolean	replace(K key, V oldValue, V newValue)
void	replaceAll(java.util.function.BiFunction<? super K,? super V,? extends V> function)
int	size()
StatsCounter	statsCounter()	Returns the StatsCounter used by this cache.
Ticker	statsTicker()	Returns the Ticker used by this cache for statistics.
java.lang.String	toString()
java.util.Collection<V>	values()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.concurrent.ConcurrentMap

getOrDefault

Methods inherited from interface com.github.benmanes.caffeine.cache.LocalCache

compute, computeIfAbsent, invalidateAll, statsAware, statsAware, statsAware

Field Detail

removalListener

final @Nullable RemovalListener<K,V> removalListener

data

final java.util.concurrent.ConcurrentHashMap<K,V> data

statsCounter

final StatsCounter statsCounter

isRecordingStats

final boolean isRecordingStats

writer

final CacheWriter<K,V> writer

executor

final java.util.concurrent.Executor executor

ticker

final Ticker ticker

keySet

transient @Nullable java.util.Set<K> keySet

values

transient @Nullable java.util.Collection<V> values

entrySet

transient @Nullable java.util.Set<java.util.Map.Entry<K,V>> entrySet

Constructor Detail

UnboundedLocalCache

UnboundedLocalCache(Caffeine<? super K,? super V> builder,
                    boolean async)

Method Detail

hasWriteTime

public boolean hasWriteTime()

Description copied from interface: LocalCache

Returns whether the cache captures the write time of the entry.

Specified by:

hasWriteTime in interface LocalCache<K,V>

getIfPresent

public @Nullable V getIfPresent(java.lang.Object key,
                                boolean recordStats)

Description copied from interface: LocalCache

See Cache.getIfPresent(Object). This method differs by accepting a parameter of whether to record the hit and miss statistics based on the success of this operation.

Specified by:

getIfPresent in interface LocalCache<K,V>

getIfPresentQuietly

public @Nullable V getIfPresentQuietly(java.lang.Object key,
                                       long[] writeTime)

Description copied from interface: LocalCache

See Cache.getIfPresent(Object). This method differs by not recording the access with the statistics nor the eviction policy, and populates the write time if known.

Specified by:

getIfPresentQuietly in interface LocalCache<K,V>

estimatedSize

public long estimatedSize()

Description copied from interface: LocalCache

See Cache.estimatedSize().

Specified by:

estimatedSize in interface LocalCache<K,V>

getAllPresent

public java.util.Map<K,V> getAllPresent(java.lang.Iterable<?> keys)

Description copied from interface: LocalCache

See Cache.getAllPresent(java.lang.Iterable<?>).

Specified by:

getAllPresent in interface LocalCache<K,V>

cleanUp

public void cleanUp()

Description copied from interface: LocalCache

See Cache.cleanUp().

Specified by:

cleanUp in interface LocalCache<K,V>

statsCounter

public StatsCounter statsCounter()

Description copied from interface: LocalCache

Returns the StatsCounter used by this cache.

Specified by:

statsCounter in interface LocalCache<K,V>

hasRemovalListener

public boolean hasRemovalListener()

Description copied from interface: LocalCache

Returns whether this cache notifies when an entry is removed.

Specified by:

hasRemovalListener in interface LocalCache<K,V>

removalListener

public RemovalListener<K,V> removalListener()

Description copied from interface: LocalCache

Returns the RemovalListener used by this cache.

Specified by:

removalListener in interface LocalCache<K,V>

notifyRemoval

public void notifyRemoval(@Nullable K key,
                          @Nullable V value,
                          RemovalCause cause)

Description copied from interface: LocalCache

Asynchronously sends a removal notification to the listener.

Specified by:

notifyRemoval in interface LocalCache<K,V>

isRecordingStats

public boolean isRecordingStats()

Description copied from interface: LocalCache

Returns whether this cache has statistics enabled.

Specified by:

isRecordingStats in interface LocalCache<K,V>

executor

public java.util.concurrent.Executor executor()

Description copied from interface: LocalCache

Returns the Executor used by this cache.

Specified by:

executor in interface LocalCache<K,V>

expirationTicker

public Ticker expirationTicker()

Description copied from interface: LocalCache

Returns the Ticker used by this cache for expiration.

Specified by:

expirationTicker in interface LocalCache<K,V>

statsTicker

public Ticker statsTicker()

Description copied from interface: LocalCache

Returns the Ticker used by this cache for statistics.

Specified by:

statsTicker in interface LocalCache<K,V>

forEach

public void forEach(java.util.function.BiConsumer<? super K,? super V> action)

Specified by:

forEach in interface java.util.concurrent.ConcurrentMap<K,V>

Specified by:

forEach in interface java.util.Map<K,V>

replaceAll

public void replaceAll(java.util.function.BiFunction<? super K,? super V,? extends V> function)

Specified by:

replaceAll in interface java.util.concurrent.ConcurrentMap<K,V>

Specified by:

replaceAll in interface java.util.Map<K,V>

computeIfAbsent

public V computeIfAbsent(K key,
                         java.util.function.Function<? super K,? extends V> mappingFunction,
                         boolean recordStats,
                         boolean recordLoad)

Description copied from interface: LocalCache

See ConcurrentMap.computeIfAbsent(K, java.util.function.Function<? super K, ? extends V>). This method differs by accepting parameters indicating how to record statistics.

Specified by:

computeIfAbsent in interface LocalCache<K,V>

computeIfPresent

public @Nullable V computeIfPresent(K key,
                                    java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)

Specified by:

computeIfPresent in interface java.util.concurrent.ConcurrentMap<K,V>

Specified by:

computeIfPresent in interface java.util.Map<K,V>

compute

public V compute(K key,
                 java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction,
                 boolean recordMiss,
                 boolean recordLoad,
                 boolean recordLoadFailure)

Description copied from interface: LocalCache

See ConcurrentMap.compute(K, java.util.function.BiFunction<? super K, ? super V, ? extends V>). This method differs by accepting parameters indicating whether to record miss and load statistics based on the success of this operation.

Specified by:

compute in interface LocalCache<K,V>

merge

public V merge(K key,
               V value,
               java.util.function.BiFunction<? super V,? super V,? extends V> remappingFunction)

Specified by:

merge in interface java.util.concurrent.ConcurrentMap<K,V>

Specified by:

merge in interface java.util.Map<K,V>

remap

V remap(K key,
        java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)

A Map.compute(Object, BiFunction) that does not directly record any cache statistics.

Parameters:

key - key with which the specified value is to be associated

remappingFunction - the function to compute a value

Returns:

the new value associated with the specified key, or null if none

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<K,V>

size

public int size()

Specified by:

size in interface java.util.Map<K,V>

clear

public void clear()

Specified by:

clear in interface java.util.Map<K,V>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<K,V>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<K,V>

get

public @Nullable V get(java.lang.Object key)

Specified by:

get in interface java.util.Map<K,V>

put

public @Nullable V put(K key,
                       V value)

Specified by:

put in interface java.util.Map<K,V>

put

public @Nullable V put(K key,
                       V value,
                       boolean notifyWriter)

Description copied from interface: LocalCache

See Cache.put(Object, Object). This method differs by allowing the operation to not notify the writer when an entry was inserted or updated.

Specified by:

put in interface LocalCache<K,V>

putIfAbsent

public @Nullable V putIfAbsent(K key,
                               V value)

Specified by:

putIfAbsent in interface java.util.concurrent.ConcurrentMap<K,V>

Specified by:

putIfAbsent in interface java.util.Map<K,V>

putAll

public void putAll(java.util.Map<? extends K,? extends V> map)

Specified by:

putAll in interface java.util.Map<K,V>

remove

public @Nullable V remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<K,V>

remove

public boolean remove(java.lang.Object key,
                      java.lang.Object value)

Specified by:

remove in interface java.util.concurrent.ConcurrentMap<K,V>

Specified by:

remove in interface java.util.Map<K,V>

replace

public @Nullable V replace(K key,
                           V value)

Specified by:

replace in interface java.util.concurrent.ConcurrentMap<K,V>

Specified by:

replace in interface java.util.Map<K,V>

replace

public boolean replace(K key,
                       V oldValue,
                       V newValue)

Specified by:

replace in interface java.util.concurrent.ConcurrentMap<K,V>

Specified by:

replace in interface java.util.Map<K,V>

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Map<K,V>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map<K,V>

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

keySet

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

Specified by:

keySet in interface java.util.Map<K,V>

values

public java.util.Collection<V> values()

Specified by:

values in interface java.util.Map<K,V>

entrySet

public java.util.Set<java.util.Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface java.util.Map<K,V>