Package org.infinispan.api.async

Interface AsyncCache<K,V>

public interface AsyncCache<K,V>

Since:

14.0

Method Summary

Modifier and Type	Method	Description
default CompletionStage<Void>	clear()	Clear the cache.
CompletionStage<Void>	clear(CacheOptions options)	Clear the cache.
CompletionStage<CacheConfiguration>	configuration()	The configuration for this cache.
AsyncContainer	container()	Return the container of this cache
default Flow.Publisher<CacheEntry<K,V>>	entries()	Retrieve all entries
Flow.Publisher<CacheEntry<K,V>>	entries(CacheOptions options)	Retrieve all entries
default CompletionStage<Long>	estimateSize()	Estimate the size of the store
CompletionStage<Long>	estimateSize(CacheOptions options)	Estimate the size of the store
default CompletionStage<V>	get(K key)	Get the value of the Key if such exists
default CompletionStage<V>	get(K key, CacheOptions options)	Get the value of the Key if such exists
default Flow.Publisher<CacheEntry<K,V>>	getAll(Set<K> keys)	Retrieves the entries for the specified keys.
Flow.Publisher<CacheEntry<K,V>>	getAll(Set<K> keys, CacheOptions options)	Retrieves the entries for the specified keys.
default Flow.Publisher<CacheEntry<K,V>>	getAll(K... keys)	Retrieves the entries for the specified keys.
Flow.Publisher<CacheEntry<K,V>>	getAll(CacheOptions options, K... keys)	Retrieves the entries for the specified keys.
default CompletionStage<CacheEntry<K,V>>	getAndRemove(K key)	Removes the key and returns its value if present.
CompletionStage<CacheEntry<K,V>>	getAndRemove(K key, CacheOptions options)	Removes the key and returns its value if present.
default Flow.Publisher<CacheEntry<K,V>>	getAndRemoveAll(Flow.Publisher<K> keys)	Removes a set of keys.
Flow.Publisher<CacheEntry<K,V>>	getAndRemoveAll(Flow.Publisher<K> keys, CacheWriteOptions options)	Removes a set of keys.
default Flow.Publisher<CacheEntry<K,V>>	getAndRemoveAll(Set<K> keys)	Removes a set of keys.
Flow.Publisher<CacheEntry<K,V>>	getAndRemoveAll(Set<K> keys, CacheWriteOptions options)	Removes a set of keys.
default CompletionStage<CacheEntry<K,V>>	getEntry(K key)	Get the entry of the Key if such exists
CompletionStage<CacheEntry<K,V>>	getEntry(K key, CacheOptions options)	Get the entry of the Key if such exists
default CompletionStage<CacheEntry<K,V>>	getOrReplaceEntry(K key, V value, CacheEntryVersion version)
CompletionStage<CacheEntry<K,V>>	getOrReplaceEntry(K key, V value, CacheEntryVersion version, CacheWriteOptions options)
default Flow.Publisher<K>	keys()	Retrieve all keys
Flow.Publisher<K>	keys(CacheOptions options)	Retrieve all keys
default Flow.Publisher<CacheEntryEvent<K,V>>	listen(CacheEntryEventType... types)	Register a cache listener with default CacheListenerOptions
Flow.Publisher<CacheEntryEvent<K,V>>	listen(CacheListenerOptions options, CacheEntryEventType... types)	Register a cache listener with the supplied CacheListenerOptions
String	name()	The name of the cache.
default <T> Flow.Publisher<CacheEntryProcessorResult<K,T>>	process(Set<K> keys, AsyncCacheEntryProcessor<K,V,T> processor)	Process entries using the supplied task
<T> Flow.Publisher<CacheEntryProcessorResult<K,T>>	process(Set<K> keys, AsyncCacheEntryProcessor<K,V,T> task, CacheOptions options)	Process entries using the supplied task
default <T> Flow.Publisher<CacheEntryProcessorResult<K,T>>	processAll(AsyncCacheEntryProcessor<K,V,T> processor)	Execute a CacheProcessor on a cache
<T> Flow.Publisher<CacheEntryProcessorResult<K,T>>	processAll(AsyncCacheEntryProcessor<K,V,T> processor, CacheProcessorOptions options)	Execute a CacheProcessor on a cache
default CompletionStage<CacheEntry<K,V>>	put(K key, V value)
CompletionStage<CacheEntry<K,V>>	put(K key, V value, CacheWriteOptions options)
default CompletionStage<Void>	putAll(Flow.Publisher<CacheEntry<K,V>> entries)
CompletionStage<Void>	putAll(Flow.Publisher<CacheEntry<K,V>> entries, CacheWriteOptions options)
default CompletionStage<Void>	putAll(Map<K,V> entries)
CompletionStage<Void>	putAll(Map<K,V> entries, CacheWriteOptions options)
default CompletionStage<CacheEntry<K,V>>	putIfAbsent(K key, V value)	Insert the key/value if such key does not exist
CompletionStage<CacheEntry<K,V>>	putIfAbsent(K key, V value, CacheWriteOptions options)	Insert the key/value if such key does not exist
default <R> AsyncQuery<K,V,R>	query(String query)
<R> AsyncQuery<K,V,R>	query(String query, CacheOptions options)	Executes the query and returns an iterable with the entries
default CompletionStage<Boolean>	remove(K key)	Delete the key
default CompletionStage<Boolean>	remove(K key, CacheEntryVersion version)	Delete the key only if the version matches
CompletionStage<Boolean>	remove(K key, CacheEntryVersion version, CacheOptions options)	Delete the key only if the version matches
CompletionStage<Boolean>	remove(K key, CacheOptions options)	Delete the key
default Flow.Publisher<K>	removeAll(Flow.Publisher<K> keys)
Flow.Publisher<K>	removeAll(Flow.Publisher<K> keys, CacheWriteOptions options)
default Flow.Publisher<K>	removeAll(Set<K> keys)	Removes a set of keys.
Flow.Publisher<K>	removeAll(Set<K> keys, CacheWriteOptions options)	Removes a set of keys.
default CompletionStage<Boolean>	replace(K key, V value, CacheEntryVersion version)
default CompletionStage<Boolean>	replace(K key, V value, CacheEntryVersion version, CacheWriteOptions options)
default CompletionStage<Void>	set(K key, V value)
default CompletionStage<Void>	set(K key, V value, CacheWriteOptions options)
default CompletionStage<Boolean>	setIfAbsent(K key, V value)	Insert the key/value if such key does not exist
default CompletionStage<Boolean>	setIfAbsent(K key, V value, CacheWriteOptions options)	Insert the key/value if such key does not exist
AsyncStreamingCache<K>	streaming()

Method Details

name

String name()

The name of the cache.

Returns:

configuration

CompletionStage<CacheConfiguration> configuration()

The configuration for this cache.

Returns:

container

AsyncContainer container()

Return the container of this cache

Returns:

get

default CompletionStage<V> get(K key)

Get the value of the Key if such exists

Parameters:

key -

Returns:

the value

get

default CompletionStage<V> get(K key,
 CacheOptions options)

Get the value of the Key if such exists

Parameters:

key -

options -

Returns:

the value

getEntry

default CompletionStage<CacheEntry<K,V>> getEntry(K key)

Get the entry of the Key if such exists

Parameters:

key -

Returns:

the entry

getEntry

CompletionStage<CacheEntry<K,V>> getEntry(K key,
 CacheOptions options)

Get the entry of the Key if such exists

Parameters:

key -

options -

Returns:

the entry

putIfAbsent

default CompletionStage<CacheEntry<K,V>> putIfAbsent(K key,
 V value)

Insert the key/value if such key does not exist

Parameters:

key -

value -

Returns:

the previous value if present

putIfAbsent

CompletionStage<CacheEntry<K,V>> putIfAbsent(K key,
 V value,
 CacheWriteOptions options)

Insert the key/value if such key does not exist

Parameters:

key -

value -

options -

Returns:

the previous value if present

setIfAbsent

default CompletionStage<Boolean> setIfAbsent(K key,
 V value)

Insert the key/value if such key does not exist

Parameters:

key -

value -

Returns:

setIfAbsent

default CompletionStage<Boolean> setIfAbsent(K key,
 V value,
 CacheWriteOptions options)

Insert the key/value if such key does not exist

Parameters:

key -

value -

options -

Returns:

Void

put

default CompletionStage<CacheEntry<K,V>> put(K key,
 V value)

Parameters:

key -

value -

Returns:

Void

put

CompletionStage<CacheEntry<K,V>> put(K key,
 V value,
 CacheWriteOptions options)

Parameters:

key -

value -

options -

Returns:

Void

set

default CompletionStage<Void> set(K key,
 V value)

Parameters:

key -

value -

Returns:

set

default CompletionStage<Void> set(K key,
 V value,
 CacheWriteOptions options)

Parameters:

key -

value -

options -

Returns:

replace

default CompletionStage<Boolean> replace(K key,
 V value,
 CacheEntryVersion version)

Parameters:

key -

value -

Returns:

replace

default CompletionStage<Boolean> replace(K key,
 V value,
 CacheEntryVersion version,
 CacheWriteOptions options)

Parameters:

key -

value -

options -

Returns:

getOrReplaceEntry

default CompletionStage<CacheEntry<K,V>> getOrReplaceEntry(K key,
 V value,
 CacheEntryVersion version)

Parameters:

key -

value -

version -

Returns:

getOrReplaceEntry

CompletionStage<CacheEntry<K,V>> getOrReplaceEntry(K key,
 V value,
 CacheEntryVersion version,
 CacheWriteOptions options)

Parameters:

key -

value -

version -

options -

Returns:

remove

default CompletionStage<Boolean> remove(K key)

Delete the key

Parameters:

key -

Returns:

whether the entry was removed.

remove

CompletionStage<Boolean> remove(K key,
 CacheOptions options)

Delete the key

Parameters:

key -

options -

Returns:

whether the entry was removed.

remove

default CompletionStage<Boolean> remove(K key,
 CacheEntryVersion version)

Delete the key only if the version matches

Parameters:

key -

version -

Returns:

whether the entry was removed.

remove

CompletionStage<Boolean> remove(K key,
 CacheEntryVersion version,
 CacheOptions options)

Delete the key only if the version matches

Parameters:

key -

version -

options -

Returns:

whether the entry was removed.

getAndRemove

default CompletionStage<CacheEntry<K,V>> getAndRemove(K key)

Removes the key and returns its value if present.

Parameters:

key -

Returns:

the value of the key before removal. Returns null if the key didn't exist.

getAndRemove

CompletionStage<CacheEntry<K,V>> getAndRemove(K key,
 CacheOptions options)

Removes the key and returns its value if present.

Parameters:

key -

options -

Returns:

the value of the key before removal. Returns null if the key didn't exist.

keys

default Flow.Publisher<K> keys()

Retrieve all keys

Returns:

keys

Flow.Publisher<K> keys(CacheOptions options)

Retrieve all keys

Parameters:

options -

Returns:

entries

default Flow.Publisher<CacheEntry<K,V>> entries()

Retrieve all entries

Returns:

entries

Flow.Publisher<CacheEntry<K,V>> entries(CacheOptions options)

Retrieve all entries

Parameters:

options -

Returns:

putAll

default CompletionStage<Void> putAll(Map<K,V> entries)

Parameters:

entries -

Returns:

Void

putAll

CompletionStage<Void> putAll(Map<K,V> entries,
 CacheWriteOptions options)

Parameters:

entries -

options -

Returns:

putAll

default CompletionStage<Void> putAll(Flow.Publisher<CacheEntry<K,V>> entries)

Parameters:

entries -

Returns:

Void

putAll

CompletionStage<Void> putAll(Flow.Publisher<CacheEntry<K,V>> entries,
 CacheWriteOptions options)

Parameters:

entries -

options -

Returns:

getAll

default Flow.Publisher<CacheEntry<K,V>> getAll(Set<K> keys)

Retrieves the entries for the specified keys.

Parameters:

keys -

Returns:

getAll

Flow.Publisher<CacheEntry<K,V>> getAll(Set<K> keys,
 CacheOptions options)

Retrieves the entries for the specified keys.

Parameters:

keys -

options -

Returns:

getAll

default Flow.Publisher<CacheEntry<K,V>> getAll(K... keys)

Retrieves the entries for the specified keys.

Parameters:

keys -

Returns:

getAll

Flow.Publisher<CacheEntry<K,V>> getAll(CacheOptions options,
 K... keys)

Retrieves the entries for the specified keys.

Parameters:

options -

keys -

Returns:

removeAll

default Flow.Publisher<K> removeAll(Set<K> keys)

Removes a set of keys. Returns the keys that were removed.

Parameters:

keys -

Returns:

removeAll

Flow.Publisher<K> removeAll(Set<K> keys,
 CacheWriteOptions options)

Removes a set of keys. Returns the keys that were removed.

Parameters:

keys -

options -

Returns:

removeAll

default Flow.Publisher<K> removeAll(Flow.Publisher<K> keys)

Parameters:

keys -

Returns:

Void

removeAll

Flow.Publisher<K> removeAll(Flow.Publisher<K> keys,
 CacheWriteOptions options)

Parameters:

keys -

options -

Returns:

getAndRemoveAll

default Flow.Publisher<CacheEntry<K,V>> getAndRemoveAll(Set<K> keys)

Removes a set of keys. Returns the keys that were removed.

Parameters:

keys -

Returns:

getAndRemoveAll

Flow.Publisher<CacheEntry<K,V>> getAndRemoveAll(Set<K> keys,
 CacheWriteOptions options)

Removes a set of keys. Returns the keys that were removed.

Parameters:

keys -

options -

Returns:

getAndRemoveAll

default Flow.Publisher<CacheEntry<K,V>> getAndRemoveAll(Flow.Publisher<K> keys)

Removes a set of keys. Returns the keys that were removed.

Parameters:

keys -

Returns:

getAndRemoveAll

Flow.Publisher<CacheEntry<K,V>> getAndRemoveAll(Flow.Publisher<K> keys,
 CacheWriteOptions options)

Removes a set of keys. Returns the keys that were removed.

Parameters:

keys -

options -

Returns:

estimateSize

default CompletionStage<Long> estimateSize()

Estimate the size of the store

Returns:

Long, estimated size

estimateSize

CompletionStage<Long> estimateSize(CacheOptions options)

Estimate the size of the store

Parameters:

options -

Returns:

Long, estimated size

clear

default CompletionStage<Void> clear()

Clear the cache. If a concurrent operation puts data in the cache the clear might work properly

Returns:

Void

clear

CompletionStage<Void> clear(CacheOptions options)

Clear the cache. If a concurrent operation puts data in the cache the clear might not properly work

Parameters:

options -

Returns:

Void

query

default <R> AsyncQuery<K,V,R> query(String query)

Type Parameters:

R -

Parameters:

query - query String

Returns:

query

<R> AsyncQuery<K,V,R> query(String query,
 CacheOptions options)

Executes the query and returns an iterable with the entries

Type Parameters:

R -

Parameters:

query - query String

options -

Returns:

listen

default Flow.Publisher<CacheEntryEvent<K,V>> listen(CacheEntryEventType... types)

Register a cache listener with default CacheListenerOptions

Parameters:

types -

Returns:

listen

Flow.Publisher<CacheEntryEvent<K,V>> listen(CacheListenerOptions options,
 CacheEntryEventType... types)

Register a cache listener with the supplied CacheListenerOptions

Parameters:

options -

types - one or more CacheEntryEventType

Returns:

process

default <T>
Flow.Publisher<CacheEntryProcessorResult<K,T>> process(Set<K> keys,
 AsyncCacheEntryProcessor<K,V,T> processor)

Process entries using the supplied task

Parameters:

keys -

processor -

Returns:

process

<T> Flow.Publisher<CacheEntryProcessorResult<K,T>> process(Set<K> keys,
 AsyncCacheEntryProcessor<K,V,T> task,
 CacheOptions options)

Process entries using the supplied task

Parameters:

keys -

task -

options -

Returns:

processAll

default <T>
Flow.Publisher<CacheEntryProcessorResult<K,T>> processAll(AsyncCacheEntryProcessor<K,V,T> processor)

Execute a CacheProcessor on a cache

Type Parameters:

T -

Parameters:

processor -

Returns:

processAll

<T> Flow.Publisher<CacheEntryProcessorResult<K,T>> processAll(AsyncCacheEntryProcessor<K,V,T> processor,
 CacheProcessorOptions options)

Execute a CacheProcessor on a cache

Type Parameters:

T -

Parameters:

processor -

options -

Returns:

streaming

AsyncStreamingCache<K> streaming()

Returns: