Caffeine cache 3.1.8 · com.github.benmanes.caffeine.cache.LocalCache

Method Summary

Modifier and Type	Method and Description
public void	cleanUp() See `Cache#cleanUp`.
public default @Nullable V	compute(K key with which the specified value is to be associated key, BiFunction<? super K, ? super V, ? extends V> the remapping function to compute a value remappingFunction) Overrides default java.util.concurrent.ConcurrentMap.compute. Attempts to compute a mapping for the specified key and its current mapped value (or `null` if there is no current mapping).
public @Nullable V	compute(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, @Nullable Expiry<? super K, ? super V> expiry, boolean recordLoad, boolean recordLoadFailure) See `ConcurrentMap#compute`.
public default @Nullable V	computeIfAbsent(K key with which the specified value is to be associated key, Function<? super K, ? extends V> the mapping function to compute a value mappingFunction) Overrides default java.util.concurrent.ConcurrentMap.computeIfAbsent. If the specified key is not already associated with a value (or is mapped to `null`), attempts to compute its value using the given mapping function and enters it into this map unless `null`.
public @Nullable V	computeIfAbsent(K key, Function<? super K, ? extends V> mappingFunction, boolean recordStats, boolean recordLoad) See `ConcurrentMap#computeIfAbsent`.
public long	estimatedSize() See `Cache#estimatedSize()`.
public Executor	executor() Returns the `Executor` used by this cache.
public @Nullable Expiry<K, V>	expiry() Returns the `Expiry` used by this cache.
public Map<K, V>	getAllPresent(Iterable<? extends K> keys) See `Cache#getAllPresent`.
public @Nullable V	getIfPresent(K key, boolean recordStats) See `Cache#getIfPresent(K)`.
public @Nullable V	getIfPresentQuietly(K key) See `Cache#getIfPresent(K)`.
public default void	invalidateAll(Iterable<?> keys) See `Cache#invalidateAll(Iterable)`.
public boolean	isAsync() Returns whether this cache is asynchronous.
public boolean	isPendingEviction(K key) Returns whether an absent entry has expired or has been reference collected but has not yet been removed from the cache.
public boolean	isRecordingStats() Returns whether this cache has statistics enabled.
public default void	notifyOnReplace(K key, V oldValue, V newValue) Notify the removal listener of a replacement if the value reference was changed.
public void	notifyRemoval(@Nullable K key, @Nullable V value, RemovalCause cause) Asynchronously sends a removal notification to the listener.
public Object	referenceKey(K key) Returns the reference key.
public ConcurrentMap<Object, CompletableFuture<?>>	refreshes() Returns the map of in-flight refresh operations.
public boolean	replace(K key, V oldValue, V newValue, boolean shouldDiscardRefresh) See `ConcurrentMap#replace(K, K, V)`.
public default <T, R> Function<? super T, ? extends R>	statsAware(Function<? super T, ? extends R> mappingFunction, boolean recordLoad) Decorates the remapping function to record statistics if enabled.
public default <T, U, R> BiFunction<? super T, ? super U, ? extends R>	statsAware(BiFunction<? super T, ? super U, ? extends R> remappingFunction) Decorates the remapping function to record statistics if enabled.
public default <T, U, R> BiFunction<? super T, ? super U, ? extends R>	statsAware(BiFunction<? super T, ? super U, ? extends R> remappingFunction, boolean recordLoad, boolean recordLoadFailure) Decorates the remapping function to record statistics if enabled.
public StatsCounter	statsCounter() Returns the `StatsCounter` used by this cache.
public Ticker	statsTicker() Returns the `Ticker` used by this cache for statistics.

Inherited from java.util.concurrent.ConcurrentMap:: computeIfPresent forEach getOrDefault merge putIfAbsent remove replace replace replaceAll

Method Detail

cleanUp	back to summary
public void cleanUp() See `Cache#cleanUp`.

compute back to summary

compute	back to summary
public default @Nullable V compute(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction) Overrides default java.util.concurrent.ConcurrentMap.compute. Doc from java.util.concurrent.ConcurrentMap.compute. Attempts to compute a mapping for the specified key and its current mapped value (or `null` if there is no current mapping). For example, to either create or append a `String` msg to a value mapping: `map.compute(key, (k, v) -> (v == null) ? msg : v.concat(msg))` (Method `merge()` is often simpler to use for such purposes.) If the remapping function returns `null`, the mapping is removed (or remains absent if initially absent). If the remapping function itself throws an (unchecked) exception, the exception is rethrown, and the current mapping is left unchanged. The remapping function should not modify this map during computation. Parameters key:K Doc from java.util.Map.compute. key with which the specified value is to be associated remappingFunction:BiFunction<? super K, ? super V, ? extends V> Doc from java.util.Map.compute. the remapping function to compute a value Returns:@Nullable V Doc from java.util.Map.compute. the new value associated with the specified key, or null if none Annotations @Override

public default @Nullable V compute(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction)

Overrides default java.util.concurrent.ConcurrentMap.compute.

Doc from java.util.concurrent.ConcurrentMap.compute.

Attempts to compute a mapping for the specified key and its current mapped value (or null if there is no current mapping). For example, to either create or append a String msg to a value mapping:

 map.compute(key, (k, v) -> (v == null) ? msg : v.concat(msg))

(Method merge() is often simpler to use for such purposes.)

If the remapping function returns null, the mapping is removed (or remains absent if initially absent). If the remapping function itself throws an (unchecked) exception, the exception is rethrown, and the current mapping is left unchanged.

The remapping function should not modify this map during computation.

Parameters

key:K

Doc from java.util.Map.compute.

key with which the specified value is to be associated

remappingFunction:BiFunction<? super K, ? super V, ? extends V>

Doc from java.util.Map.compute.

the remapping function to compute a value

Returns:@Nullable V

Doc from java.util.Map.compute.

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

Annotations

@Override

compute	back to summary
public @Nullable V compute(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, @Nullable Expiry<? super K, ? super V> expiry, boolean recordLoad, boolean recordLoadFailure) See `ConcurrentMap#compute`. This method differs by accepting parameters indicating whether to record load statistics based on the success of this operation.

computeIfAbsent back to summary

computeIfAbsent	back to summary
public default @Nullable V computeIfAbsent(K key, Function<? super K, ? extends V> mappingFunction) Overrides default java.util.concurrent.ConcurrentMap.computeIfAbsent. Doc from java.util.concurrent.ConcurrentMap.computeIfAbsent. If the specified key is not already associated with a value (or is mapped to `null`), attempts to compute its value using the given mapping function and enters it into this map unless `null`. If the mapping function returns `null`, no mapping is recorded. If the mapping function itself throws an (unchecked) exception, the exception is rethrown, and no mapping is recorded. The most common usage is to construct a new object serving as an initial mapped value or memoized result, as in: `map.computeIfAbsent(key, k -> new Value(f(k)));` Or to implement a multi-value map, `Map<K,Collection<V>>`, supporting multiple values per key: `map.computeIfAbsent(key, k -> new HashSet<V>()).add(v);` The mapping function should not modify this map during computation. Parameters key:K Doc from java.util.Map.computeIfAbsent. key with which the specified value is to be associated mappingFunction:Function<? super K, ? extends V> Doc from java.util.Map.computeIfAbsent. the mapping function to compute a value Returns:@Nullable V Doc from java.util.Map.computeIfAbsent. the current (existing or computed) value associated with the specified key, or null if the computed value is null Annotations @Override

public default @Nullable V computeIfAbsent(K key, Function<? super K, ? extends V> mappingFunction)

Overrides default java.util.concurrent.ConcurrentMap.computeIfAbsent.

Doc from java.util.concurrent.ConcurrentMap.computeIfAbsent.

If the specified key is not already associated with a value (or is mapped to null), attempts to compute its value using the given mapping function and enters it into this map unless null.

If the mapping function returns null, no mapping is recorded. If the mapping function itself throws an (unchecked) exception, the exception is rethrown, and no mapping is recorded. The most common usage is to construct a new object serving as an initial mapped value or memoized result, as in:

 map.computeIfAbsent(key, k -> new Value(f(k)));

Or to implement a multi-value map, Map<K,Collection<V>>, supporting multiple values per key:

 map.computeIfAbsent(key, k -> new HashSet<V>()).add(v);

The mapping function should not modify this map during computation.

Parameters

key:K

Doc from java.util.Map.computeIfAbsent.

key with which the specified value is to be associated

mappingFunction:Function<? super K, ? extends V>

Doc from java.util.Map.computeIfAbsent.

the mapping function to compute a value

Returns:@Nullable V

Doc from java.util.Map.computeIfAbsent.

the current (existing or computed) value associated with the specified key, or null if the computed value is null

Annotations

@Override

computeIfAbsent	back to summary
public @Nullable V computeIfAbsent(K key, Function<? super K, ? extends V> mappingFunction, boolean recordStats, boolean recordLoad) See `ConcurrentMap#computeIfAbsent`. This method differs by accepting parameters indicating how to record statistics.

estimatedSize	back to summary
public long estimatedSize() See `Cache#estimatedSize()`.

executor	back to summary
public Executor executor() Returns the `Executor` used by this cache.

expiry	back to summary
public @Nullable Expiry<K, V> expiry() Returns the `Expiry` used by this cache.

getAllPresent	back to summary
public Map<K, V> getAllPresent(Iterable<? extends K> keys) See `Cache#getAllPresent`.

getIfPresent	back to summary
public @Nullable V getIfPresent(K key, boolean recordStats) See `Cache#getIfPresent(K)`. This method differs by accepting a parameter of whether to record the hit-and-miss statistics based on the success of this operation.

getIfPresentQuietly	back to summary
public @Nullable V getIfPresentQuietly(K key) See `Cache#getIfPresent(K)`. This method differs by not recording the access with the statistics nor the eviction policy.

invalidateAll	back to summary
public default void invalidateAll(Iterable<?> keys) See `Cache#invalidateAll(Iterable)`.

isAsync	back to summary
public boolean isAsync() Returns whether this cache is asynchronous.

isPendingEviction	back to summary
public boolean isPendingEviction(K key) Returns whether an absent entry has expired or has been reference collected but has not yet been removed from the cache.

isRecordingStats	back to summary
public boolean isRecordingStats() Returns whether this cache has statistics enabled.

notifyOnReplace	back to summary
public default void notifyOnReplace(K key, V oldValue, V newValue) Notify the removal listener of a replacement if the value reference was changed. Annotations @SuppressWarnings:FutureReturnValueIgnored

notifyOnReplace

back to summary

public default void notifyOnReplace(K key, V oldValue, V newValue)

Notify the removal listener of a replacement if the value reference was changed.

Annotations

@SuppressWarnings:FutureReturnValueIgnored

notifyRemoval	back to summary
public void notifyRemoval(@Nullable K key, @Nullable V value, RemovalCause cause) Asynchronously sends a removal notification to the listener.

referenceKey	back to summary
public Object referenceKey(K key) Returns the reference key.

refreshes	back to summary
public ConcurrentMap<Object, CompletableFuture<?>> refreshes() Returns the map of in-flight refresh operations.

replace	back to summary
public boolean replace(K key, V oldValue, V newValue, boolean shouldDiscardRefresh) See `ConcurrentMap#replace(K, K, V)`. This method differs by optionally not discarding an in-flight refresh for the entry if replaced.

statsAware	back to summary
public default <T, R> Function<? super T, ? extends R> statsAware(Function<? super T, ? extends R> mappingFunction, boolean recordLoad) Decorates the remapping function to record statistics if enabled.

statsAware	back to summary
public default <T, U, R> BiFunction<? super T, ? super U, ? extends R> statsAware(BiFunction<? super T, ? super U, ? extends R> remappingFunction) Decorates the remapping function to record statistics if enabled.

statsAware	back to summary
public default <T, U, R> BiFunction<? super T, ? super U, ? extends R> statsAware(BiFunction<? super T, ? super U, ? extends R> remappingFunction, boolean recordLoad, boolean recordLoadFailure) Decorates the remapping function to record statistics if enabled.

statsCounter	back to summary
public StatsCounter statsCounter() Returns the `StatsCounter` used by this cache.

statsTicker	back to summary
public Ticker statsTicker() Returns the `Ticker` used by this cache for statistics.

pack-priv Interface LocalCache<K, V>

Method Summary

Method Detail