Class EncoderCache<K,V>
- All Implemented Interfaces:
ConcurrentMap<K,,V> Map<K,,V> AdvancedCache<K,,V> Cache<K,,V> AsyncCache<K,,V> BasicCache<K,,V> BatchingCache,Lifecycle,TransactionalCache,FilteringListenable<K,,V> Listenable
Encoder and Wrapper to convert between storage value and
read/write value.- Since:
- 9.1
-
Nested Class Summary
-
Field Summary
Fields inherited from class org.infinispan.cache.impl.AbstractDelegatingAdvancedCache
cache -
Constructor Summary
ConstructorsConstructorDescriptionEncoderCache(AdvancedCache<K, V> cache, InternalEntryFactory entryFactory, BasicComponentRegistry componentRegistry, DataConversion keyDataConversion, DataConversion valueDataConversion) -
Method Summary
Modifier and TypeMethodDescription<C> voidaddFilteredListener(Object listener, CacheEventFilter<? super K, ? super V> filter, CacheEventConverter<? super K, ? super V, C> converter, Set<Class<? extends Annotation>> filterAnnotations) Registers a listener limiting the cache-entry specific events only to annotations that are passed in as parameter.<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)voidaddListener(Object listener) Adds a listener to the component.<C> voidaddListener(Object listener, CacheEventFilter<? super K, ? super V> filter, CacheEventConverter<? super K, ? super V, C> converter) Registers a listener that will be notified on events that pass the filter condition.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> voidaddStorageFormatFilteredListener(Object listener, CacheEventFilter<? super K, ? super V> filter, CacheEventConverter<? super K, ? super V, C> converter, Set<Class<? extends Annotation>> filterAnnotations) Same asFilteringListenable.addFilteredListener(Object, CacheEventFilter, CacheEventConverter, Set), but assumes the filter and/or the converter will be done in the same data format as it's stored in the cache.<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.compute(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit) An overloaded form ofConcurrentMap.compute(Object, BiFunction)which takes in lifespan parameters.compute(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit) An overloaded form ofConcurrentMap.compute(Object, BiFunction)which takes in lifespan and maxIdleTime parameters.An overloaded form of#compute(K, 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.compute(K key, SerializableBiFunction<? super K, ? super V, ? extends V> remappingFunction, Metadata metadata) computeAsync(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction) Asynchronous version ofConcurrentMap.compute(Object, BiFunction).computeAsync(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit) Asynchronous version ofBasicCache.compute(Object, BiFunction, long, TimeUnit).computeAsync(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit) Asynchronous version ofBasicCache.compute(Object, BiFunction, long, TimeUnit, long, TimeUnit).computeAsync(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, Metadata metadata) Overloaded#computeAsync(K, BiFunction), which stores metadata alongside the value.computeAsync(K key, SerializableBiFunction<? super K, ? super V, ? extends V> remappingFunction, Metadata metadata) computeIfAbsent(K key, Function<? super K, ? extends V> mappingFunction) computeIfAbsent(K key, Function<? super K, ? extends V> mappingFunction, long lifespan, TimeUnit lifespanUnit) An overloaded form ofConcurrentMap.computeIfAbsent(Object, Function)which takes in lifespan parameters.computeIfAbsent(K key, Function<? super K, ? extends V> mappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit) An overloaded form ofConcurrentMap.computeIfAbsent(Object, Function)which takes in lifespan and maxIdleTime parameters.An overloaded form of#computeIfAbsent(K, 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.computeIfAbsent(K key, SerializableFunction<? super K, ? extends V> mappingFunction, Metadata metadata) computeIfAbsentAsync(K key, Function<? super K, ? extends V> mappingFunction) Asynchronous version ofConcurrentMap.computeIfAbsent(Object, Function).computeIfAbsentAsync(K key, Function<? super K, ? extends V> mappingFunction, long lifespan, TimeUnit lifespanUnit) Asynchronous version ofBasicCache.computeIfAbsent(Object, Function, long, TimeUnit).computeIfAbsentAsync(K key, Function<? super K, ? extends V> mappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit) Asynchronous version ofBasicCache.computeIfAbsent(Object, Function, long, TimeUnit, long, TimeUnit).Overloaded#computeIfAbsentAsync(K, 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, SerializableFunction<? super K, ? extends V> mappingFunction, Metadata metadata) computeIfPresent(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction) computeIfPresent(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit) An overloaded form ofConcurrentMap.computeIfPresent(Object, BiFunction)which takes in lifespan parameters.computeIfPresent(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit) An overloaded form ofConcurrentMap.computeIfPresent(Object, BiFunction)which takes in lifespan and maxIdleTime parameters.computeIfPresent(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, Metadata metadata) An overloaded form of#computeIfPresent(K, 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.computeIfPresent(K key, SerializableBiFunction<? super K, ? super V, ? extends V> remappingFunction, Metadata metadata) computeIfPresentAsync(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction) Asynchronous version ofConcurrentMap.computeIfPresent(Object, BiFunction).computeIfPresentAsync(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit) Asynchronous version ofBasicCache.computeIfPresent(Object, BiFunction, long, TimeUnit).computeIfPresentAsync(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdle, TimeUnit maxIdleUnit) Asynchronous version ofBasicCache.computeIfPresent(Object, BiFunction, long, TimeUnit, long, TimeUnit).computeIfPresentAsync(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, Metadata metadata) Overloaded#computeIfPresentAsync(K, 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, SerializableBiFunction<? super K, ? super V, ? extends V> remappingFunction, Metadata metadata) booleancontainsKey(Object key) containsKeyAsync(K key) Asynchronous version ofMap.containsKey(Object)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.voidforEach(BiConsumer<? super K, ? super V> action) 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.getAndPutAll(Map<? extends K, ? extends V> map) Executes an equivalent ofMap.putAll(Map), returning previous values of the modified entries.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.It fetches all the keys which belong to the group.getOrDefault(Object key, V defaultValue) keyFromStorage(Object key) keySet()Returns a set view of the keys contained in this cache and cache loader across the entire cluster.keyToStorage(Object key) 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.merge(K key, V value, BiFunction<? super V, ? super V, ? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit) An overloaded form ofConcurrentMap.merge(Object, Object, BiFunction)which takes in lifespan parameters.merge(K key, V value, BiFunction<? super V, ? super V, ? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit) An overloaded form ofConcurrentMap.merge(Object, Object, BiFunction)which takes in lifespan parameters.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.merge(K key, V value, SerializableBiFunction<? super V, ? super V, ? extends V> remappingFunction, Metadata metadata) mergeAsync(K key, V value, BiFunction<? super V, ? super V, ? extends V> remappingFunction) Asynchronous version ofConcurrentMap.merge(Object, Object, BiFunction).mergeAsync(K key, V value, BiFunction<? super V, ? super V, ? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit) Asynchronous version ofBasicCache.merge(Object, Object, BiFunction, long, TimeUnit).mergeAsync(K key, V value, BiFunction<? super V, ? super V, ? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit, long maxIdleTime, TimeUnit maxIdleTimeUnit) Asynchronous version ofBasicCache.merge(Object, Object, BiFunction, long, TimeUnit, long, TimeUnit).mergeAsync(K key, V value, BiFunction<? super V, ? super V, ? extends V> remappingFunction, Metadata metadata) OverloadedAsyncCache.mergeAsync(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, SerializableBiFunction<? super V, ? super V, ? extends V> remappingFunction, Metadata metadata) If the return value of this operation will be ignored by the application, the user is strongly encouraged to use theFlag.IGNORE_RETURN_VALUESflag when invoking this method in order to make it behave as efficiently as possible (i.e.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 of#put(K, V), 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> map, 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(K, V, Metadata)which returns aCacheEntryinstead of only the previous value.putAsyncReturnEntry(K key, V value, Metadata metadata) 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 of#putForExternalRead(K, V), 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 of#putIfAbsent(K, V), 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 of#putIfAbsentAsync(K, V), 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(K, V, Metadata), which returns aCacheEntryinstead of only the value.putIfAbsentAsyncReturnEntry(K key, V value, Metadata metadata) If the return value of this operation will be ignored by the application, the user is strongly encouraged to use theFlag.IGNORE_RETURN_VALUESflag when invoking this method in order to make it behave as efficiently as possible (i.e.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.removeAsyncReturnEntry(K key) 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 of#replace(K, V), 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 of#replace(K, V, V), 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.voidreplaceAll(BiFunction<? super K, ? super V, ? extends V> function) 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 of#replaceAsync(K, V), 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(K, V, Metadata), which returns aCacheEntryinstead of only the value.replaceAsyncReturnEntry(K key, V value, Metadata metadata) rewrap(AdvancedCache newDelegate) No generics because some methods returnAdvancedCache<?, ?>, and returning the proper type would require erasure anyway.Touches the given key if present.The same asAdvancedCache.touch(Object, boolean)except that the segment is already known.valueFromStorage(Object value) values()Returns a collection view of the values contained in this cache across the entire cluster.valueToStorage(Object value) voidwithEncoding(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.withKeyEncoding(Class<? extends Encoder> encoderClass) withMediaType(String keyMediaType, String valueMediaType) Perform any cache operations using an alternateMediaType.withMediaType(MediaType kType, MediaType vType) Perform any cache operations using the sameMediaTypeof the cache storage.withWrapping(Class<? extends Wrapper> wrapper) Performs any cache operations using the specifiedWrapper.withWrapping(Class<? extends Wrapper> keyWrapperClass, Class<? extends Wrapper> valueWrapperClass) Performs any cache operations using the specified pair ofWrapper.Methods inherited from class org.infinispan.cache.impl.AbstractDelegatingAdvancedCache
getAdvancedCache, getAsyncInterceptorChain, getAuthorizationManager, getAvailability, getBatchContainer, getCacheAvailability, getClassLoader, getComponentRegistry, getDataContainer, getDistributionManager, getEvictionManager, getExpirationManager, getLockManager, getRpcManager, getStats, getTransactionManager, getXAResource, isRebalancingEnabled, lockAs, lockedStream, noFlags, removeGroup, setAvailability, setCacheAvailability, setRebalancingEnabled, transform, with, withFlags, withFlags, withFlags, withSubjectMethods inherited from class org.infinispan.cache.impl.AbstractDelegatingCache
clear, clearAsync, endBatch, getCacheConfiguration, getCacheManager, getCacheName, getCacheStatus, getConfigurationAsProperties, getDelegate, getListeners, getName, getStatus, getVersion, isEmpty, removeListener, removeListenerAsync, shutdown, size, sizeAsync, start, startBatch, stop, toString, unwrapCacheMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.infinispan.commons.api.AsyncCache
clearAsync, sizeAsyncMethods inherited from interface org.infinispan.commons.api.BasicCache
getName, getVersionMethods inherited from interface org.infinispan.commons.api.BatchingCache
endBatch, startBatchMethods inherited from interface org.infinispan.Cache
clear, compute, compute, compute, computeAsync, computeAsync, computeAsync, computeIfAbsent, computeIfAbsent, computeIfAbsent, computeIfAbsentAsync, computeIfAbsentAsync, computeIfAbsentAsync, computeIfPresent, computeIfPresentAsync, getCacheConfiguration, getCacheManager, getStatus, merge, merge, merge, mergeAsync, mergeAsync, mergeAsync, shutdown, size, stopMethods inherited from interface org.infinispan.notifications.Listenable
getListeners, removeListener, removeListenerAsync
-
Constructor Details
-
EncoderCache
public EncoderCache(AdvancedCache<K, V> cache, InternalEntryFactory entryFactory, BasicComponentRegistry componentRegistry, DataConversion keyDataConversion, DataConversion valueDataConversion)
-
-
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>
-
keyToStorage
-
valueToStorage
-
keyFromStorage
-
valueFromStorage
-
wireRealCache
public void wireRealCache() -
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: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.
-
getKeyDataConversion
- Specified by:
getKeyDataConversionin interfaceAdvancedCache<K,V> - Overrides:
getKeyDataConversionin classAbstractDelegatingAdvancedCache<K,V> - Returns:
- The associated
DataConversionfor the keys.
-
getValueDataConversion
- Specified by:
getValueDataConversionin interfaceAdvancedCache<K,V> - Overrides:
getValueDataConversionin classAbstractDelegatingAdvancedCache<K,V> - Returns:
- The associated
DataConversionfor the cache's values.
-
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
-
replaceAll
- Specified by:
replaceAllin interfaceConcurrentMap<K,V> - Specified by:
replaceAllin interfaceMap<K,V> - Overrides:
replaceAllin classAbstractDelegatingCache<K,V>
-
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>
-
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
-
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.
-
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 of#putIfAbsentAsync(K, V), 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 null if there was no mapping for the key.
-
putIfAbsentAsyncEntry
Description copied from interface:AdvancedCacheAn extension form ofAdvancedCache.putIfAbsentAsync(K, V, 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, or null if 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
-
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
-
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
Description copied from interface:AdvancedCacheAn overloaded form of#replaceAsync(K, V), 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 null if there was no mapping for the key.
-
replaceAsyncEntry
Description copied from interface:AdvancedCacheAn extension ofAdvancedCache.replaceAsync(K, V, 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, or null if there was no mapping for the key. - See Also:
-
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
CacheLoaderis 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.
-
getAllAsync
Description copied from interface:AsyncCacheTODO This should be in AdvancedCache with getAll- Specified by:
getAllAsyncin interfaceAsyncCache<K,V> - Overrides:
getAllAsyncin classAbstractDelegatingAdvancedCache<K,V>
-
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
-
putAsyncReturnEntry
-
replaceAsyncReturnEntry
-
putIfAbsentAsyncReturnEntry
public CompletionStage<CacheEntry<K,V>> putIfAbsentAsyncReturnEntry(K key, V value, Metadata metadata) -
removeAsyncReturnEntry
-
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
-
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
CacheLoaderis 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.
-
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.
-
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
-
put
Description copied from interface:AdvancedCacheAn overloaded form of#put(K, V), 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, or null if there was no mapping for key.
-
replace
Description copied from interface:AdvancedCacheAn overloaded form of#replace(K, V), 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 null if there was no mapping for the key.
-
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
-
replace
Description copied from interface:AdvancedCacheAn overloaded form of#replace(K, V, V), 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:
- true if the value was replaced
-
replaceAsync
- Specified by:
replaceAsyncin interfaceAdvancedCache<K,V> - Overrides:
replaceAsyncin classAbstractDelegatingAdvancedCache<K,V>
-
putIfAbsent
Description copied from interface:AdvancedCacheAn overloaded form of#putIfAbsent(K, V), 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 null if there was no mapping for the key.
-
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(K, V, 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.
-
putForExternalRead
Description copied from interface:AdvancedCacheAn overloaded form of#putForExternalRead(K, V), 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
-
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)
-
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:
-
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
-
putIfAbsent
- Specified by:
putIfAbsentin interfaceConcurrentMap<K,V> - Specified by:
putIfAbsentin interfaceMap<K,V> - Overrides:
putIfAbsentin classAbstractDelegatingCache<K,V>
-
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.
-
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.
-
withKeyEncoding
- Specified by:
withKeyEncodingin interfaceAdvancedCache<K,V> - Overrides:
withKeyEncodingin classAbstractDelegatingAdvancedCache<K,V>
-
withWrapping
public AdvancedCache<K,V> withWrapping(Class<? extends Wrapper> keyWrapperClass, Class<? extends Wrapper> valueWrapperClass) 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.
-
withWrapping
Description copied from interface:AdvancedCachePerforms any cache operations using the specifiedWrapper.- Specified by:
withWrappingin interfaceAdvancedCache<K,V> - Overrides:
withWrappingin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
wrapper-Wrapperfor the keys and values.- Returns:
- an instance of
AdvancedCachewhere all operations will use the supplied wrapper.
-
withMediaType
Description copied from interface:AdvancedCachePerform any cache operations using an alternateMediaType.- Specified by:
withMediaTypein interfaceAdvancedCache<K,V> - Overrides:
withMediaTypein classAbstractDelegatingAdvancedCache<K,V> - Parameters:
keyMediaType-MediaTypefor the keys.valueMediaType-org.infinispan.commons.dataconversionfor the values.- Returns:
- an instance of
AdvancedCachewhere all data will formatted according to the suppliedMediaType.
-
withMediaType
- Specified by:
withMediaTypein interfaceAdvancedCache<K,V> - Overrides:
withMediaTypein classAbstractDelegatingAdvancedCache<K,V> - See Also:
-
withStorageMediaType
Description copied from interface:AdvancedCachePerform any cache operations using the sameMediaTypeof the cache storage. This is equivalent to disabling transcoding on the cache.- Specified by:
withStorageMediaTypein interfaceAdvancedCache<K,V> - Overrides:
withStorageMediaTypein classAbstractDelegatingAdvancedCache<K,V> - Returns:
- an instance of
AdvancedCachewhere no data conversion will take place.
-
remove
-
replace
-
replace
-
containsKey
- Specified by:
containsKeyin interfaceMap<K,V> - Overrides:
containsKeyin classAbstractDelegatingCache<K,V>
-
containsKeyAsync
Description copied from interface:AsyncCacheAsynchronous version ofMap.containsKey(Object)- Parameters:
key- key to retrieve- Returns:
- future containing true if the mapping exists.
-
containsValue
- Specified by:
containsValuein interfaceMap<K,V> - Overrides:
containsValuein classAbstractDelegatingCache<K,V>
-
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.
-
compute
public V compute(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, Metadata metadata) Description copied from interface:AdvancedCacheAn overloaded form of#compute(K, 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 null if remapping function is gives null.
-
compute
public V compute(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit) Description copied from interface:BasicCacheAn overloaded form ofConcurrentMap.compute(Object, BiFunction)which takes in lifespan parameters.- Specified by:
computein interfaceBasicCache<K,V> - Overrides:
computein classAbstractDelegatingCache<K,V> - Parameters:
key- key to useremappingFunction- function to use to compute and store the value under keylifespan- 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:BasicCacheAn overloaded form ofConcurrentMap.compute(Object, BiFunction)which takes in lifespan and maxIdleTime parameters.- Specified by:
computein interfaceBasicCache<K,V> - Overrides:
computein classAbstractDelegatingCache<K,V> - Parameters:
key- key to useremappingFunction- function to use to compute and store the value under keylifespan- 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 computed value that was stored under key
-
compute
public V compute(K key, SerializableBiFunction<? super K, ? super V, ? extends V> remappingFunction, Metadata metadata) Description copied from interface:AdvancedCache -
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>
-
computeIfPresent
public V computeIfPresent(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, Metadata metadata) Description copied from interface:AdvancedCacheAn overloaded form of#computeIfPresent(K, 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 null if there was no mapping for the key.
-
computeIfPresent
public V computeIfPresent(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit) Description copied from interface:BasicCacheAn overloaded form ofConcurrentMap.computeIfPresent(Object, BiFunction)which takes in lifespan parameters.- Specified by:
computeIfPresentin interfaceBasicCache<K,V> - Overrides:
computeIfPresentin classAbstractDelegatingCache<K,V> - Parameters:
key- key to useremappingFunction- function to use to compute and store the value under key, if such existslifespan- 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:BasicCacheAn overloaded form ofConcurrentMap.computeIfPresent(Object, BiFunction)which takes in lifespan and maxIdleTime parameters.- Specified by:
computeIfPresentin interfaceBasicCache<K,V> - Overrides:
computeIfPresentin classAbstractDelegatingCache<K,V> - Parameters:
key- key to useremappingFunction- function to use to compute and store the value under key, if such existslifespan- 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 computed value that was stored under key
-
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>
-
computeIfAbsent
Description copied from interface:AdvancedCacheAn overloaded form of#computeIfAbsent(K, 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.
-
computeIfAbsent
public V computeIfAbsent(K key, Function<? super K, ? extends V> mappingFunction, long lifespan, TimeUnit lifespanUnit) Description copied from interface:BasicCacheAn overloaded form ofConcurrentMap.computeIfAbsent(Object, Function)which takes in lifespan parameters.- Specified by:
computeIfAbsentin interfaceBasicCache<K,V> - Overrides:
computeIfAbsentin classAbstractDelegatingCache<K,V> - Parameters:
key- key to usemappingFunction- function to use to compute and store the value under key, if the key is absentlifespan- 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:BasicCacheAn overloaded form ofConcurrentMap.computeIfAbsent(Object, Function)which takes in lifespan and maxIdleTime parameters.- Specified by:
computeIfAbsentin interfaceBasicCache<K,V> - Overrides:
computeIfAbsentin classAbstractDelegatingCache<K,V> - Parameters:
key- key to usemappingFunction- function to use to compute and store the value under key, if the key is absentlifespan- 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 computed value that was stored under key
-
computeIfAbsent
public V computeIfAbsent(K key, SerializableFunction<? super K, ? extends V> mappingFunction, Metadata metadata) Description copied from interface:AdvancedCache -
merge
public V merge(K key, V value, SerializableBiFunction<? super V, ? super V, ? extends V> remappingFunction, Metadata metadata) Description copied from interface:AdvancedCache -
computeAsync
public CompletableFuture<V> computeAsync(K key, SerializableBiFunction<? super K, ? super V, ? extends V> remappingFunction, Metadata metadata) Description copied from interface:AdvancedCache -
computeIfAbsentAsync
public CompletableFuture<V> computeIfAbsentAsync(K key, SerializableFunction<? super K, ? extends V> mappingFunction, Metadata metadata) Description copied from interface:AdvancedCache -
get
-
getOrDefault
- Specified by:
getOrDefaultin interfaceConcurrentMap<K,V> - Specified by:
getOrDefaultin interfaceMap<K,V> - Overrides:
getOrDefaultin classAbstractDelegatingCache<K,V>
-
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 theFlag.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 theFlag.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
-
getAndPutAll
Description copied from interface:AdvancedCacheExecutes an equivalent ofMap.putAll(Map), returning previous values of the modified entries.- Specified by:
getAndPutAllin interfaceAdvancedCache<K,V> - Overrides:
getAndPutAllin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
map- mappings to be stored in this map- Returns:
- A map of previous values for the given keys. If the previous mapping does not exist it will not be in the returned map.
-
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.
-
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
-
merge
public V merge(K key, V value, BiFunction<? super V, ? super V, ? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit) Description copied from interface:BasicCacheAn overloaded form ofConcurrentMap.merge(Object, Object, BiFunction)which takes in lifespan parameters.- Specified by:
mergein interfaceBasicCache<K,V> - Overrides:
mergein classAbstractDelegatingCache<K,V> - Parameters:
key- key to usevalue- new value to merge with existing valueremappingFunction- function to use to merge new and existing values into a merged value to store under keylifespan- 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
-
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:BasicCacheAn overloaded form ofConcurrentMap.merge(Object, Object, BiFunction)which takes in lifespan parameters.- Specified by:
mergein interfaceBasicCache<K,V> - Overrides:
mergein classAbstractDelegatingCache<K,V> - Parameters:
key- key to usevalue- new value to merge with existing valueremappingFunction- function to use to merge new and existing values into a merged value to store under keylifespan- 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 merged value that was stored under key
-
computeIfPresent
public V computeIfPresent(K key, SerializableBiFunction<? super K, ? super V, ? extends V> remappingFunction, Metadata metadata) Description copied from interface:AdvancedCache -
computeIfPresentAsync
public CompletableFuture<V> computeIfPresentAsync(K key, SerializableBiFunction<? super K, ? super V, ? extends V> remappingFunction, Metadata metadata) Description copied from interface:AdvancedCache -
computeIfPresentAsync
public CompletableFuture<V> computeIfPresentAsync(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, Metadata metadata) Description copied from interface:AdvancedCacheOverloaded#computeIfPresentAsync(K, 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:
computeIfPresentAsyncin interfaceAdvancedCache<K,V> - Overrides:
computeIfPresentAsyncin 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 null if there was no mapping for the key.
-
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>
-
computeIfPresentAsync
public CompletableFuture<V> computeIfPresentAsync(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit) Description copied from interface:AsyncCacheAsynchronous version ofBasicCache.computeIfPresent(Object, BiFunction, long, TimeUnit). 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>
-
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:AsyncCacheAsynchronous version ofBasicCache.computeIfPresent(Object, BiFunction, long, TimeUnit, long, TimeUnit). 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>
-
mergeAsync
public CompletableFuture<V> mergeAsync(K key, V value, SerializableBiFunction<? super V, ? super V, ? extends V> remappingFunction, Metadata metadata) Description copied from interface:AdvancedCache -
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:AsyncCacheAsynchronous version ofBasicCache.merge(Object, Object, BiFunction, long, TimeUnit). 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>
-
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:AsyncCacheAsynchronous version ofBasicCache.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:
mergeAsyncin interfaceAsyncCache<K,V> - Overrides:
mergeAsyncin classAbstractDelegatingAdvancedCache<K,V>
-
mergeAsync
public CompletableFuture<V> mergeAsync(K key, V value, BiFunction<? super V, ? super V, ? extends V> remappingFunction, Metadata metadata) Description copied from interface:AdvancedCacheOverloadedAsyncCache.mergeAsync(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:
mergeAsyncin interfaceAdvancedCache<K,V> - Overrides:
mergeAsyncin 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
-
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>
-
computeAsync
public CompletableFuture<V> computeAsync(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, Metadata metadata) Description copied from interface:AdvancedCacheOverloaded#computeAsync(K, BiFunction), which stores metadata alongside the value. This method does not block on remote calls, even if your cache mode is synchronous.- Specified by:
computeAsyncin interfaceAdvancedCache<K,V> - Overrides:
computeAsyncin 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 null if remapping function is gives null.
-
computeIfAbsentAsync
public CompletableFuture<V> computeIfAbsentAsync(K key, Function<? super K, ? extends V> mappingFunction, Metadata metadata) Description copied from interface:AdvancedCacheOverloaded#computeIfAbsentAsync(K, 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:
computeIfAbsentAsyncin interfaceAdvancedCache<K,V> - Overrides:
computeIfAbsentAsyncin 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.
-
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>
-
computeAsync
public CompletableFuture<V> computeAsync(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction, long lifespan, TimeUnit lifespanUnit) Description copied from interface:AsyncCacheAsynchronous version ofBasicCache.compute(Object, BiFunction, long, TimeUnit). 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>
-
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:AsyncCacheAsynchronous version ofBasicCache.compute(Object, BiFunction, long, TimeUnit, long, TimeUnit). 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>
-
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>
-
computeIfAbsentAsync
public CompletableFuture<V> computeIfAbsentAsync(K key, Function<? super K, ? extends V> mappingFunction, long lifespan, TimeUnit lifespanUnit) Description copied from interface:AsyncCacheAsynchronous version ofBasicCache.computeIfAbsent(Object, Function, long, TimeUnit). 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>
-
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:AsyncCacheAsynchronous version ofBasicCache.computeIfAbsent(Object, Function, long, TimeUnit, long, TimeUnit). 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>
-
forEach
-
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 likely hood 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) -
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 likely hood 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 operations *Supported Flags
Note any flag configured for the cache will also be passed along to the backing set when it was created. If additional flags are configured on the cache they will not affect any existing backings sets. If there are performance concerns then 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. -
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 likely hood 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 operations *Supported Flags
Note any flag configured for the cache will also be passed along to the backing set when it was created. If additional flags are configured on the cache they will not affect any existing backings sets. If there are performance concerns then 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) -
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)
-
addListener
Description copied from interface:ListenableAdds a listener to the component. Typically, listeners would need to be annotated withListenerand further to that, contain methods annotated appropriately, otherwise the listener will not be registered. See theListenerannotation for more information.- Specified by:
addListenerin interfaceListenable- Overrides:
addListenerin classAbstractDelegatingCache<K,V> - Parameters:
listener- listener to add, must not be null
-
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
-
addListener
public <C> void addListener(Object listener, CacheEventFilter<? super K, ? super V> filter, CacheEventConverter<? super K, ? super V, C> converter) Description copied from interface:FilteringListenableRegisters a listener that will be notified on events that pass the filter condition. The value presented in the notifications will be first converted using the provided converter if there is one.Some implementations may provide optimizations when a
CacheEventFilterConverteris provided as both arguments to the filter and converter arguments. Note the provided object must have reference equality ie. (==) to be recognized. This allows for the filter and conversion step to take place in the same method call reducing possible overhead.- Specified by:
addListenerin interfaceFilteringListenable<K,V> - Overrides:
addListenerin classAbstractDelegatingCache<K,V> - Type Parameters:
C- The type of the resultant value after being converted- Parameters:
listener- The listener to callback upon event notifications. Must not be null.filter- The filter to see if the notification should be sent to the listener. Can be null.converter- The converter to apply to the entry before being sent to the listener. Can be null.
-
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> - Parameters:
listener- listener to add, must not be null- Returns:
- CompletionStage that when complete the listener is fully installed
-
addFilteredListener
public <C> void addFilteredListener(Object listener, CacheEventFilter<? super K, ? super V> filter, CacheEventConverter<? super K, ? super V, C> converter, Set<Class<? extends Annotation>> filterAnnotations) Description copied from interface:FilteringListenableRegisters a listener limiting the cache-entry specific events only to annotations that are passed in as parameter. For example, if the listener passed in contains callbacks forCacheEntryCreatedandCacheEntryModified, and filtered annotations contains onlyCacheEntryCreated, then the listener will be registered only forCacheEntryCreatedcallbacks. Callback filtering only applies toCacheEntryCreated,CacheEntryModified,CacheEntryRemovedandCacheEntryExpiredannotations. If the listener contains other annotations, these are preserved. This methods enables dynamic registration of listener interests at runtime without the need to create several different listener classes.- Specified by:
addFilteredListenerin interfaceFilteringListenable<K,V> - Overrides:
addFilteredListenerin classAbstractDelegatingCache<K,V> - Type Parameters:
C- The type of the resultant value after being converted- Parameters:
listener- The listener to callback upon event notifications. Must not be null.filter- The filter to see if the notification should be sent to the listener. Can be null.converter- The converter to apply to the entry before being sent to the listener. Can be null.filterAnnotations- cache-entry annotations to allow listener to be registered on. Must not be null.
-
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>
-
addStorageFormatFilteredListener
public <C> void addStorageFormatFilteredListener(Object listener, CacheEventFilter<? super K, ? super V> filter, CacheEventConverter<? super K, ? super V, C> converter, Set<Class<? extends Annotation>> filterAnnotations) Description copied from interface:FilteringListenableSame asFilteringListenable.addFilteredListener(Object, CacheEventFilter, CacheEventConverter, Set), but assumes the filter and/or the converter will be done in the same data format as it's stored in the cache.- Specified by:
addStorageFormatFilteredListenerin interfaceFilteringListenable<K,V> - Overrides:
addStorageFormatFilteredListenerin 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>
-
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:
-
touch
Description copied from interface:AdvancedCacheTouches the given key if present. This will refresh its last access time, used for max idle, and count as a recent access for eviction purposes.Note that it is possible to touch an entry that is expired via max idle if
touchEvenIfExpiredargument istrue.This method will return without blocking and complete the returned stage with a value after all appropriate nodes have actually touched the value.
- Specified by:
touchin interfaceAdvancedCache<K,V> - Overrides:
touchin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
key- key of the entry to touchtouchEvenIfExpired- true if the entry should be touched even if already expired via max idle, effectively making it so the entry is no longer expired via max idle- Returns:
- true if the entry was actually touched
-
touch
Description copied from interface:AdvancedCacheThe same asAdvancedCache.touch(Object, boolean)except that the segment is already known. This can be helpful to reduce an extra segment computation- Specified by:
touchin interfaceAdvancedCache<K,V> - Overrides:
touchin classAbstractDelegatingAdvancedCache<K,V> - Parameters:
key- key of the entry to touchsegment- segment of the keytouchEvenIfExpired- true if the entry should be touched even if already expired via max idle, effectively making it so the entry is no longer expired via max idle- Returns:
- true if the entry was actually touched
-