Class 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
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:
-
Nested Class Summary
-
Field Summary
Fields inherited from class org.infinispan.cache.impl.AbstractDelegatingAdvancedCache
cache -
Constructor Summary
ConstructorsConstructorDescriptionDecoratedCache(CacheImpl<K, V> delegate, long flagsBitSet) DecoratedCache(CacheImpl<K, V> delegate, Object lockOwner, long newFlags) -
Method Summary
Modifier and TypeMethodDescription<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 ofFilteringListenable.addFilteredListener(Object, CacheEventFilter, CacheEventConverter, Set)addListenerAsync(Object listener) Asynchronous version ofListenable.addListener(Object)<C> CompletionStage<Void> addListenerAsync(Object listener, CacheEventFilter<? super K, ? super V> filter, CacheEventConverter<? super K, ? super V, C> converter) Asynchronous version ofFilteringListenable.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) CacheSet<CacheEntry<K, V>> Identical toCache.entrySet()but is typed to return CacheEntries instead of Entries.Provides aPublishertype instance that can be used to publish values from this Cache.voidclear()Removes all mappings from the cache.Asynchronous version ofMap.clear().An overloaded form ofCache.compute(Object, BiFunction), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.computeAsync(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction) Asynchronous version ofConcurrentMap.compute(Object, BiFunction).computeIfAbsent(K key, Function<? super K, ? extends V> mappingFunction) An overloaded form ofCache.computeIfAbsent(Object, Function), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.computeIfAbsentAsync(K key, Function<? super K, ? extends V> mappingFunction) Asynchronous version ofConcurrentMap.computeIfAbsent(Object, Function).computeIfPresent(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction) computeIfPresent(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, Metadata metadata) An overloaded form ofCache.computeIfPresent(Object, BiFunction), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.computeIfPresentAsync(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction) Asynchronous version ofConcurrentMap.computeIfPresent(Object, BiFunction).booleancontainsKey(Object key) booleancontainsValue(Object value) entrySet()Returns a set view of the mappings contained in this cache and cache loader across the entire cluster.voidEvicts an entry from the memory of the cache.Gets a collection of entries, returning them asMapof the values associated with the set of keys requested.getAllAsync(Set<?> keys) TODO This should be in AdvancedCache with getAllMap<K, CacheEntry<K, V>> getAllCacheEntries(Set<?> keys) Gets a collection of entries from theAdvancedCache, returning them asMapof the cache entries associated with the set of keys requested.Asynchronous version ofMap.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.getCacheEntryAsync(Object key) Retrieves a CacheEntry corresponding to a specific key.Returns the cache loader associated with this cache.longIt fetches all the keys which belong to the group.booleanisEmpty()keySet()Returns a set view of the keys contained in this cache and cache loader across the entire cluster.booleanlock(Collection<? extends K> keys) Locks collections of keys eagerly across cache nodes in a cluster.booleanLocks a given key or keys eagerly across cache nodes in a cluster.Whenever this cache acquires a lock it will do so using the given Object as the owner of said lock.Returns a sequential stream using this Cache as the source.merge(K key, V value, BiFunction<? super V, ? super V, ? extends V> remappingFunction, Metadata metadata) An overloaded form ofCache.merge(Object, Object, BiFunction), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.mergeAsync(K key, V value, BiFunction<? super V, ? super V, ? extends V> remappingFunction) Asynchronous version ofConcurrentMap.merge(Object, Object, BiFunction).protected DecoratedCache<K, V> newInstance(CacheImpl<K, V> impl, Object lockOwner, long newFlags) noFlags()Unset all flags set on this cache usingAdvancedCache.withFlags(Flag...)orAdvancedCache.withFlags(Collection)methods.If the return value of this operation will be ignored by the application, the user is strongly encouraged to use theorg.infinispan.context.Flag#IGNORE_RETURN_VALUESflag when invoking this method in order to make it behave as efficiently as possible (i.e. avoiding needless remote or network calls).An overloaded form ofBasicCache.put(Object, Object), which takes in lifespan parameters.put(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit) An overloaded form ofBasicCache.put(Object, Object), which takes in lifespan parameters.An overloaded form ofBasicCache.put(Object, Object), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.voidvoidAn overloaded form ofMap.putAll(Map), which takes in lifespan parameters.voidputAll(Map<? extends K, ? extends V> map, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit) An overloaded form ofMap.putAll(Map), which takes in lifespan parameters.voidAn overloaded form ofMap.putAll(Map), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entries being stored, such as lifespan, version of value...etc.putAllAsync(Map<? extends K, ? extends V> data) Asynchronous version ofMap.putAll(Map).putAllAsync(Map<? extends K, ? extends V> data, long lifespan, TimeUnit unit) Asynchronous version ofBasicCache.putAll(Map, long, TimeUnit).putAllAsync(Map<? extends K, ? extends V> data, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit) Asynchronous version ofBasicCache.putAll(Map, long, TimeUnit, long, TimeUnit).putAllAsync(Map<? extends K, ? extends V> data, Metadata metadata) Asynchronous version ofBasicCache.put(Object, Object).Asynchronous version ofBasicCache.put(Object, Object, long, TimeUnit).Asynchronous version ofBasicCache.put(Object, Object, long, TimeUnit, long, TimeUnit).Asynchronous version ofAdvancedCache.put(Object, Object, Metadata)which stores metadata alongside the value.putAsyncEntry(K key, V value, Metadata metadata) Extension ofAdvancedCache.putAsync(Object, Object, Metadata)which returns aCacheEntryinstead of only the previous value.voidputForExternalRead(K key, V value) Under special operating behavior, associates the value with the specified key.voidputForExternalRead(K key, V value, long lifespan, TimeUnit unit) An overloaded form ofCache.putForExternalRead(K, V), which takes in lifespan parameters.voidputForExternalRead(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit) An overloaded form ofCache.putForExternalRead(K, V), which takes in lifespan parameters.voidputForExternalRead(K key, V value, Metadata metadata) An overloaded form ofCache.putForExternalRead(Object, Object), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.putIfAbsent(K key, V value) putIfAbsent(K key, V value, long lifespan, TimeUnit unit) An overloaded form ofConcurrentMap.putIfAbsent(Object, Object), which takes in lifespan parameters.putIfAbsent(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit) An overloaded form ofConcurrentMap.putIfAbsent(Object, Object), which takes in lifespan parameters.putIfAbsent(K key, V value, Metadata metadata) An overloaded form ofConcurrentMap.putIfAbsent(Object, Object), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.putIfAbsentAsync(K key, V value) Asynchronous version ofConcurrentMap.putIfAbsent(Object, Object).putIfAbsentAsync(K key, V value, long lifespan, TimeUnit unit) Asynchronous version ofBasicCache.putIfAbsent(Object, Object, long, TimeUnit).putIfAbsentAsync(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit) Asynchronous version ofBasicCache.putIfAbsent(Object, Object, long, TimeUnit, long, TimeUnit).putIfAbsentAsync(K key, V value, Metadata metadata) An overloaded form ofAsyncCache.putIfAbsentAsync(Object, Object), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.putIfAbsentAsyncEntry(K key, V value, Metadata metadata) An extension form ofAdvancedCache.putIfAbsentAsync(Object, Object, Metadata), which returns aCacheEntryinstead of only the value.protected InvocationContextreadContext(int size) If the return value of this operation will be ignored by the application, the user is strongly encouraged to use theorg.infinispan.context.Flag#IGNORE_RETURN_VALUESflag when invoking this method in order to make it behave as efficiently as possible (i.e. avoiding needless remote or network calls).booleanremoveAsync(Object key) Asynchronous version ofBasicCache.remove(Object).removeAsync(Object key, Object value) Asynchronous version ofConcurrentMap.remove(Object, Object).removeAsyncEntry(Object key) An extension ofAsyncCache.removeAsync(Object), which returns aCacheEntryinstead of only the value.voidremoveGroup(String groupName) It removes all the key which belongs to a group.removeLifespanExpired(K key, V value, Long lifespan) Attempts to remove the entry if it is expired.removeMaxIdleExpired(K key, V value) Attempts to remove the entry for the given key, if it has expired due to max idle.An overloaded form ofConcurrentMap.replace(Object, Object), which takes in lifespan parameters.replace(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit) An overloaded form ofConcurrentMap.replace(Object, Object), which takes in lifespan parameters.An overloaded form ofConcurrentMap.replace(Object, Object), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.booleanbooleanAn overloaded form ofConcurrentMap.replace(Object, Object, Object), which takes in lifespan parameters.booleanreplace(K key, V oldValue, V value, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit) An overloaded form ofConcurrentMap.replace(Object, Object, Object), which takes in lifespan parameters.booleanAn overloaded form ofConcurrentMap.replace(Object, Object, Object), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.replaceAsync(K key, V value) Asynchronous version ofConcurrentMap.replace(Object, Object).replaceAsync(K key, V value, long lifespan, TimeUnit unit) Asynchronous version ofBasicCache.replace(Object, Object, long, TimeUnit).replaceAsync(K key, V value, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit) Asynchronous version ofBasicCache.replace(Object, Object, long, TimeUnit, long, TimeUnit).replaceAsync(K key, V value, Metadata metadata) An overloaded form ofAsyncCache.replaceAsync(Object, Object), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.replaceAsync(K key, V oldValue, V newValue) Asynchronous version ofConcurrentMap.replace(Object, Object, Object).replaceAsync(K key, V oldValue, V newValue, long lifespan, TimeUnit unit) Asynchronous version ofBasicCache.replace(Object, Object, Object, long, TimeUnit).replaceAsync(K key, V oldValue, V newValue, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit) Asynchronous version ofBasicCache.replace(Object, Object, Object, long, TimeUnit, long, TimeUnit).replaceAsync(K key, V oldValue, V newValue, Metadata metadata) replaceAsyncEntry(K key, V value, Metadata metadata) An extension ofAdvancedCache.replaceAsync(Object, Object, Metadata), which returns aCacheEntryinstead of only the value.rewrap(AdvancedCache newDelegate) No generics because some methods returnAdvancedCache<?, ?>, and returning the proper type would require erasure anyway.intsize()Returns a count of all elements in this cache and cache loader across the entire cluster.Asynchronous version ofMap.size().voidstop()Stops a cache.values()Returns a collection view of the values contained in this cache across the entire cluster.withEncoding(Class<? extends Encoder> encoderClass) Performs any cache operations using the specifiedEncoder.withEncoding(Class<? extends Encoder> keyEncoderClass, Class<? extends Encoder> valueEncoderClass) Performs any cache operations using the specified pair ofEncoder.withFlags(Collection<Flag> flags) An alternative toAdvancedCache.withFlags(Flag...)not requiring array allocation.An alternative toAdvancedCache.withFlags(Flag...)optimized for a single flag.A method that adds flags to any API call.withWrapping(Class<? extends Wrapper> wrapperClass) Deprecated, for removal: This API element is subject to removal in a future version.withWrapping(Class<? extends Wrapper> keyWrapperClass, Class<? extends Wrapper> valueWrapperClass) Deprecated, for removal: This API element is subject to removal in a future version.protected InvocationContextwriteContext(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, withSubjectMethods 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, unwrapCacheMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.infinispan.AdvancedCache
compute, computeAsync, computeIfAbsent, computeIfAbsentAsync, computeIfPresent, computeIfPresentAsync, merge, mergeAsyncMethods inherited from interface org.infinispan.commons.api.AsyncCache
containsKeyAsyncMethods inherited from interface org.infinispan.commons.api.BasicCache
compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, continuousQuery, getName, getVersion, merge, merge, queryMethods inherited from interface org.infinispan.commons.api.BatchingCache
endBatch, startBatchMethods 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, shutdownMethods inherited from interface java.util.concurrent.ConcurrentMap
forEach, getOrDefault, replaceAllMethods inherited from interface org.infinispan.notifications.FilteringListenable
addFilteredListener, addListener, addStorageFormatFilteredListenerMethods inherited from interface org.infinispan.cache.impl.InternalCache
bypassInvocationContextFactoryMethods inherited from interface org.infinispan.notifications.Listenable
addListener, removeListener, removeListenerAsync
-
Constructor Details
-
DecoratedCache
-
DecoratedCache
-
-
Method Details
-
rewrap
Description copied from class:AbstractDelegatingAdvancedCacheNo generics because some methods returnAdvancedCache<?, ?>, and returning the proper type would require erasure anyway.- Specified by:
rewrapin classAbstractDelegatingAdvancedCache<K,V>
-
withFlags
Description copied from interface:AdvancedCacheA 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:
withFlagsin interfaceAdvancedCache<K,V> - Overrides:
withFlagsin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
flags- a set of flags to apply. See theFlagdocumentation.- Returns:
- an
AdvancedCacheinstance on which a real operation is to be invoked, if the flags are to be applied.
-
withFlags
Description copied from interface:AdvancedCacheAn alternative toAdvancedCache.withFlags(Flag...)not requiring array allocation.- Specified by:
withFlagsin interfaceAdvancedCache<K,V> - Overrides:
withFlagsin classAbstractDelegatingAdvancedCache<K,V>
-
withFlags
Description copied from interface:AdvancedCacheAn alternative toAdvancedCache.withFlags(Flag...)optimized for a single flag.- Specified by:
withFlagsin interfaceAdvancedCache<K,V> - Overrides:
withFlagsin classAbstractDelegatingAdvancedCache<K,V>
-
newInstance
-
noFlags
Description copied from interface:AdvancedCacheUnset all flags set on this cache usingAdvancedCache.withFlags(Flag...)orAdvancedCache.withFlags(Collection)methods.- Specified by:
noFlagsin interfaceAdvancedCache<K,V> - Overrides:
noFlagsin classAbstractDelegatingAdvancedCache<K,V> - Returns:
- Cache not applying any flags to the command; possibly
this.
-
withEncoding
Description copied from interface:AdvancedCachePerforms any cache operations using the specifiedEncoder.- Specified by:
withEncodingin interfaceAdvancedCache<K,V> - Overrides:
withEncodingin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
encoderClass-Encoderused for both keys and values.- Returns:
- an instance of
AdvancedCachewhere 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:AdvancedCachePerforms any cache operations using the specified pair ofEncoder.- Specified by:
withEncodingin interfaceAdvancedCache<K,V> - Overrides:
withEncodingin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
keyEncoderClass-Encoderfor the keys.valueEncoderClass-Encoderfor the values.- Returns:
- an instance of
AdvancedCachewhere 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:AdvancedCachePerforms any cache operations using the specifiedWrapper.- Specified by:
withWrappingin interfaceAdvancedCache<K,V> - Overrides:
withWrappingin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
wrapperClass-Wrapperfor the keys and values.- Returns:
- an instance of
AdvancedCachewhere 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:AdvancedCachePerforms any cache operations using the specified pair ofWrapper.- Specified by:
withWrappingin interfaceAdvancedCache<K,V> - Overrides:
withWrappingin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
keyWrapperClass-Wrapperfor the keys.valueWrapperClass-Wrapperfor the values.- Returns:
AdvancedCachewhere all operations will use the supplied wrappers.
-
lockAs
Description copied from interface:AdvancedCacheWhenever 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:
lockAsin interfaceAdvancedCache<K,V> - Overrides:
lockAsin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
lockOwner- the lock owner to lock any keys as- Returns:
- an
AdvancedCacheinstance on which when an operation is invoked it will use lock owner object to acquire any locks
-
getLockOwner
-
lockedStream
Description copied from interface:AdvancedCacheReturns a sequential stream using this Cache as the source. This stream is very similar to using theCacheStreamreturned from theCacheCollection.stream()method of the collection returned viaAdvancedCache.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 toLockingMode.OPTIMISTIC, do not support this method. In this case it will throw anUnsupportedOperationException. 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 viaAdvancedCache.lockAs(Object)as this could lead to a deadlock or the release of locks early and will throw anIllegalStateException.- Specified by:
lockedStreamin interfaceAdvancedCache<K,V> - Overrides:
lockedStreamin classAbstractDelegatingAdvancedCache<K,V> - Returns:
- the locked stream
-
getClassLoader
Description copied from interface:AdvancedCacheReturns the cache loader associated with this cache. As an alternative to setting this on every invocation, users could also consider using theDecoratedCachewrapper.- Specified by:
getClassLoaderin interfaceAdvancedCache<K,V> - Overrides:
getClassLoaderin classAbstractDelegatingAdvancedCache<K,V> - Returns:
- this cache's cache loader
-
stop
public void stop()Description copied from interface:CacheStops 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 theCache.shutdown()method. -
lock
Description copied from interface:AdvancedCacheLocks 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:
lockin interfaceAdvancedCache<K,V> - Overrides:
lockin classAbstractDelegatingAdvancedCache<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
Description copied from interface:AdvancedCacheLocks 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:
lockin interfaceAdvancedCache<K,V> - Overrides:
lockin classAbstractDelegatingAdvancedCache<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
Description copied from interface:CacheUnder 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
- Specified by:
putForExternalReadin interfaceCache<K,V> - Overrides:
putForExternalReadin classAbstractDelegatingCache<K,V> - Parameters:
key- key with which the specified value is to be associated.value- value to be associated with the specified key.
- Only goes through if the
key specified does not exist; no-op otherwise (similar to
-
putForExternalRead
Description copied from interface:AdvancedCacheAn overloaded form ofCache.putForExternalRead(Object, Object), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. TheMetadatais only stored if the call is successful.- Specified by:
putForExternalReadin interfaceAdvancedCache<K,V> - Overrides:
putForExternalReadin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
key- key with which the specified value is to be associatedvalue- value to be associated with the specified keymetadata- information to store alongside the new value
-
putForExternalRead
Description copied from interface:CacheAn overloaded form ofCache.putForExternalRead(K, V), which takes in lifespan parameters.- Specified by:
putForExternalReadin interfaceCache<K,V> - Overrides:
putForExternalReadin classAbstractDelegatingCache<K,V> - Parameters:
key- key to usevalue- value to storelifespan- 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:CacheAn overloaded form ofCache.putForExternalRead(K, V), which takes in lifespan parameters.- Specified by:
putForExternalReadin interfaceCache<K,V> - Overrides:
putForExternalReadin classAbstractDelegatingCache<K,V> - Parameters:
key- key to usevalue- value to storelifespan- lifespan of the entry. Negative values are interpreted as unlimited lifespan.lifespanUnit- time unit for lifespanmaxIdle- the maximum amount of time this key is allowed to be idle for before it is considered as expiredmaxIdleUnit- time unit for max idle time
-
evict
Description copied from interface:CacheEvicts 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). UseBasicCache.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. -
put
Description copied from interface:BasicCacheAn overloaded form ofBasicCache.put(Object, Object), which takes in lifespan parameters.- Specified by:
putin interfaceBasicCache<K,V> - Overrides:
putin classAbstractDelegatingCache<K,V> - Parameters:
key- key to usevalue- value to storelifespan- 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
Description copied from interface:BasicCacheAn overloaded form ofConcurrentMap.putIfAbsent(Object, Object), which takes in lifespan parameters.- Specified by:
putIfAbsentin interfaceBasicCache<K,V> - Overrides:
putIfAbsentin classAbstractDelegatingCache<K,V> - Parameters:
key- key to usevalue- value to storelifespan- 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
Description copied from interface:BasicCacheAn overloaded form ofMap.putAll(Map), which takes in lifespan parameters. Note that the lifespan is applied to all mappings in the map passed in.- Specified by:
putAllin interfaceBasicCache<K,V> - Overrides:
putAllin classAbstractDelegatingCache<K,V> - Parameters:
map- map containing mappings to enterlifespan- lifespan of the entry. Negative values are interpreted as unlimited lifespan.unit- unit of measurement for the lifespan
-
replace
Description copied from interface:BasicCacheAn overloaded form ofConcurrentMap.replace(Object, Object), which takes in lifespan parameters.- Specified by:
replacein interfaceBasicCache<K,V> - Overrides:
replacein classAbstractDelegatingCache<K,V> - Parameters:
key- key to usevalue- value to storelifespan- 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
Description copied from interface:BasicCacheAn overloaded form ofConcurrentMap.replace(Object, Object, Object), which takes in lifespan parameters.- Specified by:
replacein interfaceBasicCache<K,V> - Overrides:
replacein classAbstractDelegatingCache<K,V> - Parameters:
key- key to useoldValue- value to replacevalue- value to storelifespan- 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:BasicCacheAn overloaded form ofBasicCache.put(Object, Object), which takes in lifespan parameters.- Specified by:
putin interfaceBasicCache<K,V> - Overrides:
putin classAbstractDelegatingCache<K,V> - Parameters:
key- key to usevalue- value to storelifespan- lifespan of the entry. Negative values are interpreted as unlimited lifespan.lifespanUnit- time unit for lifespanmaxIdleTime- the maximum amount of time this key is allowed to be idle for before it is considered as expiredmaxIdleTimeUnit- 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:BasicCacheAn overloaded form ofConcurrentMap.putIfAbsent(Object, Object), which takes in lifespan parameters.- Specified by:
putIfAbsentin interfaceBasicCache<K,V> - Overrides:
putIfAbsentin classAbstractDelegatingCache<K,V> - Parameters:
key- key to usevalue- value to storelifespan- lifespan of the entry. Negative values are interpreted as unlimited lifespan.lifespanUnit- time unit for lifespanmaxIdleTime- the maximum amount of time this key is allowed to be idle for before it is considered as expiredmaxIdleTimeUnit- 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:BasicCacheAn overloaded form ofMap.putAll(Map), which takes in lifespan parameters. Note that the lifespan is applied to all mappings in the map passed in.- Specified by:
putAllin interfaceBasicCache<K,V> - Overrides:
putAllin classAbstractDelegatingCache<K,V> - Parameters:
map- map containing mappings to enterlifespan- lifespan of the entry. Negative values are interpreted as unlimited lifespan.lifespanUnit- time unit for lifespanmaxIdleTime- the maximum amount of time this key is allowed to be idle for before it is considered as expiredmaxIdleTimeUnit- 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:BasicCacheAn overloaded form ofConcurrentMap.replace(Object, Object), which takes in lifespan parameters.- Specified by:
replacein interfaceBasicCache<K,V> - Overrides:
replacein classAbstractDelegatingCache<K,V> - Parameters:
key- key to usevalue- value to storelifespan- lifespan of the entry. Negative values are interpreted as unlimited lifespan.lifespanUnit- time unit for lifespanmaxIdleTime- the maximum amount of time this key is allowed to be idle for before it is considered as expiredmaxIdleTimeUnit- 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:BasicCacheAn overloaded form ofConcurrentMap.replace(Object, Object, Object), which takes in lifespan parameters.- Specified by:
replacein interfaceBasicCache<K,V> - Overrides:
replacein classAbstractDelegatingCache<K,V> - Parameters:
key- key to useoldValue- value to replacevalue- value to storelifespan- lifespan of the entry. Negative values are interpreted as unlimited lifespan.lifespanUnit- time unit for lifespanmaxIdleTime- the maximum amount of time this key is allowed to be idle for before it is considered as expiredmaxIdleTimeUnit- time unit for max idle time- Returns:
- true if the value was replaced, false otherwise
-
putAsync
Description copied from interface:AsyncCacheAsynchronous version ofBasicCache.put(Object, Object). This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
putAsyncin interfaceAsyncCache<K,V> - Overrides:
putAsyncin classAbstractDelegatingCache<K,V> - Parameters:
key- key to usevalue- value to store- Returns:
- a future containing the old value replaced.
-
putAsync
Description copied from interface:AsyncCacheAsynchronous version ofBasicCache.put(Object, Object, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
putAsyncin interfaceAsyncCache<K,V> - Overrides:
putAsyncin classAbstractDelegatingCache<K,V> - Parameters:
key- key to usevalue- value to storelifespan- lifespan of entryunit- 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:AsyncCacheAsynchronous version ofBasicCache.put(Object, Object, long, TimeUnit, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
putAsyncin interfaceAsyncCache<K,V> - Overrides:
putAsyncin classAbstractDelegatingCache<K,V> - Parameters:
key- key to usevalue- value to storelifespan- lifespan of entrylifespanUnit- time unit for lifespanmaxIdle- the maximum amount of time this key is allowed to be idle for before it is considered as expiredmaxIdleUnit- time unit for max idle time- Returns:
- a future containing the old value replaced
-
putAllAsync
Description copied from interface:AsyncCacheAsynchronous version ofMap.putAll(Map). This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
putAllAsyncin interfaceAsyncCache<K,V> - Overrides:
putAllAsyncin classAbstractDelegatingCache<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:AsyncCacheAsynchronous version ofBasicCache.putAll(Map, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
putAllAsyncin interfaceAsyncCache<K,V> - Overrides:
putAllAsyncin classAbstractDelegatingCache<K,V> - Parameters:
data- to storelifespan- lifespan of entryunit- 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:AsyncCacheAsynchronous version ofBasicCache.putAll(Map, long, TimeUnit, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
putAllAsyncin interfaceAsyncCache<K,V> - Overrides:
putAllAsyncin classAbstractDelegatingCache<K,V> - Parameters:
data- to storelifespan- lifespan of entrylifespanUnit- time unit for lifespanmaxIdle- the maximum amount of time this key is allowed to be idle for before it is considered as expiredmaxIdleUnit- time unit for max idle time- Returns:
- a future containing a void return type
-
putAllAsync
- Specified by:
putAllAsyncin interfaceAdvancedCache<K,V> - Overrides:
putAllAsyncin classAbstractDelegatingAdvancedCache<K,V>
-
clearAsync
Description copied from interface:AsyncCacheAsynchronous version ofMap.clear(). This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
clearAsyncin interfaceAsyncCache<K,V> - Overrides:
clearAsyncin classAbstractDelegatingCache<K,V> - Returns:
- a future containing a void return type
-
putIfAbsentAsync
Description copied from interface:AsyncCacheAsynchronous version ofConcurrentMap.putIfAbsent(Object, Object). This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
putIfAbsentAsyncin interfaceAsyncCache<K,V> - Overrides:
putIfAbsentAsyncin classAbstractDelegatingCache<K,V> - Parameters:
key- key to usevalue- value to store- Returns:
- a future containing the old value replaced.
-
putIfAbsentAsync
Description copied from interface:AsyncCacheAsynchronous version ofBasicCache.putIfAbsent(Object, Object, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
putIfAbsentAsyncin interfaceAsyncCache<K,V> - Overrides:
putIfAbsentAsyncin classAbstractDelegatingCache<K,V> - Parameters:
key- key to usevalue- value to storelifespan- lifespan of entryunit- 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:AsyncCacheAsynchronous version ofBasicCache.putIfAbsent(Object, Object, long, TimeUnit, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
putIfAbsentAsyncin interfaceAsyncCache<K,V> - Overrides:
putIfAbsentAsyncin classAbstractDelegatingCache<K,V> - Parameters:
key- key to usevalue- value to storelifespan- lifespan of entrylifespanUnit- time unit for lifespanmaxIdle- the maximum amount of time this key is allowed to be idle for before it is considered as expiredmaxIdleUnit- time unit for max idle time- Returns:
- a future containing the old value replaced
-
putIfAbsentAsync
Description copied from interface:AdvancedCacheAn overloaded form ofAsyncCache.putIfAbsentAsync(Object, Object), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. TheMetadatais only stored if the call is successful.- Specified by:
putIfAbsentAsyncin interfaceAdvancedCache<K,V> - Overrides:
putIfAbsentAsyncin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
key- key with which the specified value is to be associatedvalue- value to be associated with the specified keymetadata- information to store alongside the new value- Returns:
- A future containing the previous value associated with the specified key, or
nullif there was no mapping for the key.
-
putIfAbsentAsyncEntry
Description copied from interface:AdvancedCacheAn extension form ofAdvancedCache.putIfAbsentAsync(Object, Object, Metadata), which returns aCacheEntryinstead of only the value.- Specified by:
putIfAbsentAsyncEntryin interfaceAdvancedCache<K,V> - Overrides:
putIfAbsentAsyncEntryin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
key- key with which the specified value is to be associatedvalue- value to be associated with the specified keymetadata- information to store alongside the new value- Returns:
- the future that contains previous
CacheEntryassociated with the specified key, ornullif there was no mapping for the key. - See Also:
-
removeAsync
Description copied from interface:AsyncCacheAsynchronous version ofBasicCache.remove(Object). This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
removeAsyncin interfaceAsyncCache<K,V> - Overrides:
removeAsyncin classAbstractDelegatingCache<K,V> - Parameters:
key- key to remove- Returns:
- a future containing the value removed
-
removeAsyncEntry
Description copied from interface:AdvancedCacheAn extension ofAsyncCache.removeAsync(Object), which returns aCacheEntryinstead of only the value.- Specified by:
removeAsyncEntryin interfaceAdvancedCache<K,V> - Overrides:
removeAsyncEntryin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
key- key to remove- Returns:
- a future containing the
CacheEntryremoved ornullif not found. - See Also:
-
removeAsync
Description copied from interface:AsyncCacheAsynchronous version ofConcurrentMap.remove(Object, Object). This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
removeAsyncin interfaceAsyncCache<K,V> - Overrides:
removeAsyncin classAbstractDelegatingCache<K,V> - Parameters:
key- key to removevalue- value to match on- Returns:
- a future containing a boolean, indicating whether the entry was removed or not
-
removeLifespanExpired
Description copied from interface:AdvancedCacheAttempts 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 theExpirationManager.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:
removeLifespanExpiredin interfaceAdvancedCache<K,V> - Overrides:
removeLifespanExpiredin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
key- the key that is expiringvalue- the value that mapped to the given. Null means it will match any valuelifespan- the lifespan that should match. If null is provided it will match any lifespan value- Returns:
- if the entry was removed
-
removeMaxIdleExpired
Description copied from interface:AdvancedCacheAttempts 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:
removeMaxIdleExpiredin interfaceAdvancedCache<K,V> - Overrides:
removeMaxIdleExpiredin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
key- the key that expired via max idle for the given entry- Returns:
- if the entry was removed
-
replaceAsync
Description copied from interface:AsyncCacheAsynchronous version ofConcurrentMap.replace(Object, Object). This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
replaceAsyncin interfaceAsyncCache<K,V> - Overrides:
replaceAsyncin classAbstractDelegatingCache<K,V> - Parameters:
key- key to removevalue- value to store- Returns:
- a future containing the previous value overwritten
-
replaceAsync
Description copied from interface:AsyncCacheAsynchronous version ofBasicCache.replace(Object, Object, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
replaceAsyncin interfaceAsyncCache<K,V> - Overrides:
replaceAsyncin classAbstractDelegatingCache<K,V> - Parameters:
key- key to removevalue- value to storelifespan- lifespan of entryunit- 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:AsyncCacheAsynchronous version ofBasicCache.replace(Object, Object, long, TimeUnit, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
replaceAsyncin interfaceAsyncCache<K,V> - Overrides:
replaceAsyncin classAbstractDelegatingCache<K,V> - Parameters:
key- key to removevalue- value to storelifespan- lifespan of entrylifespanUnit- time unit for lifespanmaxIdle- the maximum amount of time this key is allowed to be idle for before it is considered as expiredmaxIdleUnit- time unit for max idle time- Returns:
- a future containing the previous value overwritten
-
replaceAsync
Description copied from interface:AdvancedCacheAn overloaded form ofAsyncCache.replaceAsync(Object, Object), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. TheMetadatais only stored if the call is successful.- Specified by:
replaceAsyncin interfaceAdvancedCache<K,V> - Overrides:
replaceAsyncin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
key- key with which the specified value is associatedvalue- value to be associated with the specified keymetadata- information to store alongside the new value- Returns:
- the future that contains previous value associated with the specified key, or
nullif there was no mapping for the key.
-
replaceAsyncEntry
Description copied from interface:AdvancedCacheAn extension ofAdvancedCache.replaceAsync(Object, Object, Metadata), which returns aCacheEntryinstead of only the value.- Specified by:
replaceAsyncEntryin interfaceAdvancedCache<K,V> - Overrides:
replaceAsyncEntryin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
key- key with which the specified value is associatedvalue- value to be associated with the specified keymetadata- information to store alongside the new value- Returns:
- the future that contains previous
CacheEntryassociated with the specified key, ornullif there was no mapping for the key. - See Also:
-
replaceAsync
Description copied from interface:AsyncCacheAsynchronous version ofConcurrentMap.replace(Object, Object, Object). This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
replaceAsyncin interfaceAsyncCache<K,V> - Overrides:
replaceAsyncin classAbstractDelegatingCache<K,V> - Parameters:
key- key to removeoldValue- value to overwritenewValue- 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:AsyncCacheAsynchronous version ofBasicCache.replace(Object, Object, Object, long, TimeUnit). This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
replaceAsyncin interfaceAsyncCache<K,V> - Overrides:
replaceAsyncin classAbstractDelegatingCache<K,V> - Parameters:
key- key to removeoldValue- value to overwritenewValue- value to storelifespan- lifespan of entryunit- 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:AsyncCacheAsynchronous version ofBasicCache.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:
replaceAsyncin interfaceAsyncCache<K,V> - Overrides:
replaceAsyncin classAbstractDelegatingCache<K,V> - Parameters:
key- key to removeoldValue- value to overwritenewValue- value to storelifespan- lifespan of entrylifespanUnit- time unit for lifespanmaxIdle- the maximum amount of time this key is allowed to be idle for before it is considered as expiredmaxIdleUnit- time unit for max idle time- Returns:
- a future containing a boolean, indicating whether the entry was replaced or not
-
replaceAsync
- Specified by:
replaceAsyncin interfaceAdvancedCache<K,V> - Overrides:
replaceAsyncin classAbstractDelegatingAdvancedCache<K,V>
-
getAsync
Description copied from interface:AsyncCacheAsynchronous version ofMap.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 toMap.get(Object).- Specified by:
getAsyncin interfaceAsyncCache<K,V> - Overrides:
getAsyncin classAbstractDelegatingCache<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
Description copied from interface:AsyncCacheTODO This should be in AdvancedCache with getAll- Specified by:
getAllAsyncin interfaceAsyncCache<K,V> - Overrides:
getAllAsyncin classAbstractDelegatingAdvancedCache<K,V>
-
size
public int size()Description copied from interface:CacheReturns 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 very slow. If there are performance concerns then theFlag.SKIP_CACHE_LOADflag 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 theFlag.CACHE_MODE_LOCALflag so that other remote nodes are not queried for data. However, the loader will still be used unless the previously mentionedFlag.SKIP_CACHE_LOADis 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 aIsolationLevel.READ_COMMITTEDbehavior 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 usingIsolationLevel.REPEATABLE_READThis 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. -
sizeAsync
Description copied from interface:AsyncCacheAsynchronous version ofMap.size(). This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
sizeAsyncin interfaceAsyncCache<K,V> - Overrides:
sizeAsyncin classAbstractDelegatingCache<K,V> - Returns:
- a future containing the count of the cache
-
isEmpty
-
containsKey
- Specified by:
containsKeyin interfaceMap<K,V> - Overrides:
containsKeyin classAbstractDelegatingCache<K,V>
-
containsValue
- Specified by:
containsValuein interfaceMap<K,V> - Overrides:
containsValuein classAbstractDelegatingCache<K,V>
-
get
-
getAll
Description copied from interface:AdvancedCacheGets a collection of entries, returning them asMapof 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
NonBlockingStoreis 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
Mapwill 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:
getAllin interfaceAdvancedCache<K,V> - Overrides:
getAllin classAbstractDelegatingAdvancedCache<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
Description copied from interface:AdvancedCacheGets a collection of entries from theAdvancedCache, returning them asMapof 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
NonBlockingStoreis 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
Mapwill 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:
getAllCacheEntriesin interfaceAdvancedCache<K,V> - Overrides:
getAllCacheEntriesin classAbstractDelegatingAdvancedCache<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
Description copied from interface:BasicCacheIf the return value of this operation will be ignored by the application, the user is strongly encouraged to use theorg.infinispan.context.Flag#IGNORE_RETURN_VALUESflag when invoking this method in order to make it behave as efficiently as possible (i.e. avoiding needless remote or network calls). -
remove
Description copied from interface:BasicCacheIf the return value of this operation will be ignored by the application, the user is strongly encouraged to use theorg.infinispan.context.Flag#IGNORE_RETURN_VALUESflag when invoking this method in order to make it behave as efficiently as possible (i.e. avoiding needless remote or network calls). -
putAll
Description copied from interface:AdvancedCacheAn overloaded form ofMap.putAll(Map), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entries being stored, such as lifespan, version of value...etc.- Specified by:
putAllin interfaceAdvancedCache<K,V> - Overrides:
putAllin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
map- the values to storemetadata- information to store alongside the value(s)
-
putAll
-
clear
public void clear()Description copied from interface:CacheRemoves 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. -
keySet
Description copied from interface:CacheReturns 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 invokingSet.toArray(),Set.toArray(Object[]),Set.size(),Set.retainAll(Collection)andSet.iterator()methods as they will traverse the entire contents of the cluster including a configuredCacheLoaderand remote entries. The former 2 methods especially have a very high likelihood of causing aOutOfMemoryErrordue 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 operationsSupported 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 theFlag.SKIP_CACHE_LOADflag 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 preventOutOfMemoryError) Also if you want the local contents only you can use theFlag.CACHE_MODE_LOCALflag so that other remote nodes are not queried for data. However, the loader will still be used unless the previously mentionedFlag.SKIP_CACHE_LOADis also configured.Iterator Use
This class implements theCloseableIteratorSetinterface which creates aCloseableIteratorinstead 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 throwUnsupportedOperationExceptionif invoked.Set.add(Object)Set.addAll(java.util.Collection) -
getGroup
Description copied from interface:AdvancedCacheIt 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). Themapreturned is immutable and represents the group at the time of the invocation. If you want to add or remove keys from a group useBasicCache.put(Object, Object)andBasicCache.remove(Object). To remove all the keys in the group useAdvancedCache.removeGroup(String). To improve performance you may use theflagFlag.SKIP_CACHE_LOADto avoid fetching the key/value from persistence. However, you will get an inconsistent snapshot of the group.- Specified by:
getGroupin interfaceAdvancedCache<K,V> - Overrides:
getGroupin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
groupName- the group name.- Returns:
- an immutable
Mapwith the key/value pairs.
-
removeGroup
Description copied from interface:AdvancedCacheIt 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:
removeGroupin interfaceAdvancedCache<K,V> - Overrides:
removeGroupin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
groupName- the group name.
-
values
Description copied from interface:CacheReturns 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 invokingCollection.toArray(),Collection.toArray(Object[]),Collection.size(),Collection.retainAll(Collection)andCollection.iterator()methods as they will traverse the entire contents of the cluster including a configuredCacheLoaderand remote entries. The former 2 methods especially have a very high likelihood of causing aOutOfMemoryErrordue 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 operationsSupported 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 theFlag.SKIP_CACHE_LOADflag 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 preventOutOfMemoryError) Also if you want the local contents only you can use theFlag.CACHE_MODE_LOCALflag so that other remote nodes are not queried for data. However the loader will still be used unless the previously mentionedFlag.SKIP_CACHE_LOADis also configured.Iterator Use
This class implements the
CloseableIteratorCollectioninterface which creates aCloseableIteratorinstead 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 fromCacheStream.iterator()will not support remove.Unsupported Operations
Due to not being able to add null values the following methods are not supported and will throwUnsupportedOperationExceptionif invoked.Set.add(Object)Set.addAll(java.util.Collection) -
entrySet
Description copied from interface:CacheReturns 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 invokingSet.toArray(),Set.toArray(Object[]),Set.size(),Set.retainAll(Collection)andSet.iterator()methods as they will traverse the entire contents of the cluster including a configuredCacheLoaderand remote entries. The former 2 methods especially have a very high likelihood of causing aOutOfMemoryErrordue 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 operationsSupported 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 theFlag.SKIP_CACHE_LOADflag 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 preventOutOfMemoryError) Also if you want the local contents only you can use theFlag.CACHE_MODE_LOCALflag so that other remote nodes are not queried for data. However, the loader will still be used unless the previously mentionedFlag.SKIP_CACHE_LOADis also configured.Modifying or Adding Entries
An entry's value is supported to be modified by using theMap.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 theSet.add(Object)orSet.addAll(java.util.Collection)methods.Iterator Use
This class implements theCloseableIteratorSetinterface which creates aCloseableIteratorinstead 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. -
cacheEntrySet
Description copied from interface:AdvancedCacheIdentical toCache.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:
cacheEntrySetin interfaceAdvancedCache<K,V> - Overrides:
cacheEntrySetin classAbstractDelegatingAdvancedCache<K,V> - Returns:
- the entry set containing all of the CacheEntries
- See Also:
-
putIfAbsent
- Specified by:
putIfAbsentin interfaceConcurrentMap<K,V> - Specified by:
putIfAbsentin interfaceMap<K,V> - Overrides:
putIfAbsentin classAbstractDelegatingCache<K,V>
-
remove
-
replace
-
replace
-
compute
Description copied from interface:CacheWhen 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
Externalizeror beSerializableitself.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.
-
computeIfPresent
Description copied from interface:CacheWhen 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
Externalizeror beSerializableitself.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:
computeIfPresentin interfaceCache<K,V> - Specified by:
computeIfPresentin interfaceConcurrentMap<K,V> - Specified by:
computeIfPresentin interfaceMap<K,V> - Overrides:
computeIfPresentin classAbstractDelegatingCache<K,V>
-
computeIfAbsent
Description copied from interface:CacheWhen 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
Externalizeror beSerializableitself.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:
computeIfAbsentin interfaceCache<K,V> - Specified by:
computeIfAbsentin interfaceConcurrentMap<K,V> - Specified by:
computeIfAbsentin interfaceMap<K,V> - Overrides:
computeIfAbsentin classAbstractDelegatingCache<K,V>
-
merge
Description copied from interface:CacheWhen 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
Externalizeror beSerializableitself.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.
-
computeAsync
public CompletableFuture<V> computeAsync(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction) Description copied from interface:AsyncCacheAsynchronous version ofConcurrentMap.compute(Object, BiFunction). This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
computeAsyncin interfaceAsyncCache<K,V> - Overrides:
computeAsyncin classAbstractDelegatingAdvancedCache<K,V>
-
computeIfPresentAsync
public CompletableFuture<V> computeIfPresentAsync(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction) Description copied from interface:AsyncCacheAsynchronous version ofConcurrentMap.computeIfPresent(Object, BiFunction). This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
computeIfPresentAsyncin interfaceAsyncCache<K,V> - Overrides:
computeIfPresentAsyncin classAbstractDelegatingAdvancedCache<K,V>
-
computeIfAbsentAsync
public CompletableFuture<V> computeIfAbsentAsync(K key, Function<? super K, ? extends V> mappingFunction) Description copied from interface:AsyncCacheAsynchronous version ofConcurrentMap.computeIfAbsent(Object, Function). This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
computeIfAbsentAsyncin interfaceAsyncCache<K,V> - Overrides:
computeIfAbsentAsyncin classAbstractDelegatingAdvancedCache<K,V>
-
mergeAsync
public CompletableFuture<V> mergeAsync(K key, V value, BiFunction<? super V, ? super V, ? extends V> remappingFunction) Description copied from interface:AsyncCacheAsynchronous version ofConcurrentMap.merge(Object, Object, BiFunction). This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
mergeAsyncin interfaceAsyncCache<K,V> - Overrides:
mergeAsyncin classAbstractDelegatingAdvancedCache<K,V>
-
getFlagsBitSet
public long getFlagsBitSet() -
addListenerAsync
Description copied from interface:ListenableAsynchronous version ofListenable.addListener(Object)- Specified by:
addListenerAsyncin interfaceListenable- Overrides:
addListenerAsyncin classAbstractDelegatingCache<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:FilteringListenableAsynchronous version ofFilteringListenable.addListener(Object, CacheEventFilter, CacheEventConverter)- Specified by:
addListenerAsyncin interfaceFilteringListenable<K,V> - Overrides:
addListenerAsyncin classAbstractDelegatingCache<K,V> - Type Parameters:
C-- Parameters:
listener- listener to add, must not be nullfilter-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:FilteringListenableAsynchronous version ofFilteringListenable.addFilteredListener(Object, CacheEventFilter, CacheEventConverter, Set)- Specified by:
addFilteredListenerAsyncin interfaceFilteringListenable<K,V> - Overrides:
addFilteredListenerAsyncin classAbstractDelegatingCache<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:FilteringListenableAsynchronous version ofFilteringListenable.addStorageFormatFilteredListener(Object, CacheEventFilter, CacheEventConverter, Set)- Specified by:
addStorageFormatFilteredListenerAsyncin interfaceFilteringListenable<K,V> - Overrides:
addStorageFormatFilteredListenerAsyncin classAbstractDelegatingCache<K,V>
-
put
Description copied from interface:AdvancedCacheAn overloaded form ofBasicCache.put(Object, Object), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.- Specified by:
putin interfaceAdvancedCache<K,V> - Overrides:
putin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
key- key to usevalue- value to storemetadata- information to store alongside the value- Returns:
- the previous value associated with
key, ornullif there was no mapping forkey.
-
putAsync
Description copied from interface:AdvancedCacheAsynchronous version ofAdvancedCache.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 overAdvancedCache.put(Object, Object, Metadata)if used in LOCAL mode.- Specified by:
putAsyncin interfaceAdvancedCache<K,V> - Overrides:
putAsyncin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
key- key to usevalue- value to storemetadata- information to store alongside the new value- Returns:
- a future containing the old value replaced.
-
putAsyncEntry
Description copied from interface:AdvancedCacheExtension ofAdvancedCache.putAsync(Object, Object, Metadata)which returns aCacheEntryinstead of only the previous value.- Specified by:
putAsyncEntryin interfaceAdvancedCache<K,V> - Overrides:
putAsyncEntryin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
key- key to usevalue- value to storemetadata- information to store alongside the new value- Returns:
- a future containing the old
CacheEntryreplaced.
-
putIfAbsent
Description copied from interface:AdvancedCacheAn overloaded form ofConcurrentMap.putIfAbsent(Object, Object), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. TheMetadatais only stored if the call is successful.- Specified by:
putIfAbsentin interfaceAdvancedCache<K,V> - Overrides:
putIfAbsentin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
key- key with which the specified value is to be associatedvalue- value to be associated with the specified keymetadata- information to store alongside the new value- Returns:
- the previous value associated with the specified key, or
nullif there was no mapping for the key.
-
replace
Description copied from interface:AdvancedCacheAn overloaded form ofConcurrentMap.replace(Object, Object, Object), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. TheMetadatais only stored if the call is successful.- Specified by:
replacein interfaceAdvancedCache<K,V> - Overrides:
replacein classAbstractDelegatingAdvancedCache<K,V> - Parameters:
key- key with which the specified value is associatedoldValue- value expected to be associated with the specified keyvalue- value to be associated with the specified keymetadata- information to store alongside the new value- Returns:
trueif the value was replaced
-
replace
Description copied from interface:AdvancedCacheAn overloaded form ofConcurrentMap.replace(Object, Object), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. TheMetadatais only stored if the call is successful.- Specified by:
replacein interfaceAdvancedCache<K,V> - Overrides:
replacein classAbstractDelegatingAdvancedCache<K,V> - Parameters:
key- key with which the specified value is associatedvalue- value to be associated with the specified keymetadata- information to store alongside the new value- Returns:
- the previous value associated with the specified key, or
nullif 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:AdvancedCacheAn overloaded form ofCache.compute(Object, BiFunction), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc.- Specified by:
computein interfaceAdvancedCache<K,V> - Overrides:
computein classAbstractDelegatingAdvancedCache<K,V> - Parameters:
key- key with which the specified value is associatedremappingFunction- function to be applied to the specified key/valuemetadata- information to store alongside the new value- Returns:
- the previous value associated with the specified key, or
nullif 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:AdvancedCacheAn overloaded form ofCache.computeIfPresent(Object, BiFunction), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. TheMetadatais only stored if the call is successful.- Specified by:
computeIfPresentin interfaceAdvancedCache<K,V> - Overrides:
computeIfPresentin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
key- key with which the specified value is associatedremappingFunction- function to be applied to the specified key/valuemetadata- information to store alongside the new value- Returns:
- the previous value associated with the specified key, or
nullif 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:AdvancedCacheAn overloaded form ofCache.computeIfAbsent(Object, Function), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. TheMetadatais only stored if the call is successful.- Specified by:
computeIfAbsentin interfaceAdvancedCache<K,V> - Overrides:
computeIfAbsentin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
key- key with which the specified value is associatedmappingFunction- function to be applied to the specified keymetadata- 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:AdvancedCacheAn overloaded form ofCache.merge(Object, Object, BiFunction), which takes in an instance ofMetadatawhich can be used to provide metadata information for the entry being stored, such as lifespan, version of value...etc. TheMetadatais only stored if the call is successful.- Specified by:
mergein interfaceAdvancedCache<K,V> - Overrides:
mergein classAbstractDelegatingAdvancedCache<K,V> - Parameters:
key- , key with which the resulting value is to be associatedvalue- , 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 keyremappingFunction- , the function to recompute a value if presentmetadata- , 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
Description copied from interface:AdvancedCacheRetrieves a CacheEntry corresponding to a specific key.- Specified by:
getCacheEntryin interfaceAdvancedCache<K,V> - Overrides:
getCacheEntryin classAbstractDelegatingAdvancedCache<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
nullif this map contains no mapping for the key
-
getCacheEntryAsync
Description copied from interface:AdvancedCacheRetrieves a CacheEntry corresponding to a specific key.- Specified by:
getCacheEntryAsyncin interfaceAdvancedCache<K,V> - Overrides:
getCacheEntryAsyncin classAbstractDelegatingAdvancedCache<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
nullif this map contains no mapping for the key
-
cachePublisher
Description copied from interface:AdvancedCacheProvides aPublishertype instance that can be used to publish values from this Cache. This allows for publishing of keys or entries from the cache or even reduction of those in an efficient manner. This is very similar to aCacheStreambut non-blocking.This API is currently Experimental and may be changed or even removed later, use at your own risk.
- Specified by:
cachePublisherin interfaceAdvancedCache<K,V> - Overrides:
cachePublisherin classAbstractDelegatingAdvancedCache<K,V> - Returns:
- a publisher that uses the same transactional context (if applicable) and flags of this cache
-
readContext
-
writeContext
-