Package org.infinispan.client.hotrod.impl

Class RemoteCacheSupport<K,V>

java.lang.Object

org.infinispan.client.hotrod.impl.RemoteCacheSupport<K,V>

All Implemented Interfaces:

ConcurrentMap<K,V>, Map<K,V>, RemoteCache<K,V>, org.infinispan.commons.api.AsyncCache<K,V>, org.infinispan.commons.api.BasicCache<K,V>, org.infinispan.commons.api.Lifecycle, org.infinispan.commons.api.TransactionalCache

Direct Known Subclasses:

RemoteCacheImpl

public abstract class RemoteCacheSupport<K,V>
extends Object
implements RemoteCache<K,V>

Purpose: keep all delegating and unsupported methods in one place -> readability.

Since:

4.1

Author:

Mircea.Markus@jboss.com

Nested Class Summary

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

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
protected long	defaultLifespan
protected long	defaultMaxIdleTime

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RemoteCacheSupport()
protected	RemoteCacheSupport(long defaultLifespan, long defaultMaxIdleTime)

Method Summary

Modifier and Type	Method	Description
V	compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
V	compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit)	An overloaded form of ConcurrentMap.compute(Object, BiFunction) which takes in lifespan parameters.
V	compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)	An overloaded form of ConcurrentMap.compute(Object, BiFunction) which takes in lifespan and maxIdleTime parameters.
CompletableFuture<V>	computeAsync(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)	Asynchronous version of ConcurrentMap.compute(Object, BiFunction).
CompletableFuture<V>	computeAsync(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit)	Asynchronous version of BasicCache.compute(Object, BiFunction, long, TimeUnit).
CompletableFuture<V>	computeAsync(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)	Asynchronous version of BasicCache.compute(Object, BiFunction, long, TimeUnit, long, TimeUnit).
V	computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction)
V	computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction, long lifespan, TimeUnit lifespanUnit)	An overloaded form of ConcurrentMap.computeIfAbsent(Object, Function) which takes in lifespan parameters.
V	computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)	An overloaded form of ConcurrentMap.computeIfAbsent(Object, Function) which takes in lifespan and maxIdleTime parameters.
CompletableFuture<V>	computeIfAbsentAsync(K key, Function<? super K,? extends V> mappingFunction)	Asynchronous version of ConcurrentMap.computeIfAbsent(Object, Function).
CompletableFuture<V>	computeIfAbsentAsync(K key, Function<? super K,? extends V> mappingFunction, long lifespan, TimeUnit lifespanUnit)	Asynchronous version of BasicCache.computeIfAbsent(Object, Function, long, TimeUnit).
CompletableFuture<V>	computeIfAbsentAsync(K key, Function<? super K,? extends V> mappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)	Asynchronous version of BasicCache.computeIfAbsent(Object, Function, long, TimeUnit, long, TimeUnit).
V	computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
V	computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit)	An overloaded form of ConcurrentMap.computeIfPresent(Object, BiFunction) which takes in lifespan parameters.
V	computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)	An overloaded form of ConcurrentMap.computeIfPresent(Object, BiFunction) which takes in lifespan and maxIdleTime parameters.
CompletableFuture<V>	computeIfPresentAsync(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)	Asynchronous version of ConcurrentMap.computeIfPresent(Object, BiFunction).
CompletableFuture<V>	computeIfPresentAsync(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit)	Asynchronous version of BasicCache.computeIfPresent(Object, BiFunction, long, TimeUnit) .
CompletableFuture<V>	computeIfPresentAsync(K key, BiFunction<? super K,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit)	Asynchronous version of BasicCache.computeIfPresent(Object, BiFunction, long, TimeUnit, long, TimeUnit) .
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, long lifespan, TimeUnit lifespanUnit)	An overloaded form of ConcurrentMap.merge(Object, Object, BiFunction) which takes in lifespan parameters.
V	merge(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)	An overloaded form of ConcurrentMap.merge(Object, Object, BiFunction) which takes in lifespan parameters.
CompletableFuture<V>	mergeAsync(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction)	Asynchronous version of ConcurrentMap.merge(Object, Object, BiFunction).
CompletableFuture<V>	mergeAsync(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit)	Asynchronous version of BasicCache.merge(Object, Object, BiFunction, long, TimeUnit).
CompletableFuture<V>	mergeAsync(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit)	Asynchronous version of BasicCache.merge(Object, Object, BiFunction, long, TimeUnit, long, TimeUnit).
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.
void	putAll(Map<? extends K,? extends V> map)	Synthetic operation.
void	putAll(Map<? extends K,? extends V> map, long lifespan, TimeUnit unit)	Synthetic operation.
CompletableFuture<Void>	putAllAsync(Map<? extends K,? extends V> data)	Synthetic operation.
CompletableFuture<Void>	putAllAsync(Map<? extends K,? extends V> data, long lifespan, TimeUnit unit)	Synthetic operation.
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) .
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.
CompletableFuture<V>	putIfAbsentAsync(K key, V value)	Asynchronous version of ConcurrentMap.putIfAbsent(Object, Object).
CompletableFuture<V>	putIfAbsentAsync(K key, V value, long lifespan, TimeUnit lifespanUnit)	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<Boolean>	removeAsync(Object key, Object value)	Asynchronous version of ConcurrentMap.remove(Object, Object).
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.
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.
void	replaceAll(BiFunction<? super K,? super V,? extends V> function)
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<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).
boolean	replaceWithVersion(K key, V newValue, long version)	Replaces the given value only if its version matches the supplied version.
boolean	replaceWithVersion(K key, V newValue, long version, int lifespanSeconds)	A overloaded form of RemoteCache.replaceWithVersion(Object, Object, long) which takes in lifespan parameters.
CompletableFuture<Boolean>	replaceWithVersionAsync(K key, V newValue, long version)
CompletableFuture<Boolean>	replaceWithVersionAsync(K key, V newValue, long version, int lifespanSeconds)
protected abstract void	set(K key, V value)	This is intentionally a non-public method meant as an integration point for bytecode manipulation.

Methods inherited from class java.lang.Object

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

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

clearAsync, containsKeyAsync, getAllAsync, getAsync, putAsync, removeAsync

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

getName, getVersion

Methods inherited from interface java.util.concurrent.ConcurrentMap

forEach, getOrDefault

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

start, stop

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, equals, get, hashCode, isEmpty, size

Methods inherited from interface org.infinispan.client.hotrod.RemoteCache

addClientListener, addClientListener, clientStatistics, entrySet, entrySet, execute, execute, getAll, getBulk, getBulk, getCacheTopologyInfo, getDataFormat, getListeners, getProtocolVersion, getRemoteCacheManager, getVersioned, getWithMetadata, getWithMetadataAsync, keySet, keySet, putAll, putAllAsync, remove, remove, removeClientListener, removeWithVersion, removeWithVersionAsync, replaceWithVersion, replaceWithVersion, replaceWithVersionAsync, retrieveEntries, retrieveEntries, retrieveEntries, retrieveEntriesByQuery, retrieveEntriesWithMetadata, serverStatistics, stats, streaming, values, values, withDataFormat, withFlags

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

getTransactionManager

Field Detail

defaultLifespan

protected long defaultLifespan

defaultMaxIdleTime

protected long defaultMaxIdleTime

Constructor Detail

RemoteCacheSupport

protected RemoteCacheSupport()

RemoteCacheSupport

protected RemoteCacheSupport(long defaultLifespan,
                             long defaultMaxIdleTime)

Method Detail

putAll

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

Description copied from interface: RemoteCache

Synthetic operation. The client iterates over the set of keys and calls put for each one of them. This results in operation not being atomic (if a failure happens after few puts it is not rolled back) and costly (for each key in the parameter map a remote call is performed).

Specified by:

putAll in interface org.infinispan.commons.api.BasicCache<K,V>

Specified by:

putAll in interface RemoteCache<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

putAllAsync

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

Description copied from interface: RemoteCache

Synthetic operation.

Specified by:

putAllAsync in interface org.infinispan.commons.api.AsyncCache<K,V>

Specified by:

putAllAsync in interface RemoteCache<K,V>

Parameters:

data - to store

Returns:

a future containing a void return type

See Also:

RemoteCache.putAll(java.util.Map, long, java.util.concurrent.TimeUnit)

putAllAsync

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

Description copied from interface: RemoteCache

Synthetic operation.

Specified by:

putAllAsync in interface org.infinispan.commons.api.AsyncCache<K,V>

Specified by:

putAllAsync in interface RemoteCache<K,V>

Parameters:

data - to store

lifespan - lifespan of entry

unit - time unit for lifespan

Returns:

a future containing a void return type

See Also:

RemoteCache.putAll(java.util.Map, long, java.util.concurrent.TimeUnit)

putAll

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

Description copied from interface: RemoteCache

Synthetic operation.

Specified by:

putAll in interface Map<K,V>

Specified by:

putAll in interface RemoteCache<K,V>

See Also:

RemoteCache.putAll(java.util.Map, long, java.util.concurrent.TimeUnit)

putIfAbsent

public V putIfAbsent(K key,
                     V value)

Specified by:

putIfAbsent in interface ConcurrentMap<K,V>

Specified by:

putIfAbsent in interface Map<K,V>

putIfAbsent

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

Description copied from interface: org.infinispan.commons.api.BasicCache

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

Specified by:

putIfAbsent in interface org.infinispan.commons.api.BasicCache<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 lifespanUnit,
                     long maxIdleTime,
                     TimeUnit maxIdleTimeUnit)

Description copied from interface: org.infinispan.commons.api.BasicCache

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

Specified by:

putIfAbsent in interface org.infinispan.commons.api.BasicCache<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 newValue)

Description copied from interface: RemoteCache

This method requires 2 round trips to the server. The first to retrieve the value and version and a second to replace the key with the version if the value matches. If possible user should use RemoteCache.getWithMetadata(Object) and RemoteCache.replaceWithVersion(Object, Object, long).

Specified by:

replace in interface ConcurrentMap<K,V>

Specified by:

replace in interface Map<K,V>

Specified by:

replace in interface RemoteCache<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>

replace

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

Description copied from interface: org.infinispan.commons.api.BasicCache

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

Specified by:

replace in interface org.infinispan.commons.api.BasicCache<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 V replace(K key,
                 V value,
                 long lifespan,
                 TimeUnit lifespanUnit,
                 long maxIdleTime,
                 TimeUnit maxIdleTimeUnit)

Description copied from interface: org.infinispan.commons.api.BasicCache

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

Specified by:

replace in interface org.infinispan.commons.api.BasicCache<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.

put

public V put(K key,
             V value)

Description copied from interface: org.infinispan.commons.api.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 org.infinispan.commons.api.BasicCache<K,V>

Specified by:

put in interface Map<K,V>

set

protected abstract void set(K key,
                            V value)

This is intentionally a non-public method meant as an integration point for bytecode manipulation. Don't remove or alter the signature even if it might look like unreachable code. Implementors should perform a put operation but optimizing it as return values are not required.

Since:

5.0

putAsync

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

Description copied from interface: org.infinispan.commons.api.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 org.infinispan.commons.api.AsyncCache<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: org.infinispan.commons.api.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 org.infinispan.commons.api.AsyncCache<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

replaceWithVersionAsync

public CompletableFuture<Boolean> replaceWithVersionAsync(K key,
                                                          V newValue,
                                                          long version)

Specified by:

replaceWithVersionAsync in interface RemoteCache<K,V>

See Also:

RemoteCache.replaceWithVersion(Object, Object, long)

replaceWithVersionAsync

public CompletableFuture<Boolean> replaceWithVersionAsync(K key,
                                                          V newValue,
                                                          long version,
                                                          int lifespanSeconds)

Specified by:

replaceWithVersionAsync in interface RemoteCache<K,V>

See Also:

RemoteCache.replaceWithVersion(Object, Object, long)

replaceWithVersion

public boolean replaceWithVersion(K key,
                                  V newValue,
                                  long version)

Description copied from interface: RemoteCache

Replaces the given value only if its version matches the supplied version. See RemoteCache.removeWithVersion(Object, long) for a sample usage of the version-based methods.

Specified by:

replaceWithVersion in interface RemoteCache<K,V>

version - numeric version that should match the one in the server for the operation to succeed

Returns:

true if the value has been replaced

See Also:

RemoteCache.getVersioned(Object), VersionedValue

replaceWithVersion

public boolean replaceWithVersion(K key,
                                  V newValue,
                                  long version,
                                  int lifespanSeconds)

Description copied from interface: RemoteCache

A overloaded form of RemoteCache.replaceWithVersion(Object, Object, long) which takes in lifespan parameters.

Specified by:

replaceWithVersion in interface RemoteCache<K,V>

Parameters:

key - key to use

newValue - new value to be associated with the key

version - numeric version that should match the one in the server for the operation to succeed

lifespanSeconds - lifespan of the entry

Returns:

true if the value was replaced

replaceAsync

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

Description copied from interface: org.infinispan.commons.api.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 org.infinispan.commons.api.AsyncCache<K,V>

Parameters:

key - key to remove

value - value to store

Returns:

a future containing the previous value overwritten

put

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

Description copied from interface: org.infinispan.commons.api.BasicCache

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

Specified by:

put in interface org.infinispan.commons.api.BasicCache<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.

put

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

Description copied from interface: org.infinispan.commons.api.BasicCache

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

Specified by:

put in interface org.infinispan.commons.api.BasicCache<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.

putIfAbsentAsync

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

Description copied from interface: org.infinispan.commons.api.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 org.infinispan.commons.api.AsyncCache<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 lifespanUnit)

Description copied from interface: org.infinispan.commons.api.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 org.infinispan.commons.api.AsyncCache<K,V>

Parameters:

key - key to use

value - value to store

lifespan - lifespan of entry

lifespanUnit - 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: org.infinispan.commons.api.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 org.infinispan.commons.api.AsyncCache<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

removeAsync

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

Description copied from interface: org.infinispan.commons.api.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 org.infinispan.commons.api.AsyncCache<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

replaceAsync

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

Description copied from interface: org.infinispan.commons.api.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 org.infinispan.commons.api.AsyncCache<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: org.infinispan.commons.api.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 org.infinispan.commons.api.AsyncCache<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<Boolean> replaceAsync(K key,
                                               V oldValue,
                                               V newValue)

Description copied from interface: org.infinispan.commons.api.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 org.infinispan.commons.api.AsyncCache<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: org.infinispan.commons.api.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 org.infinispan.commons.api.AsyncCache<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: org.infinispan.commons.api.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 org.infinispan.commons.api.AsyncCache<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

replace

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

Description copied from interface: RemoteCache

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

This method requires 2 round trips to the server. The first to retrieve the value and version and a second to replace the key with the version if the value matches. If possible user should use RemoteCache.getWithMetadata(Object) and RemoteCache.replaceWithVersion(Object, Object, long, long, TimeUnit, long, TimeUnit).

Specified by:

replace in interface org.infinispan.commons.api.BasicCache<K,V>

Specified by:

replace in interface RemoteCache<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

replace

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

Description copied from interface: RemoteCache

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

This method requires 2 round trips to the server. The first to retrieve the value and version and a second to replace the key with the version if the value matches. If possible user should use RemoteCache.getWithMetadata(Object) and RemoteCache.replaceWithVersion(Object, Object, long, long, TimeUnit, long, TimeUnit) if possible.

Specified by:

replace in interface org.infinispan.commons.api.BasicCache<K,V>

Specified by:

replace in interface RemoteCache<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

merge

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

Specified by:

merge in interface ConcurrentMap<K,V>

Specified by:

merge in interface Map<K,V>

merge

public V merge(K key,
               V value,
               BiFunction<? super V,? super V,? extends V> remappingFunction,
               long lifespan,
               TimeUnit lifespanUnit,
               long maxIdleTime,
               TimeUnit maxIdleTimeUnit)

Description copied from interface: org.infinispan.commons.api.BasicCache

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

Specified by:

merge in interface org.infinispan.commons.api.BasicCache<K,V>

Parameters:

key - key to use

value - new value to merge with existing value

remappingFunction - function to use to merge new and existing values into a merged value to store under key

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 merged value that was stored under key

merge

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

Description copied from interface: org.infinispan.commons.api.BasicCache

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

Specified by:

merge in interface org.infinispan.commons.api.BasicCache<K,V>

Parameters:

key - key to use

value - new value to merge with existing value

remappingFunction - function to use to merge new and existing values into a merged value to store under key

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

lifespanUnit - time unit for lifespan

Returns:

the merged value that was stored under key

compute

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

Specified by:

compute in interface ConcurrentMap<K,V>

Specified by:

compute in interface Map<K,V>

computeAsync

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

Description copied from interface: org.infinispan.commons.api.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 org.infinispan.commons.api.AsyncCache<K,V>

computeIfAbsent

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

Specified by:

computeIfAbsent in interface ConcurrentMap<K,V>

Specified by:

computeIfAbsent in interface Map<K,V>

computeIfAbsentAsync

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

Description copied from interface: org.infinispan.commons.api.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 org.infinispan.commons.api.AsyncCache<K,V>

computeIfPresent

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

Specified by:

computeIfPresent in interface ConcurrentMap<K,V>

Specified by:

computeIfPresent in interface Map<K,V>

computeIfPresentAsync

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

Description copied from interface: org.infinispan.commons.api.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 org.infinispan.commons.api.AsyncCache<K,V>

compute

public V compute(K key,
                 BiFunction<? super K,? super V,? extends V> remappingFunction,
                 long lifespan,
                 TimeUnit lifespanUnit)

Description copied from interface: org.infinispan.commons.api.BasicCache

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

Specified by:

compute in interface org.infinispan.commons.api.BasicCache<K,V>

Parameters:

key - key to use

remappingFunction - function to use to compute and store the value under key

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

lifespanUnit - time unit for lifespan

Returns:

the computed value that was stored under key

compute

public V compute(K key,
                 BiFunction<? super K,? super V,? extends V> remappingFunction,
                 long lifespan,
                 TimeUnit lifespanUnit,
                 long maxIdleTime,
                 TimeUnit maxIdleTimeUnit)

Description copied from interface: org.infinispan.commons.api.BasicCache

An overloaded form of ConcurrentMap.compute(Object, BiFunction) which takes in lifespan and maxIdleTime parameters.

Specified by:

compute in interface org.infinispan.commons.api.BasicCache<K,V>

Parameters:

key - key to use

remappingFunction - function to use to compute and store the value under key

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 computed value that was stored under key

computeIfPresent

public V computeIfPresent(K key,
                          BiFunction<? super K,? super V,? extends V> remappingFunction,
                          long lifespan,
                          TimeUnit lifespanUnit)

Description copied from interface: org.infinispan.commons.api.BasicCache

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

Specified by:

computeIfPresent in interface org.infinispan.commons.api.BasicCache<K,V>

Parameters:

key - key to use

remappingFunction - function to use to compute and store the value under key, if such exists

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

lifespanUnit - time unit for lifespan

Returns:

the computed value that was stored under key

computeIfPresent

public V computeIfPresent(K key,
                          BiFunction<? super K,? super V,? extends V> remappingFunction,
                          long lifespan,
                          TimeUnit lifespanUnit,
                          long maxIdleTime,
                          TimeUnit maxIdleTimeUnit)

Description copied from interface: org.infinispan.commons.api.BasicCache

An overloaded form of ConcurrentMap.computeIfPresent(Object, BiFunction) which takes in lifespan and maxIdleTime parameters.

Specified by:

computeIfPresent in interface org.infinispan.commons.api.BasicCache<K,V>

Parameters:

key - key to use

remappingFunction - function to use to compute and store the value under key, if such exists

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 computed value that was stored under key

computeIfAbsent

public V computeIfAbsent(K key,
                         Function<? super K,? extends V> mappingFunction,
                         long lifespan,
                         TimeUnit lifespanUnit)

Description copied from interface: org.infinispan.commons.api.BasicCache

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

Specified by:

computeIfAbsent in interface org.infinispan.commons.api.BasicCache<K,V>

Parameters:

key - key to use

mappingFunction - function to use to compute and store the value under key, if the key is absent

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

lifespanUnit - time unit for lifespan

Returns:

the computed value that was stored under key

computeIfAbsent

public V computeIfAbsent(K key,
                         Function<? super K,? extends V> mappingFunction,
                         long lifespan,
                         TimeUnit lifespanUnit,
                         long maxIdleTime,
                         TimeUnit maxIdleTimeUnit)

Description copied from interface: org.infinispan.commons.api.BasicCache

An overloaded form of ConcurrentMap.computeIfAbsent(Object, Function) which takes in lifespan and maxIdleTime parameters.

Specified by:

computeIfAbsent in interface org.infinispan.commons.api.BasicCache<K,V>

Parameters:

key - key to use

mappingFunction - function to use to compute and store the value under key, if the key is absent

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 computed value that was stored under key

computeAsync

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

Description copied from interface: org.infinispan.commons.api.AsyncCache

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

Specified by:

computeAsync in interface org.infinispan.commons.api.AsyncCache<K,V>

computeAsync

public CompletableFuture<V> computeAsync(K key,
                                         BiFunction<? super K,? super V,? extends V> remappingFunction,
                                         long lifespan,
                                         TimeUnit lifespanUnit,
                                         long maxIdle,
                                         TimeUnit maxIdleUnit)

Description copied from interface: org.infinispan.commons.api.AsyncCache

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

Specified by:

computeAsync in interface org.infinispan.commons.api.AsyncCache<K,V>

computeIfAbsentAsync

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

Description copied from interface: org.infinispan.commons.api.AsyncCache

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

Specified by:

computeIfAbsentAsync in interface org.infinispan.commons.api.AsyncCache<K,V>

computeIfAbsentAsync

public CompletableFuture<V> computeIfAbsentAsync(K key,
                                                 Function<? super K,? extends V> mappingFunction,
                                                 long lifespan,
                                                 TimeUnit lifespanUnit,
                                                 long maxIdle,
                                                 TimeUnit maxIdleUnit)

Description copied from interface: org.infinispan.commons.api.AsyncCache

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

Specified by:

computeIfAbsentAsync in interface org.infinispan.commons.api.AsyncCache<K,V>

computeIfPresentAsync

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

Description copied from interface: org.infinispan.commons.api.AsyncCache

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

Specified by:

computeIfPresentAsync in interface org.infinispan.commons.api.AsyncCache<K,V>

computeIfPresentAsync

public CompletableFuture<V> computeIfPresentAsync(K key,
                                                  BiFunction<? super K,? super V,? extends V> remappingFunction,
                                                  long lifespan,
                                                  TimeUnit lifespanUnit,
                                                  long maxIdle,
                                                  TimeUnit maxIdleUnit)

Description copied from interface: org.infinispan.commons.api.AsyncCache

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

Specified by:

computeIfPresentAsync in interface org.infinispan.commons.api.AsyncCache<K,V>

mergeAsync

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

Description copied from interface: org.infinispan.commons.api.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 org.infinispan.commons.api.AsyncCache<K,V>

mergeAsync

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

Description copied from interface: org.infinispan.commons.api.AsyncCache

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

Specified by:

mergeAsync in interface org.infinispan.commons.api.AsyncCache<K,V>

mergeAsync

public CompletableFuture<V> mergeAsync(K key,
                                       V value,
                                       BiFunction<? super V,? super V,? extends V> remappingFunction,
                                       long lifespan,
                                       TimeUnit lifespanUnit,
                                       long maxIdleTime,
                                       TimeUnit maxIdleTimeUnit)

Description copied from interface: org.infinispan.commons.api.AsyncCache

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

Specified by:

mergeAsync in interface org.infinispan.commons.api.AsyncCache<K,V>

replaceAll

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

Specified by:

replaceAll in interface ConcurrentMap<K,V>

Specified by:

replaceAll in interface Map<K,V>