Class NamedCache
java.lang.Object
io.fluxcapacitor.javaclient.persisting.caching.NamedCache
- All Implemented Interfaces:
Cache
A
Cache
implementation that wraps a delegate cache and applies a transformation to each key (ID) before
delegating operations to the underlying cache.
This allows multiple cache users to safely share the same underlying Cache
instance without risk of key
collisions. Typical use cases include namespacing by type, context, or scope.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
Removes all entries from the cache.void
close()
Closes the cache and releases all associated resources.<T> T
compute
(Object id, BiFunction<? super Object, ? super T, ? extends T> mappingFunction) Computes and stores a new value for the givenid
using the provided function.<T> T
computeIfAbsent
(Object id, Function<? super Object, T> mappingFunction) If a value is not already associated with the givenid
, computes and stores one using the given function.<T> T
computeIfPresent
(Object id, BiFunction<? super Object, ? super T, ? extends T> mappingFunction) If a value is already associated with the givenid
, computes a new value using the provided function and replaces the old one.boolean
containsKey
(Object id) Checks whether the cache contains an entry for the givenid
.<T> T
Retrieves the value associated with the givenid
, ornull
if not found.<T> void
modifyEach
(BiFunction<? super Object, ? super T, ? extends T> modifierFunction) Applies the given modifier function to all values currently in the cache.Puts a value in the cache for the givenid
, overwriting any existing value.putIfAbsent
(Object id, @NonNull Object value) Associates the specified value with the givenid
only if no value is currently associated.registerEvictionListener
(Consumer<CacheEviction> listener) Registers a listener to be notified whenever a cache entry is evicted or removed.<T> T
Removes the entry associated with the givenid
, if present.int
size()
Returns the number of entries currently stored in the cache.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface io.fluxcapacitor.javaclient.persisting.caching.Cache
getOrDefault, isEmpty
-
Constructor Details
-
NamedCache
public NamedCache()
-
-
Method Details
-
put
Description copied from interface:Cache
Puts a value in the cache for the givenid
, overwriting any existing value. -
putIfAbsent
Description copied from interface:Cache
Associates the specified value with the givenid
only if no value is currently associated.- Specified by:
putIfAbsent
in interfaceCache
- Parameters:
id
- the key to check for presencevalue
- the value to associate if absent- Returns:
- the existing value associated with the key, or
null
if the new value was successfully put
-
computeIfAbsent
Description copied from interface:Cache
If a value is not already associated with the givenid
, computes and stores one using the given function.- Specified by:
computeIfAbsent
in interfaceCache
- Type Parameters:
T
- the expected type of the value- Parameters:
id
- the key to check or computemappingFunction
- the function to compute a value if absent- Returns:
- the current or newly computed value
-
computeIfPresent
public <T> T computeIfPresent(Object id, BiFunction<? super Object, ? super T, ? extends T> mappingFunction) Description copied from interface:Cache
If a value is already associated with the givenid
, computes a new value using the provided function and replaces the old one.- Specified by:
computeIfPresent
in interfaceCache
- Type Parameters:
T
- the expected type of the value- Parameters:
id
- the key to compute formappingFunction
- the function to compute a new value from the current one- Returns:
- the newly computed value, or
null
if the mapping function returnednull
-
compute
Description copied from interface:Cache
Computes and stores a new value for the givenid
using the provided function.The previous value (if any) is provided to the function. The result is stored in the cache.
-
modifyEach
Description copied from interface:Cache
Applies the given modifier function to all values currently in the cache.This is useful for bulk modifications, e.g. adjusting internal state after a system-wide change.
- Specified by:
modifyEach
in interfaceCache
- Type Parameters:
T
- the expected type of the values- Parameters:
modifierFunction
- the function to apply to each entry
-
get
Description copied from interface:Cache
Retrieves the value associated with the givenid
, ornull
if not found. -
containsKey
Description copied from interface:Cache
Checks whether the cache contains an entry for the givenid
.- Specified by:
containsKey
in interfaceCache
- Parameters:
id
- the key to check- Returns:
true
if the key exists in the cache,false
otherwise
-
remove
Description copied from interface:Cache
Removes the entry associated with the givenid
, if present. -
clear
public void clear()Description copied from interface:Cache
Removes all entries from the cache. -
size
public int size()Description copied from interface:Cache
Returns the number of entries currently stored in the cache. -
registerEvictionListener
Description copied from interface:Cache
Registers a listener to be notified whenever a cache entry is evicted or removed.- Specified by:
registerEvictionListener
in interfaceCache
- Parameters:
listener
- a function that consumesCacheEviction
s- Returns:
- a registration that can be used to cancel the listener
-
close
public void close()Description copied from interface:Cache
Closes the cache and releases all associated resources.
-