Package org.infinispan.cache.impl

Class DecoratedCache<K,V>

java.lang.Object

org.infinispan.cache.impl.AbstractDelegatingCache<K,V>

org.infinispan.cache.impl.AbstractDelegatingAdvancedCache<K,V>

org.infinispan.cache.impl.DecoratedCache<K,V>

All Implemented Interfaces:

ConcurrentMap<K,V>, Map<K,V>, AdvancedCache<K,V>, Cache<K,V>, InternalCache<K,V>, AsyncCache<K,V>, BasicCache<K,V>, BatchingCache, Lifecycle, TransactionalCache, FilteringListenable<K,V>, Listenable

public class DecoratedCache<K,V>
extends AbstractDelegatingAdvancedCache<K,V>

A decorator to a cache, which can be built with a specific set of Flags. This set of Flags will be applied to all cache invocations made via this decorator.

In addition to cleaner and more readable code, this approach offers a performance benefit to using AdvancedCache.withFlags(Flag...) API, thanks to internal optimizations that can be made when the Flag set is unchanging.

Note that DecoratedCache must be the closest Delegate to the actual Cache implementation. All others must delegate to this DecoratedCache.

Since:

5.1

Author:

Manik Surtani, Sanne Grinovero, Tristan Tarrant

See Also:

• AdvancedCache.withFlags(Flag...)

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields inherited from class org.infinispan.cache.impl.AbstractDelegatingAdvancedCache

cache

Constructor Summary

Constructors

Constructor	Description
DecoratedCache(CacheImpl<K,V> delegate, long flagsBitSet)
DecoratedCache(CacheImpl<K,V> delegate, Object lockOwner, long newFlags)

Method Summary

Modifier and Type	Method	Description
<C> CompletionStage<Void>	addFilteredListenerAsync(Object listener, CacheEventFilter<? super K,? super V> filter, CacheEventConverter<? super K,? super V,C> converter, Set<Class<? extends Annotation>> filterAnnotations)	Asynchronous version of FilteringListenable.addFilteredListener(Object, CacheEventFilter, CacheEventConverter, Set)
CompletionStage<Void>	addListenerAsync(Object listener)	Asynchronous version of Listenable.addListener(Object)
<C> CompletionStage<Void>	addListenerAsync(Object listener, CacheEventFilter<? super K,? super V> filter, CacheEventConverter<? super K,? super V,C> converter)	Asynchronous version of FilteringListenable.addListener(Object, CacheEventFilter, CacheEventConverter)
<C> CompletionStage<Void>	addStorageFormatFilteredListenerAsync(Object listener, CacheEventFilter<? super K,? super V> filter, CacheEventConverter<? super K,? super V,C> converter, Set<Class<? extends Annotation>> filterAnnotations)	Asynchronous version of FilteringListenable.addStorageFormatFilteredListener(Object, CacheEventFilter, CacheEventConverter, Set)
CacheSet<CacheEntry<K,V>>	cacheEntrySet()	Identical to Cache.entrySet() but is typed to return CacheEntries instead of Entries.
void	clear()	Removes all mappings from the cache.
CompletableFuture<Void>	clearAsync()	Asynchronous version of Map.clear().
V	compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
V	compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, Metadata metadata)	An overloaded form of Cache.compute(Object, BiFunction), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.
CompletableFuture<V>	computeAsync(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)	Asynchronous version of ConcurrentMap.compute(Object, BiFunction).
V	computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction)
V	computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction, Metadata metadata)	An overloaded form of Cache.computeIfAbsent(Object, Function), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.
CompletableFuture<V>	computeIfAbsentAsync(K key, Function<? super K,? extends V> mappingFunction)	Asynchronous version of ConcurrentMap.computeIfAbsent(Object, Function).
V	computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
V	computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, Metadata metadata)	An overloaded form of Cache.computeIfPresent(Object, BiFunction), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.
CompletableFuture<V>	computeIfPresentAsync(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)	Asynchronous version of ConcurrentMap.computeIfPresent(Object, BiFunction).
boolean	containsKey(Object key)
boolean	containsValue(Object value)
CacheSet<Map.Entry<K,V>>	entrySet()	Returns a set view of the mappings contained in this cache and cache loader across the entire cluster.
void	evict(K key)	Evicts an entry from the memory of the cache.
V	get(Object key)
Map<K,V>	getAll(Set<?> keys)	Gets a collection of entries, returning them as Map of the values associated with the set of keys requested.
CompletableFuture<Map<K,V>>	getAllAsync(Set<?> keys)	TODO This should be in AdvancedCache with getAll
Map<K,CacheEntry<K,V>>	getAllCacheEntries(Set<?> keys)	Gets a collection of entries from the AdvancedCache, returning them as Map of the cache entries associated with the set of keys requested.
CompletableFuture<V>	getAsync(K key)	Asynchronous version of Map.get(Object) that allows user code to retrieve the value associated with a key at a later stage, hence allowing multiple parallel get requests to be sent.
CacheEntry<K,V>	getCacheEntry(Object key)	Retrieves a CacheEntry corresponding to a specific key.
CompletableFuture<CacheEntry<K,V>>	getCacheEntryAsync(Object key)	Retrieves a CacheEntry corresponding to a specific key.
ClassLoader	getClassLoader()	Returns the cache loader associated with this cache.
long	getFlagsBitSet()
Map<K,V>	getGroup(String groupName)	It fetches all the keys which belong to the group.
Object	getLockOwner()
boolean	isEmpty()
CacheSet<K>	keySet()	Returns a set view of the keys contained in this cache and cache loader across the entire cluster.
boolean	lock(Collection<? extends K> keys)	Locks collections of keys eagerly across cache nodes in a cluster.
boolean	lock(K... keys)	Locks a given key or keys eagerly across cache nodes in a cluster.
AdvancedCache<K,V>	lockAs(Object lockOwner)	Whenever this cache acquires a lock it will do so using the given Object as the owner of said lock.
LockedStream<K,V>	lockedStream()	Returns a sequential stream using this Cache as the source.
V	merge(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction)
V	merge(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction, Metadata metadata)	An overloaded form of Cache.merge(Object, Object, BiFunction), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.
CompletableFuture<V>	mergeAsync(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction)	Asynchronous version of ConcurrentMap.merge(Object, Object, BiFunction).
protected DecoratedCache<K,V>	newInstance(CacheImpl<K,V> impl, Object lockOwner, long newFlags)
AdvancedCache<K,V>	noFlags()	Unset all flags set on this cache using AdvancedCache.withFlags(Flag...) or AdvancedCache.withFlags(Collection) methods.
V	put(K key, V value)	If the return value of this operation will be ignored by the application, the user is strongly encouraged to use the Flag.IGNORE_RETURN_VALUES flag when invoking this method in order to make it behave as efficiently as possible (i.e.
V	put(K key, V value, long lifespan, TimeUnit unit)	An overloaded form of BasicCache.put(Object, Object), which takes in lifespan parameters.
V	put(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)	An overloaded form of BasicCache.put(Object, Object), which takes in lifespan parameters.
V	put(K key, V value, Metadata metadata)	An overloaded form of BasicCache.put(Object, Object), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.
void	putAll(Map<? extends K,? extends V> m)
void	putAll(Map<? extends K,? extends V> map, long lifespan, TimeUnit unit)	An overloaded form of Map.putAll(Map), which takes in lifespan parameters.
void	putAll(Map<? extends K,? extends V> map, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)	An overloaded form of Map.putAll(Map), which takes in lifespan parameters.
void	putAll(Map<? extends K,? extends V> map, Metadata metadata)	An overloaded form of Map.putAll(Map), which takes in an instance of Metadata which can be used to provide metadata information for the entries being stored, such as lifespan, version of value...etc.
CompletableFuture<Void>	putAllAsync(Map<? extends K,? extends V> data)	Asynchronous version of Map.putAll(Map).
CompletableFuture<Void>	putAllAsync(Map<? extends K,? extends V> data, long lifespan, TimeUnit unit)	Asynchronous version of BasicCache.putAll(Map, long, TimeUnit).
CompletableFuture<Void>	putAllAsync(Map<? extends K,? extends V> data, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)	Asynchronous version of BasicCache.putAll(Map, long, TimeUnit, long, TimeUnit).
CompletableFuture<Void>	putAllAsync(Map<? extends K,? extends V> data, Metadata metadata)
CompletableFuture<V>	putAsync(K key, V value)	Asynchronous version of BasicCache.put(Object, Object).
CompletableFuture<V>	putAsync(K key, V value, long lifespan, TimeUnit unit)	Asynchronous version of BasicCache.put(Object, Object, long, TimeUnit) .
CompletableFuture<V>	putAsync(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)	Asynchronous version of BasicCache.put(Object, Object, long, TimeUnit, long, TimeUnit).
CompletableFuture<V>	putAsync(K key, V value, Metadata metadata)	Asynchronous version of AdvancedCache.put(Object, Object, Metadata) which stores metadata alongside the value.
CompletableFuture<CacheEntry<K,V>>	putAsyncEntry(K key, V value, Metadata metadata)	Extension of AdvancedCache.putAsync(Object, Object, Metadata) which returns a CacheEntry instead of only the previous value.
void	putForExternalRead(K key, V value)	Under special operating behavior, associates the value with the specified key.
void	putForExternalRead(K key, V value, long lifespan, TimeUnit unit)	An overloaded form of Cache.putForExternalRead(K, V), which takes in lifespan parameters.
void	putForExternalRead(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)	An overloaded form of Cache.putForExternalRead(K, V), which takes in lifespan parameters.
void	putForExternalRead(K key, V value, Metadata metadata)	An overloaded form of Cache.putForExternalRead(Object, Object), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.
V	putIfAbsent(K key, V value)
V	putIfAbsent(K key, V value, long lifespan, TimeUnit unit)	An overloaded form of ConcurrentMap.putIfAbsent(Object, Object), which takes in lifespan parameters.
V	putIfAbsent(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)	An overloaded form of ConcurrentMap.putIfAbsent(Object, Object), which takes in lifespan parameters.
V	putIfAbsent(K key, V value, Metadata metadata)	An overloaded form of ConcurrentMap.putIfAbsent(Object, Object), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.
CompletableFuture<V>	putIfAbsentAsync(K key, V value)	Asynchronous version of ConcurrentMap.putIfAbsent(Object, Object).
CompletableFuture<V>	putIfAbsentAsync(K key, V value, long lifespan, TimeUnit unit)	Asynchronous version of BasicCache.putIfAbsent(Object, Object, long, TimeUnit) .
CompletableFuture<V>	putIfAbsentAsync(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)	Asynchronous version of BasicCache.putIfAbsent(Object, Object, long, TimeUnit, long, TimeUnit).
CompletableFuture<V>	putIfAbsentAsync(K key, V value, Metadata metadata)	An overloaded form of AsyncCache.putIfAbsentAsync(Object, Object), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.
CompletableFuture<CacheEntry<K,V>>	putIfAbsentAsyncEntry(K key, V value, Metadata metadata)	An extension form of AdvancedCache.putIfAbsentAsync(Object, Object, Metadata), which returns a CacheEntry instead of only the value.
protected InvocationContext	readContext(int size)
V	remove(Object key)	If the return value of this operation will be ignored by the application, the user is strongly encouraged to use the Flag.IGNORE_RETURN_VALUES flag when invoking this method in order to make it behave as efficiently as possible (i.e.
boolean	remove(Object key, Object value)
CompletableFuture<V>	removeAsync(Object key)	Asynchronous version of BasicCache.remove(Object).
CompletableFuture<Boolean>	removeAsync(Object key, Object value)	Asynchronous version of ConcurrentMap.remove(Object, Object).
CompletableFuture<CacheEntry<K,V>>	removeAsyncEntry(Object key)	An extension of AsyncCache.removeAsync(Object), which returns a CacheEntry instead of only the value.
void	removeGroup(String groupName)	It removes all the key which belongs to a group.
CompletableFuture<Boolean>	removeLifespanExpired(K key, V value, Long lifespan)	Attempts to remove the entry if it is expired.
CompletableFuture<Boolean>	removeMaxIdleExpired(K key, V value)	Attempts to remove the entry for the given key, if it has expired due to max idle.
V	replace(K key, V value)
V	replace(K key, V value, long lifespan, TimeUnit unit)	An overloaded form of ConcurrentMap.replace(Object, Object), which takes in lifespan parameters.
V	replace(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)	An overloaded form of ConcurrentMap.replace(Object, Object), which takes in lifespan parameters.
V	replace(K key, V value, Metadata metadata)	An overloaded form of ConcurrentMap.replace(Object, Object), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.
boolean	replace(K key, V oldValue, V newValue)
boolean	replace(K key, V oldValue, V value, long lifespan, TimeUnit unit)	An overloaded form of ConcurrentMap.replace(Object, Object, Object), which takes in lifespan parameters.
boolean	replace(K key, V oldValue, V value, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)	An overloaded form of ConcurrentMap.replace(Object, Object, Object), which takes in lifespan parameters.
boolean	replace(K key, V oldValue, V value, Metadata metadata)	An overloaded form of ConcurrentMap.replace(Object, Object, Object), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.
CompletableFuture<V>	replaceAsync(K key, V value)	Asynchronous version of ConcurrentMap.replace(Object, Object).
CompletableFuture<V>	replaceAsync(K key, V value, long lifespan, TimeUnit unit)	Asynchronous version of BasicCache.replace(Object, Object, long, TimeUnit).
CompletableFuture<V>	replaceAsync(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)	Asynchronous version of BasicCache.replace(Object, Object, long, TimeUnit, long, TimeUnit).
CompletableFuture<V>	replaceAsync(K key, V value, Metadata metadata)	An overloaded form of AsyncCache.replaceAsync(Object, Object), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.
CompletableFuture<Boolean>	replaceAsync(K key, V oldValue, V newValue)	Asynchronous version of ConcurrentMap.replace(Object, Object, Object).
CompletableFuture<Boolean>	replaceAsync(K key, V oldValue, V newValue, long lifespan, TimeUnit unit)	Asynchronous version of BasicCache.replace(Object, Object, Object, long, TimeUnit).
CompletableFuture<Boolean>	replaceAsync(K key, V oldValue, V newValue, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)	Asynchronous version of BasicCache.replace(Object, Object, Object, long, TimeUnit, long, TimeUnit).
CompletableFuture<Boolean>	replaceAsync(K key, V oldValue, V newValue, Metadata metadata)
CompletableFuture<CacheEntry<K,V>>	replaceAsyncEntry(K key, V value, Metadata metadata)	An extension of AdvancedCache.replaceAsync(Object, Object, Metadata), which returns a CacheEntry instead of only the value.
AdvancedCache	rewrap(AdvancedCache newDelegate)	No generics because some methods return AdvancedCache<?, ?>, and returning the proper type would require erasure anyway.
int	size()	Returns a count of all elements in this cache and cache loader across the entire cluster.
CompletableFuture<Long>	sizeAsync()	Asynchronous version of Map.size().
void	stop()	Stops a cache.
CacheCollection<V>	values()	Returns a collection view of the values contained in this cache across the entire cluster.
AdvancedCache<K,V>	withEncoding(Class<? extends Encoder> encoderClass)	Performs any cache operations using the specified Encoder.
AdvancedCache<K,V>	withEncoding(Class<? extends Encoder> keyEncoderClass, Class<? extends Encoder> valueEncoderClass)	Performs any cache operations using the specified pair of Encoder.
AdvancedCache<K,V>	withFlags(Collection<Flag> flags)	An alternative to AdvancedCache.withFlags(Flag...) not requiring array allocation.
AdvancedCache<K,V>	withFlags(Flag flag)	An alternative to AdvancedCache.withFlags(Flag...) optimized for a single flag.
AdvancedCache<K,V>	withFlags(Flag... flags)	A method that adds flags to any API call.
AdvancedCache<K,V>	withWrapping(Class<? extends Wrapper> wrapperClass)	Deprecated, for removal: This API element is subject to removal in a future version.
AdvancedCache<K,V>	withWrapping(Class<? extends Wrapper> keyWrapperClass, Class<? extends Wrapper> valueWrapperClass)	Deprecated, for removal: This API element is subject to removal in a future version.
protected InvocationContext	writeContext(int size)

Methods inherited from class org.infinispan.cache.impl.AbstractDelegatingAdvancedCache

computeAsync, computeAsync, computeAsync, computeIfAbsentAsync, computeIfAbsentAsync, computeIfAbsentAsync, computeIfPresentAsync, computeIfPresentAsync, computeIfPresentAsync, getAdvancedCache, getAndPutAll, getAuthorizationManager, getAvailability, getBatchContainer, getCacheAvailability, getComponentRegistry, getDataContainer, getDistributionManager, getExpirationManager, getKeyDataConversion, getLockManager, getRpcManager, getStats, getTransactionManager, getValueDataConversion, getXAResource, isRebalancingEnabled, mergeAsync, mergeAsync, mergeAsync, setAvailability, setCacheAvailability, setRebalancingEnabled, touch, touch, transform, withKeyEncoding, withMediaType, withMediaType, withStorageMediaType, withSubject

Methods inherited from class org.infinispan.cache.impl.AbstractDelegatingCache

addFilteredListener, addListener, addListener, addStorageFormatFilteredListener, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, continuousQuery, endBatch, forEach, getCacheConfiguration, getCacheManager, getCacheName, getCacheStatus, getConfigurationAsProperties, getDelegate, getName, getOrDefault, getStatus, getVersion, merge, merge, query, removeListener, removeListenerAsync, replaceAll, shutdown, start, startBatch, toString, unwrapCache

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.AdvancedCache

compute, computeAsync, computeIfAbsent, computeIfAbsentAsync, computeIfPresent, computeIfPresentAsync, merge, mergeAsync

Methods inherited from interface org.infinispan.commons.api.AsyncCache

containsKeyAsync

Methods inherited from interface org.infinispan.commons.api.BasicCache

compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, continuousQuery, getName, getVersion, merge, merge, query

Methods inherited from interface org.infinispan.commons.api.BatchingCache

endBatch, startBatch

Methods inherited from interface org.infinispan.Cache

compute, compute, compute, computeAsync, computeAsync, computeAsync, computeIfAbsent, computeIfAbsent, computeIfAbsent, computeIfAbsentAsync, computeIfAbsentAsync, computeIfAbsentAsync, computeIfPresent, computeIfPresentAsync, getCacheConfiguration, getCacheManager, getStatus, merge, merge, merge, mergeAsync, mergeAsync, mergeAsync, shutdown

Methods inherited from interface java.util.concurrent.ConcurrentMap

forEach, getOrDefault, replaceAll

Methods inherited from interface org.infinispan.notifications.FilteringListenable

addFilteredListener, addListener, addStorageFormatFilteredListener

Methods inherited from interface org.infinispan.cache.impl.InternalCache

bypassInvocationContextFactory

Methods inherited from interface org.infinispan.commons.api.Lifecycle

start

Methods inherited from interface org.infinispan.notifications.Listenable

addListener, removeListener, removeListenerAsync

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Details

DecoratedCache

public DecoratedCache(CacheImpl<K,V> delegate,
 long flagsBitSet)

DecoratedCache

public DecoratedCache(CacheImpl<K,V> delegate,
 Object lockOwner,
 long newFlags)

Method Details

rewrap

public AdvancedCache rewrap(AdvancedCache newDelegate)

Description copied from class: AbstractDelegatingAdvancedCache

No generics because some methods return AdvancedCache<?, ?>, and returning the proper type would require erasure anyway.

Specified by:

rewrap in class AbstractDelegatingAdvancedCache<K,V>

withFlags

public AdvancedCache<K,V> withFlags(Flag... flags)

Description copied from interface: AdvancedCache

A method that adds flags to any API call. For example, consider the following code snippet:

   cache.withFlags(Flag.FORCE_WRITE_LOCK).get(key);
 

will invoke a cache.get() with a write lock forced.

Note that for the flag to take effect, the cache operation must be invoked on the instance returned by this method.

As an alternative to setting this on every invocation, users should also consider saving the decorated cache, as this allows for more readable code. E.g.:

    AdvancedCache<?, ?> forceWriteLockCache = cache.withFlags(Flag.FORCE_WRITE_LOCK);
    forceWriteLockCache.get(key1);
    forceWriteLockCache.get(key2);
    forceWriteLockCache.get(key3);
 

Specified by:

withFlags in interface AdvancedCache<K,V>

Overrides:

withFlags in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

flags - a set of flags to apply. See the Flag documentation.

Returns:

an AdvancedCache instance on which a real operation is to be invoked, if the flags are to be applied.

withFlags

public AdvancedCache<K,V> withFlags(Collection<Flag> flags)

Description copied from interface: AdvancedCache

An alternative to AdvancedCache.withFlags(Flag...) not requiring array allocation.

Specified by:

withFlags in interface AdvancedCache<K,V>

Overrides:

withFlags in class AbstractDelegatingAdvancedCache<K,V>

withFlags

public AdvancedCache<K,V> withFlags(Flag flag)

Description copied from interface: AdvancedCache

An alternative to AdvancedCache.withFlags(Flag...) optimized for a single flag.

Specified by:

withFlags in interface AdvancedCache<K,V>

Overrides:

withFlags in class AbstractDelegatingAdvancedCache<K,V>

newInstance

protected DecoratedCache<K,V> newInstance(CacheImpl<K,V> impl,
 Object lockOwner,
 long newFlags)

noFlags

public AdvancedCache<K,V> noFlags()

Description copied from interface: AdvancedCache

Unset all flags set on this cache using AdvancedCache.withFlags(Flag...) or AdvancedCache.withFlags(Collection) methods.

Specified by:

noFlags in interface AdvancedCache<K,V>

Overrides:

noFlags in class AbstractDelegatingAdvancedCache<K,V>

Returns:

Cache not applying any flags to the command; possibly this.

withEncoding

public AdvancedCache<K,V> withEncoding(Class<? extends Encoder> encoderClass)

Description copied from interface: AdvancedCache

Performs any cache operations using the specified Encoder.

Specified by:

withEncoding in interface AdvancedCache<K,V>

Overrides:

withEncoding in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

encoderClass - Encoder used for both keys and values.

Returns:

an instance of AdvancedCache where all operations will use the supplied encoder.

withEncoding

public AdvancedCache<K,V> withEncoding(Class<? extends Encoder> keyEncoderClass,
 Class<? extends Encoder> valueEncoderClass)

Description copied from interface: AdvancedCache

Performs any cache operations using the specified pair of Encoder.

Specified by:

withEncoding in interface AdvancedCache<K,V>

Overrides:

withEncoding in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

keyEncoderClass - Encoder for the keys.

valueEncoderClass - Encoder for the values.

Returns:

an instance of AdvancedCache where all operations will use the supplied encoders.

withWrapping

@Deprecated(forRemoval=true,
            since="11.0")
public AdvancedCache<K,V> withWrapping(Class<? extends Wrapper> wrapperClass)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: AdvancedCache

Performs any cache operations using the specified Wrapper.

Specified by:

withWrapping in interface AdvancedCache<K,V>

Overrides:

withWrapping in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

wrapperClass - Wrapper for the keys and values.

Returns:

an instance of AdvancedCache where all operations will use the supplied wrapper.

withWrapping

@Deprecated(forRemoval=true,
            since="11.0")
public AdvancedCache<K,V> withWrapping(Class<? extends Wrapper> keyWrapperClass,
 Class<? extends Wrapper> valueWrapperClass)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: AdvancedCache

Performs any cache operations using the specified pair of Wrapper.

Specified by:

withWrapping in interface AdvancedCache<K,V>

Overrides:

withWrapping in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

keyWrapperClass - Wrapper for the keys.

valueWrapperClass - Wrapper for the values.

Returns:

AdvancedCache where all operations will use the supplied wrappers.

lockAs

public AdvancedCache<K,V> lockAs(Object lockOwner)

Description copied from interface: AdvancedCache

Whenever this cache acquires a lock it will do so using the given Object as the owner of said lock.

This can be useful when a lock may have been manually acquired, and you wish to reuse that lock across invocations.

Great care should be taken with this command as misuse can very easily lead to deadlocks.

Specified by:

lockAs in interface AdvancedCache<K,V>

Overrides:

lockAs in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

lockOwner - the lock owner to lock any keys as

Returns:

an AdvancedCache instance on which when an operation is invoked it will use lock owner object to acquire any locks

getLockOwner

public Object getLockOwner()

lockedStream

public LockedStream<K,V> lockedStream()

Description copied from interface: AdvancedCache

Returns a sequential stream using this Cache as the source. This stream is very similar to using the CacheStream returned from the CacheCollection.stream() method of the collection returned via AdvancedCache.cacheEntrySet(). The use of this locked stream is that when an entry is being processed by the user the entry is locked for the invocation preventing a different thread from modifying it.

Note that this stream is not supported when using a optimistic transactional or simple cache. Both non transactional and pessimistic transactional caches are supported.

The stream will not share any ongoing transaction the user may have. Code executed by the stream should be treated as completely independent. That is any operation performed via the stream will require the user to start their own transaction or will be done intrinsically on the invocation. Note that if there is an ongoing transaction that has a lock on a key from the cache, that it will cause a deadlock.

Currently simple cache, ConfigurationBuilder.simpleCache(boolean) was set to true, and optimistic caches, TransactionConfigurationBuilder.lockingMode(LockingMode) was set to LockingMode.OPTIMISTIC, do not support this method. In this case it will throw an UnsupportedOperationException. This restriction may be removed in a future version. Also this method cannot be used on a cache that has a lock owner already specified via AdvancedCache.lockAs(Object) as this could lead to a deadlock or the release of locks early and will throw an IllegalStateException.

Specified by:

lockedStream in interface AdvancedCache<K,V>

Overrides:

lockedStream in class AbstractDelegatingAdvancedCache<K,V>

Returns:

the locked stream

getClassLoader

public ClassLoader getClassLoader()

Description copied from interface: AdvancedCache

Returns the cache loader associated with this cache. As an alternative to setting this on every invocation, users could also consider using the DecoratedCache wrapper.

Specified by:

getClassLoader in interface AdvancedCache<K,V>

Overrides:

getClassLoader in class AbstractDelegatingAdvancedCache<K,V>

Returns:

this cache's cache loader

stop

public void stop()

Description copied from interface: Cache

Stops a cache. If the cache is clustered, this only stops the cache on the node where it is being invoked. If you need to stop the cache across a cluster, use the Cache.shutdown() method.

Specified by:

stop in interface Cache<K,V>

Specified by:

stop in interface Lifecycle

Overrides:

stop in class AbstractDelegatingCache<K,V>

lock

public boolean lock(K... keys)

Description copied from interface: AdvancedCache

Locks a given key or keys eagerly across cache nodes in a cluster.

Keys can be locked eagerly in the context of a transaction only.

Specified by:

lock in interface AdvancedCache<K,V>

Overrides:

lock in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

keys - the keys to lock

Returns:

true if the lock acquisition attempt was successful for all keys; false will only be returned if the lock acquisition timed out and the operation has been called with Flag.FAIL_SILENTLY.

lock

public boolean lock(Collection<? extends K> keys)

Description copied from interface: AdvancedCache

Locks collections of keys eagerly across cache nodes in a cluster.

Collections of keys can be locked eagerly in the context of a transaction only.

Specified by:

lock in interface AdvancedCache<K,V>

Overrides:

lock in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

keys - collection of keys to lock

Returns:

true if the lock acquisition attempt was successful for all keys; false will only be returned if the lock acquisition timed out and the operation has been called with Flag.FAIL_SILENTLY.

putForExternalRead

public void putForExternalRead(K key,
 V value)

Description copied from interface: Cache

Under special operating behavior, associates the value with the specified key.

• Only goes through if the key specified does not exist; no-op otherwise (similar to ConcurrentMap.putIfAbsent(Object, Object))
• Force asynchronous mode for replication to prevent any blocking.
• invalidation does not take place.
• 0ms lock timeout to prevent any blocking here either. If the lock is not acquired, this method is a no-op, and swallows the timeout exception.
• Ongoing transactions are suspended before this call, so failures here will not affect any ongoing transactions.
• Errors and exceptions are 'silent' - logged at a much lower level than normal, and this method does not throw exceptions

This method is for caching data that has an external representation in storage, where, concurrent modification and transactions are not a consideration, and failure to put the data in the cache should be treated as a 'suboptimal outcome' rather than a 'failing outcome'.

An example of when this method is useful is when data is read from, for example, a legacy datastore, and is cached before returning the data to the caller. Subsequent calls would prefer to get the data from the cache and if the data doesn't exist in the cache, fetch again from the legacy datastore.

See JBCACHE-848 for details around this feature.

Specified by:

putForExternalRead in interface Cache<K,V>

Overrides:

putForExternalRead in class AbstractDelegatingCache<K,V>

Parameters:

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

value - value to be associated with the specified key.

putForExternalRead

public void putForExternalRead(K key,
 V value,
 Metadata metadata)

Description copied from interface: AdvancedCache

An overloaded form of Cache.putForExternalRead(Object, Object), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. The Metadata is only stored if the call is successful.

Specified by:

putForExternalRead in interface AdvancedCache<K,V>

Overrides:

putForExternalRead in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

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

value - value to be associated with the specified key

metadata - information to store alongside the new value

putForExternalRead

public void putForExternalRead(K key,
 V value,
 long lifespan,
 TimeUnit unit)

Description copied from interface: Cache

An overloaded form of Cache.putForExternalRead(K, V), which takes in lifespan parameters.

Specified by:

putForExternalRead in interface Cache<K,V>

Overrides:

putForExternalRead in class AbstractDelegatingCache<K,V>

Parameters:

key - key to use

value - value to store

lifespan - lifespan of the entry. Negative values are interpreted as unlimited lifespan.

unit - unit of measurement for the lifespan

putForExternalRead

public void putForExternalRead(K key,
 V value,
 long lifespan,
 TimeUnit lifespanUnit,
 long maxIdle,
 TimeUnit maxIdleUnit)

Description copied from interface: Cache

An overloaded form of Cache.putForExternalRead(K, V), which takes in lifespan parameters.

Specified by:

putForExternalRead in interface Cache<K,V>

Overrides:

putForExternalRead in class AbstractDelegatingCache<K,V>

Parameters:

key - key to use

value - value to store

lifespan - lifespan of the entry. Negative values are interpreted as unlimited lifespan.

lifespanUnit - time unit for lifespan

maxIdle - the maximum amount of time this key is allowed to be idle for before it is considered as expired

maxIdleUnit - time unit for max idle time

evict

public void evict(K key)

Description copied from interface: Cache

Evicts an entry from the memory of the cache. Note that the entry is not removed from any configured cache stores or any other caches in the cluster (if used in a clustered mode). Use BasicCache.remove(Object) to remove an entry from the entire cache system.

This method is designed to evict an entry from memory to free up memory used by the application. This method uses a 0 lock acquisition timeout so it does not block in attempting to acquire locks. It behaves as a no-op if the lock on the entry cannot be acquired immediately.

Important: this method should not be called from within a transaction scope.

Specified by:

evict in interface Cache<K,V>

Overrides:

evict in class AbstractDelegatingCache<K,V>

Parameters:

key - key to evict

put

public V put(K key,
 V value,
 long lifespan,
 TimeUnit unit)

Description copied from interface: BasicCache

An overloaded form of BasicCache.put(Object, Object), which takes in lifespan parameters.

Specified by:

put in interface BasicCache<K,V>

Overrides:

put in class AbstractDelegatingCache<K,V>

Parameters:

key - key to use

value - value to store

lifespan - lifespan of the entry. Negative values are interpreted as unlimited lifespan.

unit - unit of measurement for the lifespan

Returns:

the value being replaced, or null if nothing is being replaced.

putIfAbsent

public V putIfAbsent(K key,
 V value,
 long lifespan,
 TimeUnit unit)

Description copied from interface: BasicCache

An overloaded form of ConcurrentMap.putIfAbsent(Object, Object), which takes in lifespan parameters.

Specified by:

putIfAbsent in interface BasicCache<K,V>

Overrides:

putIfAbsent in class AbstractDelegatingCache<K,V>

Parameters:

key - key to use

value - value to store

lifespan - lifespan of the entry. Negative values are interpreted as unlimited lifespan.

unit - unit of measurement for the lifespan

Returns:

the value being replaced, or null if nothing is being replaced.

putAll

public void putAll(Map<? extends K,? extends V> map,
 long lifespan,
 TimeUnit unit)

Description copied from interface: BasicCache

An overloaded form of Map.putAll(Map), which takes in lifespan parameters. Note that the lifespan is applied to all mappings in the map passed in.

Specified by:

putAll in interface BasicCache<K,V>

Overrides:

putAll in class AbstractDelegatingCache<K,V>

Parameters:

map - map containing mappings to enter

lifespan - lifespan of the entry. Negative values are interpreted as unlimited lifespan.

unit - unit of measurement for the lifespan

replace

public V replace(K key,
 V value,
 long lifespan,
 TimeUnit unit)

Description copied from interface: BasicCache

An overloaded form of ConcurrentMap.replace(Object, Object), which takes in lifespan parameters.

Specified by:

replace in interface BasicCache<K,V>

Overrides:

replace in class AbstractDelegatingCache<K,V>

Parameters:

key - key to use

value - value to store

lifespan - lifespan of the entry. Negative values are interpreted as unlimited lifespan.

unit - unit of measurement for the lifespan

Returns:

the value being replaced, or null if nothing is being replaced.

replace

public boolean replace(K key,
 V oldValue,
 V value,
 long lifespan,
 TimeUnit unit)

Description copied from interface: BasicCache

An overloaded form of ConcurrentMap.replace(Object, Object, Object), which takes in lifespan parameters.

Specified by:

replace in interface BasicCache<K,V>

Overrides:

replace in class AbstractDelegatingCache<K,V>

Parameters:

key - key to use

oldValue - value to replace

value - value to store

lifespan - lifespan of the entry. Negative values are interpreted as unlimited lifespan.

unit - unit of measurement for the lifespan

Returns:

true if the value was replaced, false otherwise

put

public V put(K key,
 V value,
 long lifespan,
 TimeUnit lifespanUnit,
 long maxIdleTime,
 TimeUnit maxIdleTimeUnit)

Description copied from interface: BasicCache

An overloaded form of BasicCache.put(Object, Object), which takes in lifespan parameters.

Specified by:

put in interface BasicCache<K,V>

Overrides:

put in class AbstractDelegatingCache<K,V>

Parameters:

key - key to use

value - value to store

lifespan - lifespan of the entry. Negative values are interpreted as unlimited lifespan.

lifespanUnit - time unit for lifespan

maxIdleTime - the maximum amount of time this key is allowed to be idle for before it is considered as expired

maxIdleTimeUnit - time unit for max idle time

Returns:

the value being replaced, or null if nothing is being replaced.

putIfAbsent

public V putIfAbsent(K key,
 V value,
 long lifespan,
 TimeUnit lifespanUnit,
 long maxIdleTime,
 TimeUnit maxIdleTimeUnit)

Description copied from interface: BasicCache

An overloaded form of ConcurrentMap.putIfAbsent(Object, Object), which takes in lifespan parameters.

Specified by:

putIfAbsent in interface BasicCache<K,V>

Overrides:

putIfAbsent in class AbstractDelegatingCache<K,V>

Parameters:

key - key to use

value - value to store

lifespan - lifespan of the entry. Negative values are interpreted as unlimited lifespan.

lifespanUnit - time unit for lifespan

maxIdleTime - the maximum amount of time this key is allowed to be idle for before it is considered as expired

maxIdleTimeUnit - time unit for max idle time

Returns:

the value being replaced, or null if nothing is being replaced.

putAll

public void putAll(Map<? extends K,? extends V> map,
 long lifespan,
 TimeUnit lifespanUnit,
 long maxIdleTime,
 TimeUnit maxIdleTimeUnit)

Description copied from interface: BasicCache

An overloaded form of Map.putAll(Map), which takes in lifespan parameters. Note that the lifespan is applied to all mappings in the map passed in.

Specified by:

putAll in interface BasicCache<K,V>

Overrides:

putAll in class AbstractDelegatingCache<K,V>

Parameters:

map - map containing mappings to enter

lifespan - lifespan of the entry. Negative values are interpreted as unlimited lifespan.

lifespanUnit - time unit for lifespan

maxIdleTime - the maximum amount of time this key is allowed to be idle for before it is considered as expired

maxIdleTimeUnit - time unit for max idle time

replace

public V replace(K key,
 V value,
 long lifespan,
 TimeUnit lifespanUnit,
 long maxIdleTime,
 TimeUnit maxIdleTimeUnit)

Description copied from interface: BasicCache

An overloaded form of ConcurrentMap.replace(Object, Object), which takes in lifespan parameters.

Specified by:

replace in interface BasicCache<K,V>

Overrides:

replace in class AbstractDelegatingCache<K,V>

Parameters:

key - key to use

value - value to store

lifespan - lifespan of the entry. Negative values are interpreted as unlimited lifespan.

lifespanUnit - time unit for lifespan

maxIdleTime - the maximum amount of time this key is allowed to be idle for before it is considered as expired

maxIdleTimeUnit - time unit for max idle time

Returns:

the value being replaced, or null if nothing is being replaced.

replace

public boolean replace(K key,
 V oldValue,
 V value,
 long lifespan,
 TimeUnit lifespanUnit,
 long maxIdleTime,
 TimeUnit maxIdleTimeUnit)

Description copied from interface: BasicCache

An overloaded form of ConcurrentMap.replace(Object, Object, Object), which takes in lifespan parameters.

Specified by:

replace in interface BasicCache<K,V>

Overrides:

replace in class AbstractDelegatingCache<K,V>

Parameters:

key - key to use

oldValue - value to replace

value - value to store

lifespan - lifespan of the entry. Negative values are interpreted as unlimited lifespan.

lifespanUnit - time unit for lifespan

maxIdleTime - the maximum amount of time this key is allowed to be idle for before it is considered as expired

maxIdleTimeUnit - time unit for max idle time

Returns:

true if the value was replaced, false otherwise

putAsync

public CompletableFuture<V> putAsync(K key,
 V value)

Description copied from interface: AsyncCache

Asynchronous version of BasicCache.put(Object, Object). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

putAsync in interface AsyncCache<K,V>

Overrides:

putAsync in class AbstractDelegatingCache<K,V>

Parameters:

key - key to use

value - value to store

Returns:

a future containing the old value replaced.

putAsync

public CompletableFuture<V> putAsync(K key,
 V value,
 long lifespan,
 TimeUnit unit)

Description copied from interface: AsyncCache

Asynchronous version of BasicCache.put(Object, Object, long, TimeUnit) . This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

putAsync in interface AsyncCache<K,V>

Overrides:

putAsync in class AbstractDelegatingCache<K,V>

Parameters:

key - key to use

value - value to store

lifespan - lifespan of entry

unit - time unit for lifespan

Returns:

a future containing the old value replaced

putAsync

public CompletableFuture<V> putAsync(K key,
 V value,
 long lifespan,
 TimeUnit lifespanUnit,
 long maxIdle,
 TimeUnit maxIdleUnit)

Description copied from interface: AsyncCache

Asynchronous version of BasicCache.put(Object, Object, long, TimeUnit, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

putAsync in interface AsyncCache<K,V>

Overrides:

putAsync in class AbstractDelegatingCache<K,V>

Parameters:

key - key to use

value - value to store

lifespan - lifespan of entry

lifespanUnit - time unit for lifespan

maxIdle - the maximum amount of time this key is allowed to be idle for before it is considered as expired

maxIdleUnit - time unit for max idle time

Returns:

a future containing the old value replaced

putAllAsync

public CompletableFuture<Void> putAllAsync(Map<? extends K,? extends V> data)

Description copied from interface: AsyncCache

Asynchronous version of Map.putAll(Map). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

putAllAsync in interface AsyncCache<K,V>

Overrides:

putAllAsync in class AbstractDelegatingCache<K,V>

Parameters:

data - to store

Returns:

a future containing a void return type

putAllAsync

public CompletableFuture<Void> putAllAsync(Map<? extends K,? extends V> data,
 long lifespan,
 TimeUnit unit)

Description copied from interface: AsyncCache

Asynchronous version of BasicCache.putAll(Map, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

putAllAsync in interface AsyncCache<K,V>

Overrides:

putAllAsync in class AbstractDelegatingCache<K,V>

Parameters:

data - to store

lifespan - lifespan of entry

unit - time unit for lifespan

Returns:

a future containing a void return type

putAllAsync

public CompletableFuture<Void> putAllAsync(Map<? extends K,? extends V> data,
 long lifespan,
 TimeUnit lifespanUnit,
 long maxIdle,
 TimeUnit maxIdleUnit)

Description copied from interface: AsyncCache

Asynchronous version of BasicCache.putAll(Map, long, TimeUnit, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

putAllAsync in interface AsyncCache<K,V>

Overrides:

putAllAsync in class AbstractDelegatingCache<K,V>

Parameters:

data - to store

lifespan - lifespan of entry

lifespanUnit - time unit for lifespan

maxIdle - the maximum amount of time this key is allowed to be idle for before it is considered as expired

maxIdleUnit - time unit for max idle time

Returns:

a future containing a void return type

putAllAsync

public CompletableFuture<Void> putAllAsync(Map<? extends K,? extends V> data,
 Metadata metadata)

Specified by:

putAllAsync in interface AdvancedCache<K,V>

Overrides:

putAllAsync in class AbstractDelegatingAdvancedCache<K,V>

clearAsync

public CompletableFuture<Void> clearAsync()

Description copied from interface: AsyncCache

Asynchronous version of Map.clear(). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

clearAsync in interface AsyncCache<K,V>

Overrides:

clearAsync in class AbstractDelegatingCache<K,V>

Returns:

a future containing a void return type

putIfAbsentAsync

public CompletableFuture<V> putIfAbsentAsync(K key,
 V value)

Description copied from interface: AsyncCache

Asynchronous version of ConcurrentMap.putIfAbsent(Object, Object). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

putIfAbsentAsync in interface AsyncCache<K,V>

Overrides:

putIfAbsentAsync in class AbstractDelegatingCache<K,V>

Parameters:

key - key to use

value - value to store

Returns:

a future containing the old value replaced.

putIfAbsentAsync

public CompletableFuture<V> putIfAbsentAsync(K key,
 V value,
 long lifespan,
 TimeUnit unit)

Description copied from interface: AsyncCache

Asynchronous version of BasicCache.putIfAbsent(Object, Object, long, TimeUnit) . This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

putIfAbsentAsync in interface AsyncCache<K,V>

Overrides:

putIfAbsentAsync in class AbstractDelegatingCache<K,V>

Parameters:

key - key to use

value - value to store

lifespan - lifespan of entry

unit - time unit for lifespan

Returns:

a future containing the old value replaced

putIfAbsentAsync

public CompletableFuture<V> putIfAbsentAsync(K key,
 V value,
 long lifespan,
 TimeUnit lifespanUnit,
 long maxIdle,
 TimeUnit maxIdleUnit)

Description copied from interface: AsyncCache

Asynchronous version of BasicCache.putIfAbsent(Object, Object, long, TimeUnit, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

putIfAbsentAsync in interface AsyncCache<K,V>

Overrides:

putIfAbsentAsync in class AbstractDelegatingCache<K,V>

Parameters:

key - key to use

value - value to store

lifespan - lifespan of entry

lifespanUnit - time unit for lifespan

maxIdle - the maximum amount of time this key is allowed to be idle for before it is considered as expired

maxIdleUnit - time unit for max idle time

Returns:

a future containing the old value replaced

putIfAbsentAsync

public CompletableFuture<V> putIfAbsentAsync(K key,
 V value,
 Metadata metadata)

Description copied from interface: AdvancedCache

An overloaded form of AsyncCache.putIfAbsentAsync(Object, Object), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. The Metadata is only stored if the call is successful.

Specified by:

putIfAbsentAsync in interface AdvancedCache<K,V>

Overrides:

putIfAbsentAsync in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

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

value - value to be associated with the specified key

metadata - information to store alongside the new value

Returns:

A future containing the previous value associated with the specified key, or null if there was no mapping for the key.

putIfAbsentAsyncEntry

public CompletableFuture<CacheEntry<K,V>> putIfAbsentAsyncEntry(K key,
 V value,
 Metadata metadata)

Description copied from interface: AdvancedCache

An extension form of AdvancedCache.putIfAbsentAsync(Object, Object, Metadata), which returns a CacheEntry instead of only the value.

Specified by:

putIfAbsentAsyncEntry in interface AdvancedCache<K,V>

Overrides:

putIfAbsentAsyncEntry in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

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

value - value to be associated with the specified key

metadata - information to store alongside the new value

Returns:

the future that contains previous CacheEntry associated with the specified key, or null if there was no mapping for the key.

See Also:

• AdvancedCache.putIfAbsentAsync(K, V, Metadata)

removeAsync

public CompletableFuture<V> removeAsync(Object key)

Description copied from interface: AsyncCache

Asynchronous version of BasicCache.remove(Object). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

removeAsync in interface AsyncCache<K,V>

Overrides:

removeAsync in class AbstractDelegatingCache<K,V>

Parameters:

key - key to remove

Returns:

a future containing the value removed

removeAsyncEntry

public CompletableFuture<CacheEntry<K,V>> removeAsyncEntry(Object key)

Description copied from interface: AdvancedCache

An extension of AsyncCache.removeAsync(Object), which returns a CacheEntry instead of only the value.

Specified by:

removeAsyncEntry in interface AdvancedCache<K,V>

Overrides:

removeAsyncEntry in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

key - key to remove

Returns:

a future containing the CacheEntry removed or null if not found.

See Also:

• AsyncCache.removeAsync(Object)
• BasicCache.remove(Object)

removeAsync

public CompletableFuture<Boolean> removeAsync(Object key,
 Object value)

Description copied from interface: AsyncCache

Asynchronous version of ConcurrentMap.remove(Object, Object). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

removeAsync in interface AsyncCache<K,V>

Overrides:

removeAsync in class AbstractDelegatingCache<K,V>

Parameters:

key - key to remove

value - value to match on

Returns:

a future containing a boolean, indicating whether the entry was removed or not

removeLifespanExpired

public CompletableFuture<Boolean> removeLifespanExpired(K key,
 V value,
 Long lifespan)

Description copied from interface: AdvancedCache

Attempts to remove the entry if it is expired. Due to expired entries not being consistent across nodes, this will still attempt to remove the value if it is not present. Note that this will raise an expired event even if the entry is not present. Normally this method should never be invoked except by the ExpirationManager.

This command will only remove the value if the value and lifespan also match if provided.

This method will suspend any ongoing transaction and start a new one just for the invocation of this command. It is automatically committed or rolled back after the command completes, either successfully or via an exception.

NOTE: This method may be removed at any point including in a minor release and is not supported for external usage.

Specified by:

removeLifespanExpired in interface AdvancedCache<K,V>

Overrides:

removeLifespanExpired in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

key - the key that is expiring

value - the value that mapped to the given. Null means it will match any value

lifespan - the lifespan that should match. If null is provided it will match any lifespan value

Returns:

if the entry was removed

removeMaxIdleExpired

public CompletableFuture<Boolean> removeMaxIdleExpired(K key,
 V value)

Description copied from interface: AdvancedCache

Attempts to remove the entry for the given key, if it has expired due to max idle. This command first locks the key and then verifies that the entry has expired via maxIdle across all nodes. If it has this will then remove the given key.

This method returns a boolean when it has determined if the entry has expired. This is useful for when a backup node invokes this command for a get that found the entry expired. This way the node can return back to the caller much faster when the entry is not expired and do any additional processing asynchronously if needed.

This method will suspend any ongoing transaction and start a new one just for the invocation of this command. It is automatically committed or rolled back after the command completes, either successfully or via an exception.

NOTE: This method may be removed at any point including in a minor release and is not supported for external usage.

Specified by:

removeMaxIdleExpired in interface AdvancedCache<K,V>

Overrides:

removeMaxIdleExpired in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

key - the key that expired via max idle for the given entry

Returns:

if the entry was removed

replaceAsync

public CompletableFuture<V> replaceAsync(K key,
 V value)

Description copied from interface: AsyncCache

Asynchronous version of ConcurrentMap.replace(Object, Object). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

replaceAsync in interface AsyncCache<K,V>

Overrides:

replaceAsync in class AbstractDelegatingCache<K,V>

Parameters:

key - key to remove

value - value to store

Returns:

a future containing the previous value overwritten

replaceAsync

public CompletableFuture<V> replaceAsync(K key,
 V value,
 long lifespan,
 TimeUnit unit)

Description copied from interface: AsyncCache

Asynchronous version of BasicCache.replace(Object, Object, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

replaceAsync in interface AsyncCache<K,V>

Overrides:

replaceAsync in class AbstractDelegatingCache<K,V>

Parameters:

key - key to remove

value - value to store

lifespan - lifespan of entry

unit - time unit for lifespan

Returns:

a future containing the previous value overwritten

replaceAsync

public CompletableFuture<V> replaceAsync(K key,
 V value,
 long lifespan,
 TimeUnit lifespanUnit,
 long maxIdle,
 TimeUnit maxIdleUnit)

Description copied from interface: AsyncCache

Asynchronous version of BasicCache.replace(Object, Object, long, TimeUnit, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

replaceAsync in interface AsyncCache<K,V>

Overrides:

replaceAsync in class AbstractDelegatingCache<K,V>

Parameters:

key - key to remove

value - value to store

lifespan - lifespan of entry

lifespanUnit - time unit for lifespan

maxIdle - the maximum amount of time this key is allowed to be idle for before it is considered as expired

maxIdleUnit - time unit for max idle time

Returns:

a future containing the previous value overwritten

replaceAsync

public CompletableFuture<V> replaceAsync(K key,
 V value,
 Metadata metadata)

Description copied from interface: AdvancedCache

An overloaded form of AsyncCache.replaceAsync(Object, Object), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. The Metadata is only stored if the call is successful.

Specified by:

replaceAsync in interface AdvancedCache<K,V>

Overrides:

replaceAsync in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

key - key with which the specified value is associated

value - value to be associated with the specified key

metadata - information to store alongside the new value

Returns:

the future that contains previous value associated with the specified key, or null if there was no mapping for the key.

replaceAsyncEntry

public CompletableFuture<CacheEntry<K,V>> replaceAsyncEntry(K key,
 V value,
 Metadata metadata)

Description copied from interface: AdvancedCache

An extension of AdvancedCache.replaceAsync(Object, Object, Metadata), which returns a CacheEntry instead of only the value.

Specified by:

replaceAsyncEntry in interface AdvancedCache<K,V>

Overrides:

replaceAsyncEntry in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

key - key with which the specified value is associated

value - value to be associated with the specified key

metadata - information to store alongside the new value

Returns:

the future that contains previous CacheEntry associated with the specified key, or null if there was no mapping for the key.

See Also:

• AdvancedCache.replaceAsync(K, V, Metadata)

replaceAsync

public CompletableFuture<Boolean> replaceAsync(K key,
 V oldValue,
 V newValue)

Description copied from interface: AsyncCache

Asynchronous version of ConcurrentMap.replace(Object, Object, Object). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

replaceAsync in interface AsyncCache<K,V>

Overrides:

replaceAsync in class AbstractDelegatingCache<K,V>

Parameters:

key - key to remove

oldValue - value to overwrite

newValue - value to store

Returns:

a future containing a boolean, indicating whether the entry was replaced or not

replaceAsync

public CompletableFuture<Boolean> replaceAsync(K key,
 V oldValue,
 V newValue,
 long lifespan,
 TimeUnit unit)

Description copied from interface: AsyncCache

Asynchronous version of BasicCache.replace(Object, Object, Object, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

replaceAsync in interface AsyncCache<K,V>

Overrides:

replaceAsync in class AbstractDelegatingCache<K,V>

Parameters:

key - key to remove

oldValue - value to overwrite

newValue - value to store

lifespan - lifespan of entry

unit - time unit for lifespan

Returns:

a future containing a boolean, indicating whether the entry was replaced or not

replaceAsync

public CompletableFuture<Boolean> replaceAsync(K key,
 V oldValue,
 V newValue,
 long lifespan,
 TimeUnit lifespanUnit,
 long maxIdle,
 TimeUnit maxIdleUnit)

Description copied from interface: AsyncCache

Asynchronous version of BasicCache.replace(Object, Object, Object, long, TimeUnit, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

replaceAsync in interface AsyncCache<K,V>

Overrides:

replaceAsync in class AbstractDelegatingCache<K,V>

Parameters:

key - key to remove

oldValue - value to overwrite

newValue - value to store

lifespan - lifespan of entry

lifespanUnit - time unit for lifespan

maxIdle - the maximum amount of time this key is allowed to be idle for before it is considered as expired

maxIdleUnit - time unit for max idle time

Returns:

a future containing a boolean, indicating whether the entry was replaced or not

replaceAsync

public CompletableFuture<Boolean> replaceAsync(K key,
 V oldValue,
 V newValue,
 Metadata metadata)

Specified by:

replaceAsync in interface AdvancedCache<K,V>

Overrides:

replaceAsync in class AbstractDelegatingAdvancedCache<K,V>

getAsync

public CompletableFuture<V> getAsync(K key)

Description copied from interface: AsyncCache

Asynchronous version of Map.get(Object) that allows user code to retrieve the value associated with a key at a later stage, hence allowing multiple parallel get requests to be sent. Normally, when this method detects that the value is likely to be retrieved from from a remote entity, it will span a different thread in order to allow the asynchronous get call to return immediately. If the call will definitely resolve locally, for example when the cache is configured with LOCAL mode and no stores are configured, the get asynchronous call will act sequentially and will have no different to Map.get(Object).

Specified by:

getAsync in interface AsyncCache<K,V>

Overrides:

getAsync in class AbstractDelegatingCache<K,V>

Parameters:

key - key to retrieve

Returns:

a future that can be used to retrieve value associated with the key when this is available. The actual value returned by the future follows the same rules as Map.get(Object)

getAllAsync

public CompletableFuture<Map<K,V>> getAllAsync(Set<?> keys)

Description copied from interface: AsyncCache

TODO This should be in AdvancedCache with getAll

Specified by:

getAllAsync in interface AsyncCache<K,V>

Overrides:

getAllAsync in class AbstractDelegatingAdvancedCache<K,V>

size

public int size()

Description copied from interface: Cache

Returns a count of all elements in this cache and cache loader across the entire cluster.

Only a subset of entries is held in memory at a time when using a loader or remote entries, to prevent possible memory issues, however the loading of said entries can still be vary slow.

If there are performance concerns then the Flag.SKIP_CACHE_LOAD flag should be used to avoid hitting the cache loader in case if this is not needed in the size calculation.

Also if you want the local contents only you can use the Flag.CACHE_MODE_LOCAL flag so that other remote nodes are not queried for data. However the loader will still be used unless the previously mentioned Flag.SKIP_CACHE_LOAD is also configured.

If this method is used in a transactional context, note this method will not bring additional values into the transaction context and thus objects that haven't yet been read will act in a IsolationLevel.READ_COMMITTED behavior irrespective of the configured isolation level. However values that have been previously modified or read that are in the context will be adhered to. e.g. any write modification or any previous read when using IsolationLevel.REPEATABLE_READ

This method should only be used for debugging purposes such as to verify that the cache contains all the keys entered. Any other use involving execution of this method on a production system is not recommended.

Specified by:

size in interface Cache<K,V>

Specified by:

size in interface Map<K,V>

Overrides:

size in class AbstractDelegatingCache<K,V>

Returns:

the number of key-value mappings in this cache and cache loader across the entire cluster.

sizeAsync

public CompletableFuture<Long> sizeAsync()

Description copied from interface: AsyncCache

Asynchronous version of Map.size(). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

sizeAsync in interface AsyncCache<K,V>

Overrides:

sizeAsync in class AbstractDelegatingCache<K,V>

Returns:

a future containing the count of the cache

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

Overrides:

isEmpty in class AbstractDelegatingCache<K,V>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

Overrides:

containsKey in class AbstractDelegatingCache<K,V>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

Overrides:

containsValue in class AbstractDelegatingCache<K,V>

get

public V get(Object key)

Specified by:

get in interface Map<K,V>

Overrides:

get in class AbstractDelegatingCache<K,V>

getAll

public Map<K,V> getAll(Set<?> keys)

Description copied from interface: AdvancedCache

Gets a collection of entries, returning them as Map of the values associated with the set of keys requested.

If the cache is configured read-through, and a get for a key would return null because an entry is missing from the cache, the Cache's NonBlockingStore is called in an attempt to load the entry. If an entry cannot be loaded for a given key, the returned Map will contain null for value of the key.

Unlike other bulk methods if this invoked in an existing transaction all entries will be stored in the current transactional context

The returned Map will be a copy and updates to the map will not be reflected in the Cache and vice versa. The keys and values themselves however may not be copies depending on if storeAsBinary is enabled and the value was retrieved from the local node.

Specified by:

getAll in interface AdvancedCache<K,V>

Overrides:

getAll in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

keys - The keys whose associated values are to be returned.

Returns:

A map of entries that were found for the given keys. If an entry is not found for a given key, it will not be in the returned map.

getAllCacheEntries

public Map<K,CacheEntry<K,V>> getAllCacheEntries(Set<?> keys)

Description copied from interface: AdvancedCache

Gets a collection of entries from the AdvancedCache, returning them as Map of the cache entries associated with the set of keys requested.

If the cache is configured read-through, and a get for a key would return null because an entry is missing from the cache, the Cache's NonBlockingStore is called in an attempt to load the entry. If an entry cannot be loaded for a given key, the returned Map will contain null for value of the key.

Unlike other bulk methods if this invoked in an existing transaction all entries will be stored in the current transactional context

The returned Map will be a copy and updates to the map will not be reflected in the Cache and vice versa. The keys and values themselves however may not be copies depending on if storeAsBinary is enabled and the value was retrieved from the local node.

Specified by:

getAllCacheEntries in interface AdvancedCache<K,V>

Overrides:

getAllCacheEntries in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

keys - The keys whose associated values are to be returned.

Returns:

A map of entries that were found for the given keys. Keys not found in the cache are present in the map with null values.

put

public V put(K key,
 V value)

Description copied from interface: BasicCache

If the return value of this operation will be ignored by the application, the user is strongly encouraged to use the Flag.IGNORE_RETURN_VALUES flag when invoking this method in order to make it behave as efficiently as possible (i.e. avoiding needless remote or network calls).

Specified by:

put in interface BasicCache<K,V>

Specified by:

put in interface Map<K,V>

Overrides:

put in class AbstractDelegatingCache<K,V>

remove

public V remove(Object key)

Description copied from interface: BasicCache

If the return value of this operation will be ignored by the application, the user is strongly encouraged to use the Flag.IGNORE_RETURN_VALUES flag when invoking this method in order to make it behave as efficiently as possible (i.e. avoiding needless remote or network calls).

Specified by:

remove in interface BasicCache<K,V>

Specified by:

remove in interface Map<K,V>

Overrides:

remove in class AbstractDelegatingCache<K,V>

putAll

public void putAll(Map<? extends K,? extends V> map,
 Metadata metadata)

Description copied from interface: AdvancedCache

An overloaded form of Map.putAll(Map), which takes in an instance of Metadata which can be used to provide metadata information for the entries being stored, such as lifespan, version of value...etc.

Specified by:

putAll in interface AdvancedCache<K,V>

Overrides:

putAll in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

map - the values to store

metadata - information to store alongside the value(s)

putAll

public void putAll(Map<? extends K,? extends V> m)

Specified by:

putAll in interface Map<K,V>

Overrides:

putAll in class AbstractDelegatingCache<K,V>

clear

public void clear()

Description copied from interface: Cache

Removes all mappings from the cache.

Note: This should never be invoked in production unless you can guarantee no other invocations are ran concurrently.

If the cache is transactional, it will not interact with the transaction.

Specified by:

clear in interface Cache<K,V>

Specified by:

clear in interface Map<K,V>

Overrides:

clear in class AbstractDelegatingCache<K,V>

keySet

public CacheSet<K> keySet()

Description copied from interface: Cache

Returns a set view of the keys contained in this cache and cache loader across the entire cluster. Modifications and changes to the cache will be reflected in the set and vice versa. When this method is called nothing is actually queried as the backing set is just returned. Invocation on the set itself is when the various operations are ran.

Unsupported Operations

Care should be taken when invoking Set.toArray(), Set.toArray(Object[]), Set.size(), Set.retainAll(Collection) and Set.iterator() methods as they will traverse the entire contents of the cluster including a configured CacheLoader and remote entries. The former 2 methods especially have a very high likely hood of causing a OutOfMemoryError due to storing all the keys in the entire cluster in the array. Use involving execution of this method on a production system is not recommended as they can be quite expensive operations

Supported Flags

Note any flag configured for the cache will also be passed along to the backing set when it was created. If additional flags are configured on the cache they will not affect any existing backings sets.

If there are performance concerns then the Flag.SKIP_CACHE_LOAD flag should be used to avoid hitting the cache store as this will cause all entries there to be read in (albeit in a batched form to prevent OutOfMemoryError)

Also if you want the local contents only you can use the Flag.CACHE_MODE_LOCAL flag so that other remote nodes are not queried for data. However the loader will still be used unless the previously mentioned Flag.SKIP_CACHE_LOAD is also configured.

Iterator Use

This class implements the CloseableIteratorSet interface which creates a CloseableIterator instead of a regular one. This means this iterator must be explicitly closed either through try with resource or calling the close method directly. Technically this iterator will also close itself if you iterate fully over it, but it is safest to always make sure you close it explicitly.

Unsupported Operations

Due to not being able to add null values the following methods are not supported and will throw UnsupportedOperationException if invoked. Set.add(Object) Set.addAll(java.util.Collection)

Specified by:

keySet in interface Cache<K,V>

Specified by:

keySet in interface Map<K,V>

Overrides:

keySet in class AbstractDelegatingCache<K,V>

Returns:

a set view of the keys contained in this cache and cache loader across the entire cluster.

getGroup

public Map<K,V> getGroup(String groupName)

Description copied from interface: AdvancedCache

It fetches all the keys which belong to the group.

Semantically, it iterates over all the keys in memory and persistence, and performs a read operation in the keys found. Multiple invocations inside a transaction ensures that all the keys previous read are returned and it may return newly added keys to the group from other committed transactions (also known as phantom reads).

The map returned is immutable and represents the group at the time of the invocation. If you want to add or remove keys from a group use BasicCache.put(Object, Object) and BasicCache.remove(Object). To remove all the keys in the group use AdvancedCache.removeGroup(String).

To improve performance you may use the flag Flag.SKIP_CACHE_LOAD to avoid fetching the key/value from persistence. However, you will get an inconsistent snapshot of the group.

Specified by:

getGroup in interface AdvancedCache<K,V>

Overrides:

getGroup in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

groupName - the group name.

Returns:

an immutable Map with the key/value pairs.

removeGroup

public void removeGroup(String groupName)

Description copied from interface: AdvancedCache

It removes all the key which belongs to a group.

Semantically, it fetches the most recent group keys/values and removes them.

Note that, concurrent addition perform by other transactions/threads to the group may not be removed.

Specified by:

removeGroup in interface AdvancedCache<K,V>

Overrides:

removeGroup in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

groupName - the group name.

values

public CacheCollection<V> values()

Description copied from interface: Cache

Returns a collection view of the values contained in this cache across the entire cluster. Modifications and changes to the cache will be reflected in the set and vice versa. When this method is called nothing is actually queried as the backing collection is just returned. Invocation on the collection itself is when the various operations are ran.

Care should be taken when invoking Collection.toArray(), Collection.toArray(Object[]), Collection.size(), Collection.retainAll(Collection) and Collection.iterator() methods as they will traverse the entire contents of the cluster including a configured CacheLoader and remote entries. The former 2 methods especially have a very high likely hood of causing a OutOfMemoryError due to storing all the keys in the entire cluster in the array. Use involving execution of this method on a production system is not recommended as they can be quite expensive operations

*

Supported Flags

Note any flag configured for the cache will also be passed along to the backing set when it was created. If additional flags are configured on the cache they will not affect any existing backings sets.

If there are performance concerns then the Flag.SKIP_CACHE_LOAD flag should be used to avoid hitting the cache store as this will cause all entries there to be read in (albeit in a batched form to prevent OutOfMemoryError)

Also if you want the local contents only you can use the Flag.CACHE_MODE_LOCAL flag so that other remote nodes are not queried for data. However the loader will still be used unless the previously mentioned Flag.SKIP_CACHE_LOAD is also configured.

Iterator Use

This class implements the CloseableIteratorCollection interface which creates a CloseableIterator instead of a regular one. This means this iterator must be explicitly closed either through try with resource or calling the close method directly. Technically this iterator will also close itself if you iterate fully over it, but it is safest to always make sure you close it explicitly.

The iterator retrieved using CloseableIteratorCollection.iterator() supports the remove method, however the iterator retrieved from CacheStream.iterator() will not support remove.

Unsupported Operations

Due to not being able to add null values the following methods are not supported and will throw UnsupportedOperationException if invoked. Set.add(Object) Set.addAll(java.util.Collection)

Specified by:

values in interface Cache<K,V>

Specified by:

values in interface Map<K,V>

Overrides:

values in class AbstractDelegatingCache<K,V>

Returns:

a collection view of the values contained in this cache and cache loader across the entire cluster.

entrySet

public CacheSet<Map.Entry<K,V>> entrySet()

Description copied from interface: Cache

Returns a set view of the mappings contained in this cache and cache loader across the entire cluster. Modifications and changes to the cache will be reflected in the set and vice versa. When this method is called nothing is actually queried as the backing set is just returned. Invocation on the set itself is when the various operations are ran.

Care should be taken when invoking Set.toArray(), Set.toArray(Object[]), Set.size(), Set.retainAll(Collection) and Set.iterator() methods as they will traverse the entire contents of the cluster including a configured CacheLoader and remote entries. The former 2 methods especially have a very high likely hood of causing a OutOfMemoryError due to storing all the keys in the entire cluster in the array. Use involving execution of this method on a production system is not recommended as they can be quite expensive operations

*

Supported Flags

Note any flag configured for the cache will also be passed along to the backing set when it was created. If additional flags are configured on the cache they will not affect any existing backings sets.

If there are performance concerns then the Flag.SKIP_CACHE_LOAD flag should be used to avoid hitting the cache store as this will cause all entries there to be read in (albeit in a batched form to prevent OutOfMemoryError)

Also if you want the local contents only you can use the Flag.CACHE_MODE_LOCAL flag so that other remote nodes are not queried for data. However the loader will still be used unless the previously mentioned Flag.SKIP_CACHE_LOAD is also configured.

Modifying or Adding Entries

An entry's value is supported to be modified by using the Map.Entry.setValue(Object) and it will update the cache as well. Also this backing set does allow addition of a new Map.Entry(s) via the Set.add(Object) or Set.addAll(java.util.Collection) methods.

Iterator Use

This class implements the CloseableIteratorSet interface which creates a CloseableIterator instead of a regular one. This means this iterator must be explicitly closed either through try with resource or calling the close method directly. Technically this iterator will also close itself if you iterate fully over it, but it is safest to always make sure you close it explicitly.

Specified by:

entrySet in interface Cache<K,V>

Specified by:

entrySet in interface Map<K,V>

Overrides:

entrySet in class AbstractDelegatingCache<K,V>

Returns:

a set view of the mappings contained in this cache and cache loader across the entire cluster.

cacheEntrySet

public CacheSet<CacheEntry<K,V>> cacheEntrySet()

Description copied from interface: AdvancedCache

Identical to Cache.entrySet() but is typed to return CacheEntries instead of Entries. Please see the other method for a description of its behaviors.

This method is needed since nested generics do not support covariance

Specified by:

cacheEntrySet in interface AdvancedCache<K,V>

Overrides:

cacheEntrySet in class AbstractDelegatingAdvancedCache<K,V>

Returns:

the entry set containing all of the CacheEntries

See Also:

• Cache.entrySet()

putIfAbsent

public V putIfAbsent(K key,
 V value)

Specified by:

putIfAbsent in interface ConcurrentMap<K,V>

Specified by:

putIfAbsent in interface Map<K,V>

Overrides:

putIfAbsent in class AbstractDelegatingCache<K,V>

remove

public boolean remove(Object key,
 Object value)

Specified by:

remove in interface ConcurrentMap<K,V>

Specified by:

remove in interface Map<K,V>

Overrides:

remove in class AbstractDelegatingCache<K,V>

replace

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

Specified by:

replace in interface ConcurrentMap<K,V>

Specified by:

replace in interface Map<K,V>

Overrides:

replace in class AbstractDelegatingCache<K,V>

replace

public V replace(K key,
 V value)

Specified by:

replace in interface ConcurrentMap<K,V>

Specified by:

replace in interface Map<K,V>

Overrides:

replace in class AbstractDelegatingCache<K,V>

compute

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

Description copied from interface: Cache

When this method is used on a clustered cache, either replicated or distributed, the bifunction will be serialized to owning nodes to perform the operation in the most performant way. However this means the bifunction must have an appropriate Externalizer or be Serializable itself.

For transactional caches, whenever the values of the caches are collections, and the mapping function modifies the collection, the collection must be copied and not directly modified, otherwise whenever rollback is called it won't work. This limitation could disappear in following releases if technically possible.

Specified by:

compute in interface Cache<K,V>

Specified by:

compute in interface ConcurrentMap<K,V>

Specified by:

compute in interface Map<K,V>

Overrides:

compute in class AbstractDelegatingCache<K,V>

computeIfPresent

public V computeIfPresent(K key,
 BiFunction<? super K,? super V,? extends V> remappingFunction)

Description copied from interface: Cache

When this method is used on a clustered cache, either replicated or distributed, the bifunction will be serialized to owning nodes to perform the operation in the most performant way. However this means the bifunction must have an appropriate Externalizer or be Serializable itself.

For transactional caches, whenever the values of the caches are collections, and the mapping function modifies the collection, the collection must be copied and not directly modified, otherwise whenever rollback is called it won't work. This limitation could disappear in following releases if technically possible.

Specified by:

computeIfPresent in interface Cache<K,V>

Specified by:

computeIfPresent in interface ConcurrentMap<K,V>

Specified by:

computeIfPresent in interface Map<K,V>

Overrides:

computeIfPresent in class AbstractDelegatingCache<K,V>

computeIfAbsent

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

Description copied from interface: Cache

When this method is used on a clustered cache, either replicated or distributed, the function will be serialized to owning nodes to perform the operation in the most performant way. However this means the function must have an appropriate Externalizer or be Serializable itself.

For transactional caches, whenever the values of the caches are collections, and the mapping function modifies the collection, the collection must be copied and not directly modified, otherwise whenever rollback is called it won't work. This limitation could disappear in following releases if technically possible.

Specified by:

computeIfAbsent in interface Cache<K,V>

Specified by:

computeIfAbsent in interface ConcurrentMap<K,V>

Specified by:

computeIfAbsent in interface Map<K,V>

Overrides:

computeIfAbsent in class AbstractDelegatingCache<K,V>

merge

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

Description copied from interface: Cache

When this method is used on a clustered cache, either replicated or distributed, the bifunction will be serialized to owning nodes to perform the operation in the most performant way. However this means the bifunction must have an appropriate Externalizer or be Serializable itself.

For transactional caches, whenever the values of the caches are collections, and the mapping function modifies the collection, the collection must be copied and not directly modified, otherwise whenever rollback is called it won't work. This limitation could disappear in following releases if technically possible.

Specified by:

merge in interface Cache<K,V>

Specified by:

merge in interface ConcurrentMap<K,V>

Specified by:

merge in interface Map<K,V>

Overrides:

merge in class AbstractDelegatingCache<K,V>

computeAsync

public CompletableFuture<V> computeAsync(K key,
 BiFunction<? super K,? super V,? extends V> remappingFunction)

Description copied from interface: AsyncCache

Asynchronous version of ConcurrentMap.compute(Object, BiFunction). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

computeAsync in interface AsyncCache<K,V>

Overrides:

computeAsync in class AbstractDelegatingAdvancedCache<K,V>

computeIfPresentAsync

public CompletableFuture<V> computeIfPresentAsync(K key,
 BiFunction<? super K,? super V,? extends V> remappingFunction)

Description copied from interface: AsyncCache

Asynchronous version of ConcurrentMap.computeIfPresent(Object, BiFunction). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

computeIfPresentAsync in interface AsyncCache<K,V>

Overrides:

computeIfPresentAsync in class AbstractDelegatingAdvancedCache<K,V>

computeIfAbsentAsync

public CompletableFuture<V> computeIfAbsentAsync(K key,
 Function<? super K,? extends V> mappingFunction)

Description copied from interface: AsyncCache

Asynchronous version of ConcurrentMap.computeIfAbsent(Object, Function). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

computeIfAbsentAsync in interface AsyncCache<K,V>

Overrides:

computeIfAbsentAsync in class AbstractDelegatingAdvancedCache<K,V>

mergeAsync

public CompletableFuture<V> mergeAsync(K key,
 V value,
 BiFunction<? super V,? super V,? extends V> remappingFunction)

Description copied from interface: AsyncCache

Asynchronous version of ConcurrentMap.merge(Object, Object, BiFunction). This method does not block on remote calls, even if your cache mode is synchronous.

Specified by:

mergeAsync in interface AsyncCache<K,V>

Overrides:

mergeAsync in class AbstractDelegatingAdvancedCache<K,V>

getFlagsBitSet

public long getFlagsBitSet()

addListenerAsync

public CompletionStage<Void> addListenerAsync(Object listener)

Description copied from interface: Listenable

Asynchronous version of Listenable.addListener(Object)

Specified by:

addListenerAsync in interface Listenable

Overrides:

addListenerAsync in class AbstractDelegatingCache<K,V>

Parameters:

listener - listener to add, must not be null

Returns:

CompletionStage that when complete the listener is fully installed

addListenerAsync

public <C> CompletionStage<Void> addListenerAsync(Object listener,
 CacheEventFilter<? super K,? super V> filter,
 CacheEventConverter<? super K,? super V,C> converter)

Description copied from interface: FilteringListenable

Asynchronous version of FilteringListenable.addListener(Object, CacheEventFilter, CacheEventConverter)

Specified by:

addListenerAsync in interface FilteringListenable<K,V>

Overrides:

addListenerAsync in class AbstractDelegatingCache<K,V>

Type Parameters:

C -

Parameters:

listener - listener to add, must not be null

filter -

converter -

Returns:

CompletionStage that when complete the listener is fully installed

addFilteredListenerAsync

public <C> CompletionStage<Void> addFilteredListenerAsync(Object listener,
 CacheEventFilter<? super K,? super V> filter,
 CacheEventConverter<? super K,? super V,C> converter,
 Set<Class<? extends Annotation>> filterAnnotations)

Description copied from interface: FilteringListenable

Asynchronous version of FilteringListenable.addFilteredListener(Object, CacheEventFilter, CacheEventConverter, Set)

Specified by:

addFilteredListenerAsync in interface FilteringListenable<K,V>

Overrides:

addFilteredListenerAsync in class AbstractDelegatingCache<K,V>

addStorageFormatFilteredListenerAsync

public <C> CompletionStage<Void> addStorageFormatFilteredListenerAsync(Object listener,
 CacheEventFilter<? super K,? super V> filter,
 CacheEventConverter<? super K,? super V,C> converter,
 Set<Class<? extends Annotation>> filterAnnotations)

Description copied from interface: FilteringListenable

Asynchronous version of FilteringListenable.addStorageFormatFilteredListener(Object, CacheEventFilter, CacheEventConverter, Set)

Specified by:

addStorageFormatFilteredListenerAsync in interface FilteringListenable<K,V>

Overrides:

addStorageFormatFilteredListenerAsync in class AbstractDelegatingCache<K,V>

put

public V put(K key,
 V value,
 Metadata metadata)

Description copied from interface: AdvancedCache

An overloaded form of BasicCache.put(Object, Object), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.

Specified by:

put in interface AdvancedCache<K,V>

Overrides:

put in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

key - key to use

value - value to store

metadata - information to store alongside the value

Returns:

the previous value associated with key, or null if there was no mapping for key.

putAsync

public CompletableFuture<V> putAsync(K key,
 V value,
 Metadata metadata)

Description copied from interface: AdvancedCache

Asynchronous version of AdvancedCache.put(Object, Object, Metadata) which stores metadata alongside the value. This method does not block on remote calls, even if your cache mode is synchronous. Has no benefit over AdvancedCache.put(Object, Object, Metadata) if used in LOCAL mode.

Specified by:

putAsync in interface AdvancedCache<K,V>

Overrides:

putAsync in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

key - key to use

value - value to store

metadata - information to store alongside the new value

Returns:

a future containing the old value replaced.

putAsyncEntry

public CompletableFuture<CacheEntry<K,V>> putAsyncEntry(K key,
 V value,
 Metadata metadata)

Description copied from interface: AdvancedCache

Extension of AdvancedCache.putAsync(Object, Object, Metadata) which returns a CacheEntry instead of only the previous value.

Specified by:

putAsyncEntry in interface AdvancedCache<K,V>

Overrides:

putAsyncEntry in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

key - key to use

value - value to store

metadata - information to store alongside the new value

Returns:

a future containing the old CacheEntry replaced.

putIfAbsent

public V putIfAbsent(K key,
 V value,
 Metadata metadata)

Description copied from interface: AdvancedCache

An overloaded form of ConcurrentMap.putIfAbsent(Object, Object), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. The Metadata is only stored if the call is successful.

Specified by:

putIfAbsent in interface AdvancedCache<K,V>

Overrides:

putIfAbsent in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

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

value - value to be associated with the specified key

metadata - information to store alongside the new value

Returns:

the previous value associated with the specified key, or null if there was no mapping for the key.

replace

public boolean replace(K key,
 V oldValue,
 V value,
 Metadata metadata)

Description copied from interface: AdvancedCache

An overloaded form of ConcurrentMap.replace(Object, Object, Object), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. The Metadata is only stored if the call is successful.

Specified by:

replace in interface AdvancedCache<K,V>

Overrides:

replace in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

key - key with which the specified value is associated

oldValue - value expected to be associated with the specified key

value - value to be associated with the specified key

metadata - information to store alongside the new value

Returns:

true if the value was replaced

replace

public V replace(K key,
 V value,
 Metadata metadata)

Description copied from interface: AdvancedCache

An overloaded form of ConcurrentMap.replace(Object, Object), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. The Metadata is only stored if the call is successful.

Specified by:

replace in interface AdvancedCache<K,V>

Overrides:

replace in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

key - key with which the specified value is associated

value - value to be associated with the specified key

metadata - information to store alongside the new value

Returns:

the previous value associated with the specified key, or null if there was no mapping for the key.

compute

public V compute(K key,
 BiFunction<? super K,? super V,? extends V> remappingFunction,
 Metadata metadata)

Description copied from interface: AdvancedCache

An overloaded form of Cache.compute(Object, BiFunction), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.

Specified by:

compute in interface AdvancedCache<K,V>

Overrides:

compute in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

key - key with which the specified value is associated

remappingFunction - function to be applied to the specified key/value

metadata - information to store alongside the new value

Returns:

the previous value associated with the specified key, or null if remapping function is gives null.

computeIfPresent

public V computeIfPresent(K key,
 BiFunction<? super K,? super V,? extends V> remappingFunction,
 Metadata metadata)

Description copied from interface: AdvancedCache

An overloaded form of Cache.computeIfPresent(Object, BiFunction), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. The Metadata is only stored if the call is successful.

Specified by:

computeIfPresent in interface AdvancedCache<K,V>

Overrides:

computeIfPresent in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

key - key with which the specified value is associated

remappingFunction - function to be applied to the specified key/value

metadata - information to store alongside the new value

Returns:

the previous value associated with the specified key, or null if there was no mapping for the key.

computeIfAbsent

public V computeIfAbsent(K key,
 Function<? super K,? extends V> mappingFunction,
 Metadata metadata)

Description copied from interface: AdvancedCache

An overloaded form of Cache.computeIfAbsent(Object, Function), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. The Metadata is only stored if the call is successful.

Specified by:

computeIfAbsent in interface AdvancedCache<K,V>

Overrides:

computeIfAbsent in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

key - key with which the specified value is associated

mappingFunction - function to be applied to the specified key

metadata - information to store alongside the new value

Returns:

the value created with the mapping function associated with the specified key, or the previous value associated with the specified key if the key is not absent.

merge

public V merge(K key,
 V value,
 BiFunction<? super V,? super V,? extends V> remappingFunction,
 Metadata metadata)

Description copied from interface: AdvancedCache

An overloaded form of Cache.merge(Object, Object, BiFunction), which takes in an instance of Metadata which can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. The Metadata is only stored if the call is successful.

Specified by:

merge in interface AdvancedCache<K,V>

Overrides:

merge in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

key - , key with which the resulting value is to be associated

value - , the non-null value to be merged with the existing value associated with the key or, if no existing value or a null value is associated with the key, to be associated with the key

remappingFunction - , the function to recompute a value if present

metadata - , information to store alongside the new value

Returns:

the new value associated with the specified key, or null if no value is associated with the key

getCacheEntry

public CacheEntry<K,V> getCacheEntry(Object key)

Description copied from interface: AdvancedCache

Retrieves a CacheEntry corresponding to a specific key.

Specified by:

getCacheEntry in interface AdvancedCache<K,V>

Overrides:

getCacheEntry in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

key - the key whose associated cache entry is to be returned

Returns:

the cache entry to which the specified key is mapped, or null if this map contains no mapping for the key

getCacheEntryAsync

public CompletableFuture<CacheEntry<K,V>> getCacheEntryAsync(Object key)

Description copied from interface: AdvancedCache

Retrieves a CacheEntry corresponding to a specific key.

Specified by:

getCacheEntryAsync in interface AdvancedCache<K,V>

Overrides:

getCacheEntryAsync in class AbstractDelegatingAdvancedCache<K,V>

Parameters:

key - the key whose associated cache entry is to be returned

Returns:

a future with the cache entry to which the specified key is mapped, or with null if this map contains no mapping for the key

readContext

protected InvocationContext readContext(int size)

writeContext

protected InvocationContext writeContext(int size)