Class BoundedLocalCache<K,V>
java.lang.Object
java.util.AbstractMap<K,V>
com.github.benmanes.caffeine.cache.BLCHeader.PadDrainStatus<K,V>
com.github.benmanes.caffeine.cache.BLCHeader.DrainStatusRef<K,V>
com.github.benmanes.caffeine.cache.BoundedLocalCache<K,V>
- Type Parameters:
K
- the type of keys maintained by this cacheV
- the type of mapped values
- All Implemented Interfaces:
LocalCache<K,
,V> ConcurrentMap<K,
,V> Map<K,
V>
- Direct Known Subclasses:
LocalCacheFactory.SI
,LocalCacheFactory.SS
,LocalCacheFactory.WI
,LocalCacheFactory.WS
@ThreadSafe
abstract class BoundedLocalCache<K,V>
extends BLCHeader.DrainStatusRef<K,V>
implements LocalCache<K,V>
An in-memory cache implementation that supports full concurrency of retrievals, a high expected
concurrency for updates, and multiple ways to bound the cache.
This class is abstract and code generated subclasses provide the complete implementation for a particular configuration. This is to ensure that only the fields and execution paths necessary for a given configuration are used.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) final class
Adds the node to the page replacement policy.(package private) static final class
(package private) static final class
(package private) static class
(package private) static final class
(package private) static final class
An adapter to safely externalize the entry iterator.(package private) static final class
An adapter to safely externalize the entries.(package private) static final class
An adapter to safely externalize the entry spliterator.(package private) static final class
An adapter to safely externalize the key iterator.(package private) static final class
An adapter to safely externalize the keys.(package private) static final class
An adapter to safely externalize the key spliterator.(package private) final class
A reusable task that performs the maintenance work; used to avoid wrapping by ForkJoinPool.(package private) final class
Removes a node from the page replacement policy.(package private) final class
Updates the weighted size and evicts an entry on overflow.(package private) static final class
An adapter to safely externalize the value iterator.(package private) static final class
An adapter to safely externalize the value spliterator.(package private) static final class
An adapter to safely externalize the values.Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K extends Object,
V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object, V extends Object> -
Field Summary
FieldsModifier and TypeFieldDescription(package private) final CacheLoader<K,
V> (package private) final ConcurrentHashMap<Object,
Node<K, V>> (package private) final BoundedLocalCache<K,
V>.PerformCleanupTask (package private) final Lock
(package private) final Executor
(package private) static final long
The maximum time window between entry updates before the expiration must be reordered.(package private) final boolean
(package private) static final Logger
(package private) static final long
The maximum weighted capacity of the map.(package private) static final int
The number of CPUs(package private) final NodeFactory
(package private) static final double
The percent of the maximum weighted capacity dedicated to the main space.(package private) static final double
The percent of the maximum weighted capacity dedicated to the main's protected space.(package private) Collection<V>
(package private) static final int
The maximum capacity of the write buffer.(package private) static final int
The initial capacity of the write buffer.(package private) static final int
The number of attempts to insert into the write buffer before yielding.(package private) final CacheWriter<K,
V> Fields inherited from class com.github.benmanes.caffeine.cache.BLCHeader.DrainStatusRef
DRAIN_STATUS_OFFSET, drainStatus, IDLE, PROCESSING_TO_IDLE, PROCESSING_TO_REQUIRED, REQUIRED
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
BoundedLocalCache
(Caffeine<K, V> builder, CacheLoader<K, V> cacheLoader, boolean isAsync) Creates an instance based on the builder's configuration. -
Method Summary
Modifier and TypeMethodDescriptionprotected AccessOrderDeque<Node<K,
V>> protected AccessOrderDeque<Node<K,
V>> protected AccessOrderDeque<Node<K,
V>> (package private) long
Returns the combined weight of the values in the cache.(package private) boolean
Determines if the candidate should be accepted into the main space, as determined by its frequency relative to the victim.(package private) void
Performs the post-processing work required after a read.(package private) void
afterWrite
(Node<K, V> node, Runnable task, long now) Performs the post-processing work required after a write.protected boolean
If the page replacement policy buffers writes.(package private) static int
ceilingPowerOfTwo
(int x) void
cleanUp()
SeeCache.cleanUp()
.void
clear()
protected boolean
Returns if the keys are weak reference garbage collected.protected boolean
Returns if the values are weak or soft reference garbage collected.compute
(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, boolean recordMiss, boolean recordLoad) computeIfAbsent
(K key, Function<? super K, ? extends V> mappingFunction, boolean recordStats, boolean recordLoad) computeIfPresent
(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction) boolean
containsKey
(Object key) boolean
containsValue
(Object value) (package private) V
Returns the current value from a computeIfAbsent invocation.(package private) void
Drains the weak key references queue.(package private) void
Drains the read buffer.(package private) void
Drains the weak / soft value references queue.(package private) void
Drains the write buffer.protected long
Returns the maximum weighted size of the eden space.protected long
Returns the uncorrected combined weight of the values in the eden space.entrySet()
long
(package private) void
Evicts entries if the cache exceeds the maximum.(package private) void
evictEntry
(Node<K, V> node, RemovalCause cause, long now) Attempts to evict the entry based on the given removal cause.(package private) int
Evicts entries from the eden space into the main space while the eden size exceeds a maximum.(package private) void
evictFromMain
(int candidates) Evicts entries from the main space if the cache exceeds the maximum capacity.evictionOrder
(int limit, Function<V, V> transformer, boolean hottest) Returns an unmodifiable snapshot map ordered in eviction order, either ascending or descending.protected boolean
evicts()
Returns if the cache evicts entries due to a maximum size or weight threshold.final Executor
executor()
Returns theExecutor
used by this cache.Returns theTicker
used by this cache for expiration.(package private) void
expireAfterAccessEntries
(long now) Expires entries in the access-order queue.(package private) void
expireAfterAccessEntries
(AccessOrderDeque<Node<K, V>> accessOrderDeque, long expirationTime, long now) Expires entries in an access-order queue.expireAfterAcessOrder
(int limit, Function<V, V> transformer, boolean oldest) Returns an unmodifiable snapshot map ordered in access expiration order, either ascending or descending.(package private) void
expireAfterWriteEntries
(long now) Expires entries on the write-order queue.expireAfterWriteOrder
(int limit, Function<V, V> transformer, boolean oldest) Returns an unmodifiable snapshot map ordered in write expiration order, either ascending or descending.(package private) void
Expires entries that have expired in the access and write queues.protected boolean
Returns if the cache expires entries after an access time threshold.protected long
How long after the last access to an entry the map will retain that entry.protected boolean
Returns if the cache expires entries after an write time threshold.protected long
How long after the last write to an entry the map will retain that entry.protected boolean
fastpath()
Returns if an access to an entry can skip notifying the eviction policy.protected FrequencySketch<K>
getAllPresent
(Iterable<?> keys) getIfPresent
(Object key, boolean recordStats) getIfPresentQuietly
(Object key, long[] writeTime) (package private) boolean
hasExpired
(Node<K, V> node, long now) Returns if the entry has expired.boolean
Returns whether this cache notifies when an entry is removed.protected boolean
Returns whether this cache notifies a writer when an entry is modified.boolean
Returns whether the cache captures the write time of the entry.(package private) final boolean
isComputingAsync
(Node<?, ?> node) Returns if the node's value is currently being computed, asynchronously.boolean
isEmpty()
boolean
Returns whether this cache has statistics enabled.protected boolean
Returns if entries may be assigned different weights.protected ReferenceQueue<K>
keySet()
protected void
lazySetEdenMaximum
(long maximum) protected void
lazySetEdenWeightedSize
(long weightedSize) protected void
lazySetMainProtectedMaximum
(long maximum) protected void
lazySetMainProtectedWeightedSize
(long weightedSize) protected void
lazySetMaximum
(long maximum) protected void
lazySetWeightedSize
(long weightedSize) protected long
Returns the maximum weighted size of the main's protected space.protected long
Returns the uncorrected combined weight of the values in the main's protected space.(package private) void
maintenance
(Runnable task) Performs the pending maintenance work and sets the state flags during processing to avoid excess scheduling attempts.(package private) void
Atomically transitions the node to the dead state and decrements the weightedSize.(package private) static <K,
V> SerializationProxy<K, V> makeSerializationProxy
(BoundedLocalCache<?, ?> cache, boolean isWeighted) Creates a serialization proxy based on the common configuration shared by all cache types.protected long
maximum()
Returns the maximum weighted size.void
notifyRemoval
(K key, V value, RemovalCause cause) Asynchronously sends a removal notification to the listener.(package private) void
Updates the node's location in the page replacement policy.(package private) void
performCleanUp
(Runnable task) Performs the maintenance work, blocking until the lock is acquired.(package private) V
Adds a node to the policy and the data store.putIfAbsent
(K key, V value) (package private) V
Adds a node to the policy and the data store.protected boolean
Returns if the cache refreshes entries after an write time threshold.protected long
How long after the last write an entry becomes a candidate for refresh.(package private) void
refreshIfNeeded
(Node<K, V> node, long now) Asynchronously refreshes the entry if eligible.(package private) V
remap
(K key, Object keyRef, BiFunction<? super K, ? super V, ? extends V> remappingFunction, long now, boolean computeIfAbsent) Attempts to compute a mapping for the specified key and its current mapped value (ornull
if there is no current mapping).Returns theRemovalListener
used by this cache or null if not used.boolean
(package private) void
removeNode
(Node<K, V> node, long now) (package private) void
removeNodes
(LinkedDeque<Node<K, V>> deque, long now) (package private) V
removeNoWriter
(Object key) Removes the mapping for a key without notifying the writer.(package private) V
removeWithWriter
(Object key) Removes the mapping for a key after notifying the writer.(package private) static <K,
V> void reorder
(LinkedDeque<Node<K, V>> deque, Node<K, V> node) Updates the node's location in the policy's deque.(package private) void
reorderProbation
(Node<K, V> node) Promote the node from probation to protected on an access.boolean
void
replaceAll
(BiFunction<? super K, ? super V, ? extends V> function) (package private) void
Conditionally schedules the asynchronous maintenance task after a write operation.(package private) void
Attempts to schedule an asynchronous task to apply the pending operations to the page replacement policy.protected void
setExpiresAfterAccessNanos
(long expireAfterAccessNanos) protected void
setExpiresAfterWriteNanos
(long expireAfterWriteNanos) (package private) void
setMaximum
(long maximum) Sets the maximum weighted size of the cache.protected void
setRefreshAfterWriteNanos
(long refreshAfterWriteNanos) int
size()
(package private) boolean
Returns if the cache should bypass the read buffer.Returns an unmodifiable snapshot map ordered by the provided iterator.Returns theStatsCounter
used by this cache.Returns theTicker
used by this cache for statistics.protected ReferenceQueue<V>
values()
protected long
Returns the uncorrected combined weight of the values in the cache.protected MpscGrowableArrayQueue<Runnable>
protected WriteOrderDeque<Node<K,
V>> Methods inherited from class com.github.benmanes.caffeine.cache.BLCHeader.DrainStatusRef
casDrainStatus, drainStatus, lazySetDrainStatus, shouldDrainBuffers
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.concurrent.ConcurrentMap
forEach, getOrDefault
Methods inherited from interface com.github.benmanes.caffeine.cache.LocalCache
compute, computeIfAbsent, invalidateAll, statsAware, statsAware, statsAware
-
Field Details
-
logger
-
NCPU
static final int NCPUThe number of CPUs -
WRITE_BUFFER_MIN
static final int WRITE_BUFFER_MINThe initial capacity of the write buffer.- See Also:
-
WRITE_BUFFER_MAX
static final int WRITE_BUFFER_MAXThe maximum capacity of the write buffer. -
WRITE_BUFFER_RETRIES
static final int WRITE_BUFFER_RETRIESThe number of attempts to insert into the write buffer before yielding.- See Also:
-
MAXIMUM_CAPACITY
static final long MAXIMUM_CAPACITYThe maximum weighted capacity of the map.- See Also:
-
PERCENT_MAIN
static final double PERCENT_MAINThe percent of the maximum weighted capacity dedicated to the main space.- See Also:
-
PERCENT_MAIN_PROTECTED
static final double PERCENT_MAIN_PROTECTEDThe percent of the maximum weighted capacity dedicated to the main's protected space.- See Also:
-
EXPIRE_WRITE_TOLERANCE
static final long EXPIRE_WRITE_TOLERANCEThe maximum time window between entry updates before the expiration must be reordered. -
data
-
drainBuffersTask
-
accessPolicy
-
cacheLoader
-
readBuffer
-
writer
-
nodeFactory
-
weigher
-
evictionLock
-
executor
-
isAsync
final boolean isAsync -
keySet
-
values
-
entrySet
-
-
Constructor Details
-
Method Details
-
ceilingPowerOfTwo
static int ceilingPowerOfTwo(int x) -
isComputingAsync
Returns if the node's value is currently being computed, asynchronously. -
accessOrderEdenDeque
-
accessOrderProbationDeque
-
accessOrderProtectedDeque
-
writeOrderDeque
-
buffersWrites
protected boolean buffersWrites()If the page replacement policy buffers writes. -
writeBuffer
-
executor
Description copied from interface:LocalCache
Returns theExecutor
used by this cache.- Specified by:
executor
in interfaceLocalCache<K,
V>
-
hasWriter
protected boolean hasWriter()Returns whether this cache notifies a writer when an entry is modified. -
isRecordingStats
public boolean isRecordingStats()Description copied from interface:LocalCache
Returns whether this cache has statistics enabled.- Specified by:
isRecordingStats
in interfaceLocalCache<K,
V>
-
statsCounter
Description copied from interface:LocalCache
Returns theStatsCounter
used by this cache.- Specified by:
statsCounter
in interfaceLocalCache<K,
V>
-
statsTicker
Description copied from interface:LocalCache
Returns theTicker
used by this cache for statistics.- Specified by:
statsTicker
in interfaceLocalCache<K,
V>
-
removalListener
Description copied from interface:LocalCache
Returns theRemovalListener
used by this cache or null if not used.- Specified by:
removalListener
in interfaceLocalCache<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 interfaceLocalCache<K,
V>
-
notifyRemoval
Description copied from interface:LocalCache
Asynchronously sends a removal notification to the listener.- Specified by:
notifyRemoval
in interfaceLocalCache<K,
V>
-
collectKeys
protected boolean collectKeys()Returns if the keys are weak reference garbage collected. -
collectValues
protected boolean collectValues()Returns if the values are weak or soft reference garbage collected. -
keyReferenceQueue
-
valueReferenceQueue
-
expiresAfterAccess
protected boolean expiresAfterAccess()Returns if the cache expires entries after an access time threshold. -
expiresAfterAccessNanos
protected long expiresAfterAccessNanos()How long after the last access to an entry the map will retain that entry. -
setExpiresAfterAccessNanos
protected void setExpiresAfterAccessNanos(long expireAfterAccessNanos) -
expiresAfterWrite
protected boolean expiresAfterWrite()Returns if the cache expires entries after an write time threshold. -
expiresAfterWriteNanos
protected long expiresAfterWriteNanos()How long after the last write to an entry the map will retain that entry. -
setExpiresAfterWriteNanos
protected void setExpiresAfterWriteNanos(long expireAfterWriteNanos) -
refreshAfterWrite
protected boolean refreshAfterWrite()Returns if the cache refreshes entries after an write time threshold. -
refreshAfterWriteNanos
protected long refreshAfterWriteNanos()How long after the last write an entry becomes a candidate for refresh. -
setRefreshAfterWriteNanos
protected void setRefreshAfterWriteNanos(long refreshAfterWriteNanos) -
hasWriteTime
public boolean hasWriteTime()Description copied from interface:LocalCache
Returns whether the cache captures the write time of the entry.- Specified by:
hasWriteTime
in interfaceLocalCache<K,
V>
-
expirationTicker
Description copied from interface:LocalCache
Returns theTicker
used by this cache for expiration.- Specified by:
expirationTicker
in interfaceLocalCache<K,
V>
-
evicts
protected boolean evicts()Returns if the cache evicts entries due to a maximum size or weight threshold. -
isWeighted
protected boolean isWeighted()Returns if entries may be assigned different weights. -
frequencySketch
-
fastpath
protected boolean fastpath()Returns if an access to an entry can skip notifying the eviction policy. -
maximum
protected long maximum()Returns the maximum weighted size. -
edenMaximum
protected long edenMaximum()Returns the maximum weighted size of the eden space. -
mainProtectedMaximum
protected long mainProtectedMaximum()Returns the maximum weighted size of the main's protected space. -
lazySetMaximum
protected void lazySetMaximum(long maximum) -
lazySetEdenMaximum
protected void lazySetEdenMaximum(long maximum) -
lazySetMainProtectedMaximum
protected void lazySetMainProtectedMaximum(long maximum) -
setMaximum
void setMaximum(long maximum) Sets the maximum weighted size of the cache. The caller may need to perform a maintenance cycle to eagerly evicts entries until the cache shrinks to the appropriate size. -
adjustedWeightedSize
long adjustedWeightedSize()Returns the combined weight of the values in the cache. -
weightedSize
protected long weightedSize()Returns the uncorrected combined weight of the values in the cache. -
edenWeightedSize
protected long edenWeightedSize()Returns the uncorrected combined weight of the values in the eden space. -
mainProtectedWeightedSize
protected long mainProtectedWeightedSize()Returns the uncorrected combined weight of the values in the main's protected space. -
lazySetWeightedSize
protected void lazySetWeightedSize(long weightedSize) -
lazySetEdenWeightedSize
protected void lazySetEdenWeightedSize(long weightedSize) -
lazySetMainProtectedWeightedSize
protected void lazySetMainProtectedWeightedSize(long weightedSize) -
evictEntries
void evictEntries()Evicts entries if the cache exceeds the maximum. -
evictFromEden
int evictFromEden()Evicts entries from the eden space into the main space while the eden size exceeds a maximum.- Returns:
- the number of candidate entries evicted from the eden space
-
evictFromMain
void evictFromMain(int candidates) Evicts entries from the main space if the cache exceeds the maximum capacity. The main space determines whether admitting an entry (coming from the eden space) is preferable to retaining the eviction policy's victim. This is decision is made using a frequency filter so that the least frequently used entry is removed. The eden space candidates were previously placed in the MRU position and the eviction policy's victim is at the LRU position. The two ends of the queue are evaluated while an eviction is required. The number of remaining candidates is provided and decremented on eviction, so that when there are no more candidates the victim is evicted.- Parameters:
candidates
- the number of candidate entries evicted from the eden space
-
admit
Determines if the candidate should be accepted into the main space, as determined by its frequency relative to the victim. A small amount of randomness is used to protect against hash collision attacks, where the victim's frequency is artificially raised so that no new entries are admitted.- Parameters:
candidateKey
- the key for the entry being proposed for long term retentionvictimKey
- the key for the entry chosen by the eviction policy for replacement- Returns:
- if the candidate should be admitted and the victim ejected
-
expireEntries
void expireEntries()Expires entries that have expired in the access and write queues. -
expireAfterAccessEntries
void expireAfterAccessEntries(long now) Expires entries in the access-order queue. -
expireAfterAccessEntries
void expireAfterAccessEntries(AccessOrderDeque<Node<K, V>> accessOrderDeque, long expirationTime, long now) Expires entries in an access-order queue. -
expireAfterWriteEntries
void expireAfterWriteEntries(long now) Expires entries on the write-order queue. -
hasExpired
Returns if the entry has expired. -
evictEntry
Attempts to evict the entry based on the given removal cause. A removal due to expiration or size may be ignored if the entry was updated and is no longer eligible for eviction.- Parameters:
node
- the entry to evictcause
- the reason to evictnow
- the current time, used only if expiring
-
afterRead
Performs the post-processing work required after a read.- Parameters:
node
- the entry in the page replacement policynow
- the current expiration time, in nanosecondsrecordHit
- if the hit count should be incremented
-
skipReadBuffer
boolean skipReadBuffer()Returns if the cache should bypass the read buffer. -
refreshIfNeeded
Asynchronously refreshes the entry if eligible.- Parameters:
node
- the entry in the cache to refreshnow
- the current time, in nanoseconds
-
afterWrite
Performs the post-processing work required after a write.- Parameters:
node
- the node that was written totask
- the pending operation to be appliednow
- the current expiration time, in nanoseconds
-
scheduleAfterWrite
void scheduleAfterWrite()Conditionally schedules the asynchronous maintenance task after a write operation. If the task status was IDLE or REQUIRED then the maintenance task is scheduled immediately. If it is already processing then it is set to transition to REQUIRED upon completion so that a new execution is triggered by the next operation. -
scheduleDrainBuffers
void scheduleDrainBuffers()Attempts to schedule an asynchronous task to apply the pending operations to the page replacement policy. If the executor rejects the task then it is run directly. -
cleanUp
public void cleanUp()Description copied from interface:LocalCache
SeeCache.cleanUp()
.- Specified by:
cleanUp
in interfaceLocalCache<K,
V>
-
performCleanUp
Performs the maintenance work, blocking until the lock is acquired. Any exception thrown, such as byCacheWriter#delete()
, is propagated to the caller.- Parameters:
task
- an additional pending task to run, ornull
if not present
-
maintenance
Performs the pending maintenance work and sets the state flags during processing to avoid excess scheduling attempts. The read buffer, write buffer, and reference queues are drained, followed by expiration, and size-based eviction.- Parameters:
task
- an additional pending task to run, ornull
if not present
-
drainKeyReferences
void drainKeyReferences()Drains the weak key references queue. -
drainValueReferences
void drainValueReferences()Drains the weak / soft value references queue. -
drainReadBuffer
void drainReadBuffer()Drains the read buffer. -
onAccess
Updates the node's location in the page replacement policy. -
reorderProbation
Promote the node from probation to protected on an access. -
reorder
Updates the node's location in the policy's deque. -
drainWriteBuffer
void drainWriteBuffer()Drains the write buffer. -
makeDead
Atomically transitions the node to the dead state and decrements the weightedSize.- Parameters:
node
- the entry in the page replacement policy
-
isEmpty
public boolean isEmpty() -
size
public int size() -
estimatedSize
public long estimatedSize()Description copied from interface:LocalCache
- Specified by:
estimatedSize
in interfaceLocalCache<K,
V>
-
clear
public void clear() -
removeNodes
-
removeNode
-
containsKey
- Specified by:
containsKey
in interfaceMap<K,
V> - Overrides:
containsKey
in classAbstractMap<K,
V>
-
containsValue
- Specified by:
containsValue
in interfaceMap<K,
V> - Overrides:
containsValue
in classAbstractMap<K,
V>
-
get
-
getIfPresent
Description copied from interface:LocalCache
SeeCache.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 interfaceLocalCache<K,
V>
-
getIfPresentQuietly
Description copied from interface:LocalCache
SeeCache.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 interfaceLocalCache<K,
V>
-
getAllPresent
Description copied from interface:LocalCache
- Specified by:
getAllPresent
in interfaceLocalCache<K,
V>
-
put
-
put
Description copied from interface:LocalCache
SeeCache.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 interfaceLocalCache<K,
V>
-
putIfAbsent
- Specified by:
putIfAbsent
in interfaceConcurrentMap<K,
V> - Specified by:
putIfAbsent
in interfaceMap<K,
V>
-
putFast
Adds a node to the policy and the data store. If an existing node is found, then its value is updated if allowed. This implementation is optimized for writing values with a non-zero weight. A zero weight is incompatible due to the potential for the update to race with eviction, where the entry should no longer be eligible if the update was successful. This implementation is ~50% faster thanputSlow(K, V, int, boolean, boolean)
due to not incurring the penalty of a compute and lambda in the common case.- Parameters:
key
- key with which the specified value is to be associatedvalue
- value to be associated with the specified keynotifyWriter
- if the writer should be notified for an inserted or updated entryonlyIfAbsent
- a write is performed only if the key is not already associated with a value- Returns:
- the prior value in or null if no mapping was found
-
putSlow
Adds a node to the policy and the data store. If an existing node is found, then its value is updated if allowed. This implementation is strict by using a compute to block other writers to that entry. This guards against an eviction trying to discard an entry concurrently (and successfully) updated to have a zero weight. The penalty is 50% of the throughput when compared toputFast(K, V, int, boolean, boolean)
.- Parameters:
key
- key with which the specified value is to be associatedvalue
- value to be associated with the specified keynotifyWriter
- if the writer should be notified for an inserted or updated entryonlyIfAbsent
- a write is performed only if the key is not already associated with a value- Returns:
- the prior value or null if no mapping was found
-
remove
-
removeNoWriter
Removes the mapping for a key without notifying the writer.- Parameters:
key
- key whose mapping is to be removed- Returns:
- the removed value or null if no mapping was found
-
removeWithWriter
Removes the mapping for a key after notifying the writer.- Parameters:
key
- key whose mapping is to be removed- Returns:
- the removed value or null if no mapping was found
-
remove
-
replace
-
replace
-
replaceAll
- Specified by:
replaceAll
in interfaceConcurrentMap<K,
V> - Specified by:
replaceAll
in interfaceMap<K,
V>
-
computeIfAbsent
public V computeIfAbsent(K key, Function<? super K, ? extends V> mappingFunction, boolean recordStats, boolean recordLoad) Description copied from interface:LocalCache
SeeConcurrentMap.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 interfaceLocalCache<K,
V>
-
doComputeIfAbsent
V doComputeIfAbsent(K key, Object keyRef, Function<? super K, ? extends V> mappingFunction, long now) Returns the current value from a computeIfAbsent invocation. -
computeIfPresent
- Specified by:
computeIfPresent
in interfaceConcurrentMap<K,
V> - Specified by:
computeIfPresent
in interfaceMap<K,
V>
-
compute
public V compute(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, boolean recordMiss, boolean recordLoad) Description copied from interface:LocalCache
SeeConcurrentMap.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 interfaceLocalCache<K,
V>
-
merge
-
remap
V remap(K key, Object keyRef, BiFunction<? super K, ? super V, ? extends V> remappingFunction, long now, boolean computeIfAbsent) Attempts to compute a mapping for the specified key and its current mapped value (ornull
if there is no current mapping).An entry that has expired or been reference collected is evicted and the computation continues as if the entry had not been present. This method does not pre-screen and does not wrap the remappingFuntion to be statistics aware.
- Parameters:
key
- key with which the specified value is to be associatedkeyRef
- the key to associate with or a lookup only key if not computeIfAbsentremappingFunction
- the function to compute a valuenow
- the current time, according to the tickercomputeIfAbsent
- if an absent entry can be computed- Returns:
- the new value associated with the specified key, or null if none
-
keySet
-
values
-
entrySet
-
evictionOrder
Returns an unmodifiable snapshot map ordered in eviction order, either ascending or descending. Beware that obtaining the mappings is NOT a constant-time operation.- Parameters:
limit
- the maximum number of entriestransformer
- a function that unwraps the valuehottest
- the iteration order- Returns:
- an unmodifiable snapshot in a specified order
-
expireAfterAcessOrder
Returns an unmodifiable snapshot map ordered in access expiration order, either ascending or descending. Beware that obtaining the mappings is NOT a constant-time operation.- Parameters:
limit
- the maximum number of entriestransformer
- a function that unwraps the valueoldest
- the iteration order- Returns:
- an unmodifiable snapshot in a specified order
-
expireAfterWriteOrder
Returns an unmodifiable snapshot map ordered in write expiration order, either ascending or descending. Beware that obtaining the mappings is NOT a constant-time operation.- Parameters:
limit
- the maximum number of entriestransformer
- a function that unwraps the valueoldest
- the iteration order- Returns:
- an unmodifiable snapshot in a specified order
-
snapshot
Map<K,V> snapshot(Supplier<Iterator<Node<K, V>>> iteratorSupplier, Function<V, V> transformer, int limit) Returns an unmodifiable snapshot map ordered by the provided iterator. Beware that obtaining the mappings is NOT a constant-time operation.- Parameters:
iteratorSupplier
- the iteratorlimit
- the maximum number of entriestransformer
- a function that unwraps the value- Returns:
- an unmodifiable snapshot in the iterator's order
-
makeSerializationProxy
static <K,V> SerializationProxy<K,V> makeSerializationProxy(BoundedLocalCache<?, ?> cache, boolean isWeighted) Creates a serialization proxy based on the common configuration shared by all cache types.
-