com.hazelcast.cache

Interface ICache<K,V>

Type Parameters:

K - the type of key.

V - the type of value.

All Superinterfaces:

AutoCloseable, javax.cache.Cache<K,V>, Closeable, Iterable<javax.cache.Cache.Entry<K,V>>

All Known Implementing Classes:

CacheProxy, ClientCacheProxy

public interface ICache<K,V>
extends javax.cache.Cache<K,V>

Hazelcast Cache extension

Hazelcast provides extension methods to Cache.

There are three set of extensions:

• asynchronous version of all cache operations.
• cache operations with custom ExpiryPolicy parameter to apply on that specific operation.
• uncategorized like size().

A method ending with Async is the asynchronous version of that method (for example #getAsync(K), #replaceAsync(K,V) ).
These methods return a Future where you can get the result or wait for the operation to be completed.

         ICache<String , SessionData> icache =  cache.unwrap( ICache.class );
         Future<SessionData> future = icache.getAsync("key-1" ) ;
         SessionData sessionData = future.get();
         
     

This interface can be accessed through Cache.unwrap(Class).

Since:

3.3.1

See Also:

Cache

Nested Class Summary

Nested classes/interfaces inherited from interface javax.cache.Cache

javax.cache.Cache.Entry<K,V>

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Closes the cache, clears the internal content and releases any resource.
V	get(K key, javax.cache.expiry.ExpiryPolicy expiryPolicy) Gets a key with custom expiry policy.
Map<K,V>	getAll(Set<? extends K> keys, javax.cache.expiry.ExpiryPolicy expiryPolicy) getAll operation with custom expiry policy.
V	getAndPut(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy) getAndPut operation with custom expiry policy.
ICompletableFuture<V>	getAndPutAsync(K key, V value) Asynchronously associates the specified value with the specified key in this cache, returning an existing value if one existed.
ICompletableFuture<V>	getAndPutAsync(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy) Asynchronously associates the specified value with the specified key in this cache, returning an existing value if one existed using a custom expiry policy.
ICompletableFuture<V>	getAndRemoveAsync(K key) Asynchronously removes the entry for a key returning the removed value if one existed.
V	getAndReplace(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy) getAndReplace operation with custom expiry policy.
ICompletableFuture<V>	getAndReplaceAsync(K key, V value) Asynchronously replaces the entry for a key only if it is currently mapped to some value.
ICompletableFuture<V>	getAndReplaceAsync(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy) Asynchronously replaces the entry for a key only if it is currently mapped to some value using custom expiry policy.
ICompletableFuture<V>	getAsync(K key) Asynchronously gets an entry from cache.
ICompletableFuture<V>	getAsync(K key, javax.cache.expiry.ExpiryPolicy expiryPolicy) Asynchronously gets an entry from cache with a provided expiry policy.
CacheStatistics	getLocalCacheStatistics() Directly access to local Cache Statistics.
void	put(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy) put operation with custom expiry policy.
void	putAll(Map<? extends K,? extends V> map, javax.cache.expiry.ExpiryPolicy expiryPolicy) putAll operation with custom expiry policy.
ICompletableFuture<Void>	putAsync(K key, V value) Asynchronously associates the specified value with the specified key in the cache.
ICompletableFuture<Void>	putAsync(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy) Asynchronously associates the specified value with the specified key in the cache using a custom expiry policy.
boolean	putIfAbsent(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy) putIfAbsent operation with custom expiry policy.
ICompletableFuture<Boolean>	putIfAbsentAsync(K key, V value) Asynchronously associates the specified value with the specified key in the cache if not already exist.
ICompletableFuture<Boolean>	putIfAbsentAsync(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy) Asynchronously associates the specified value with the specified key in the cache if not already exist, using a custom expiry policy.
ICompletableFuture<Boolean>	removeAsync(K key) Asynchronously removes the mapping for a key from this cache if it is present.
ICompletableFuture<Boolean>	removeAsync(K key, V oldValue) Asynchronously removes the mapping for a key only if it is currently mapped to the given value.
boolean	replace(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy) replace operation with custom expiry policy.
boolean	replace(K key, V oldValue, V newValue, javax.cache.expiry.ExpiryPolicy expiryPolicy) replace operation with custom expiry policy.
ICompletableFuture<Boolean>	replaceAsync(K key, V value) Asynchronously replaces the entry for a key.
ICompletableFuture<Boolean>	replaceAsync(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy) Asynchronously replaces the entry for a key only if it is currently mapped to some value.
ICompletableFuture<Boolean>	replaceAsync(K key, V oldValue, V newValue) Asynchronously replaces the entry for a key only if it is currently mapped to a given value.
ICompletableFuture<Boolean>	replaceAsync(K key, V oldValue, V newValue, javax.cache.expiry.ExpiryPolicy expiryPolicy) Asynchronously replaces the entry for a key only if it is currently mapped to a given value using custom expiry policy.
int	size() Total entry count.

Methods inherited from interface javax.cache.Cache

clear, close, containsKey, deregisterCacheEntryListener, get, getAll, getAndPut, getAndRemove, getAndReplace, getCacheManager, getConfiguration, getName, invoke, invokeAll, isClosed, iterator, loadAll, put, putAll, putIfAbsent, registerCacheEntryListener, remove, remove, removeAll, removeAll, replace, replace, unwrap

Method Detail

getAsync

ICompletableFuture<V> getAsync(K key)

Asynchronously gets an entry from cache.

Parameters:

key - the key whose associated value is to be returned.

Returns:

Future from which the value of the key can be retrieved.

See Also:

javax.cache.Cache#get(K), ICompletableFuture

getAsync

ICompletableFuture<V> getAsync(K key,
                             javax.cache.expiry.ExpiryPolicy expiryPolicy)

Asynchronously gets an entry from cache with a provided expiry policy.

Parameters:

key - the key whose associated value is to be returned.

expiryPolicy - custom expiry policy for this operation.

Returns:

Future from which the value of the key can be retrieved.

See Also:

javax.cache.Cache#get(K), ICompletableFuture

putAsync

ICompletableFuture<Void> putAsync(K key,
                                V value)

Asynchronously associates the specified value with the specified key in the cache.

Parameters:

key - the key whose associated value is to be returned.

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

Returns:

Future

See Also:

javax.cache.Cache#put(K,V), ICompletableFuture

putAsync

ICompletableFuture<Void> putAsync(K key,
                                V value,
                                javax.cache.expiry.ExpiryPolicy expiryPolicy)

Asynchronously associates the specified value with the specified key in the cache using a custom expiry policy.

Parameters:

key - the key whose associated value is to be returned.

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

expiryPolicy - custom expiry policy for this operation.

Returns:

Future

See Also:

javax.cache.Cache#put(K,V), ICompletableFuture

putIfAbsentAsync

ICompletableFuture<Boolean> putIfAbsentAsync(K key,
                                           V value)

Asynchronously associates the specified value with the specified key in the cache if not already exist.

Parameters:

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

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

Returns:

See Also:

javax.cache.Cache#putIfAbsent(K,V), ICompletableFuture

putIfAbsentAsync

ICompletableFuture<Boolean> putIfAbsentAsync(K key,
                                           V value,
                                           javax.cache.expiry.ExpiryPolicy expiryPolicy)

Asynchronously associates the specified value with the specified key in the cache if not already exist, using a custom expiry policy.

Parameters:

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

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

expiryPolicy - custom expiry policy for this operation.

Returns:

See Also:

javax.cache.Cache#putIfAbsent(K,V), ICompletableFuture

getAndPutAsync

ICompletableFuture<V> getAndPutAsync(K key,
                                   V value)

Asynchronously associates the specified value with the specified key in this cache, returning an existing value if one existed.

Parameters:

key - the key whose associated value is to be returned.

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

Returns:

Future

See Also:

javax.cache.Cache#getAndPut(K,V), ICompletableFuture

getAndPutAsync

ICompletableFuture<V> getAndPutAsync(K key,
                                   V value,
                                   javax.cache.expiry.ExpiryPolicy expiryPolicy)

Asynchronously associates the specified value with the specified key in this cache, returning an existing value if one existed using a custom expiry policy.

Parameters:

key - the key whose associated value is to be returned.

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

expiryPolicy - custom expiry policy for this operation.

Returns:

Future

See Also:

javax.cache.Cache#getAndPut(K,V), ICompletableFuture

removeAsync

ICompletableFuture<Boolean> removeAsync(K key)

Asynchronously removes the mapping for a key from this cache if it is present.

Parameters:

key - the key whose associated value is to be returned.

Returns:

Future

See Also:

javax.cache.Cache#remove(K), ICompletableFuture

removeAsync

ICompletableFuture<Boolean> removeAsync(K key,
                                      V oldValue)

Asynchronously removes the mapping for a key only if it is currently mapped to the given value.

Parameters:

key - the key whose associated value is to be returned.

oldValue - the value expected to be associated with the specified key.

Returns:

Future

See Also:

javax.cache.Cache#remove(K,V), ICompletableFuture

getAndRemoveAsync

ICompletableFuture<V> getAndRemoveAsync(K key)

Asynchronously removes the entry for a key returning the removed value if one existed.

Parameters:

key - the key whose associated value is to be returned.

Returns:

Future

See Also:

javax.cache.Cache#getAndRemove(K), ICompletableFuture

replaceAsync

ICompletableFuture<Boolean> replaceAsync(K key,
                                       V value)

Asynchronously replaces the entry for a key.

Parameters:

key - the key whose associated value is to be returned.

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

Returns:

Future

See Also:

javax.cache.Cache#replace(K,V), ICompletableFuture

replaceAsync

ICompletableFuture<Boolean> replaceAsync(K key,
                                       V value,
                                       javax.cache.expiry.ExpiryPolicy expiryPolicy)

Asynchronously replaces the entry for a key only if it is currently mapped to some value.

Parameters:

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

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

expiryPolicy - custom expiry policy for this operation.

Returns:

See Also:

javax.cache.Cache#replace(K,V), ICompletableFuture

replaceAsync

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

Asynchronously replaces the entry for a key only if it is currently mapped to a given value.

Parameters:

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

oldValue - the value expected to be associated with the specified key.

newValue - the value to be associated with the specified key.

Returns:

See Also:

javax.cache.Cache#replace(K,V,V), ICompletableFuture

replaceAsync

ICompletableFuture<Boolean> replaceAsync(K key,
                                       V oldValue,
                                       V newValue,
                                       javax.cache.expiry.ExpiryPolicy expiryPolicy)

Asynchronously replaces the entry for a key only if it is currently mapped to a given value using custom expiry policy.

Parameters:

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

oldValue - the value expected to be associated with the specified key.

newValue - the value to be associated with the specified key.

expiryPolicy - custom expiry policy for this operation.

Returns:

See Also:

javax.cache.Cache#replace(K,V,V), ICompletableFuture

getAndReplaceAsync

ICompletableFuture<V> getAndReplaceAsync(K key,
                                       V value)

Asynchronously replaces the entry for a key only if it is currently mapped to some value.

Parameters:

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

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

Returns:

See Also:

javax.cache.Cache#getAndReplace(K,V), ICompletableFuture

getAndReplaceAsync

ICompletableFuture<V> getAndReplaceAsync(K key,
                                       V value,
                                       javax.cache.expiry.ExpiryPolicy expiryPolicy)

Asynchronously replaces the entry for a key only if it is currently mapped to some value using custom expiry policy.

Parameters:

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

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

expiryPolicy - custom expiry policy for this operation.

Returns:

See Also:

javax.cache.Cache#getAndReplace(K,V), ICompletableFuture

get

V get(K key,
    javax.cache.expiry.ExpiryPolicy expiryPolicy)

Gets a key with custom expiry policy.

Parameters:

key - the key whose associated value is to be returned.

expiryPolicy - custom expiry policy for this operation.

Returns:

See Also:

javax.cache.Cache#get(K), ICompletableFuture

getAll

Map<K,V> getAll(Set<? extends K> keys,
              javax.cache.expiry.ExpiryPolicy expiryPolicy)

getAll operation with custom expiry policy.

Parameters:

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

expiryPolicy - custom expiry policy for this operation.

Returns:

See Also:

Cache.getAll(java.util.Set), ICompletableFuture

put

void put(K key,
       V value,
       javax.cache.expiry.ExpiryPolicy expiryPolicy)

put operation with custom expiry policy.

Parameters:

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

value - value to be associated with the specified key.

expiryPolicy - custom expiry policy for this operation.

See Also:

javax.cache.Cache#put(K,V), ICompletableFuture

getAndPut

V getAndPut(K key,
          V value,
          javax.cache.expiry.ExpiryPolicy expiryPolicy)

getAndPut operation with custom expiry policy.

Parameters:

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

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

expiryPolicy - custom expiry policy for this operation.

Returns:

See Also:

javax.cache.Cache#getAndPut(K,V), ICompletableFuture

putAll

void putAll(Map<? extends K,? extends V> map,
          javax.cache.expiry.ExpiryPolicy expiryPolicy)

putAll operation with custom expiry policy.

Parameters:

map - the mappings to be stored in this cache.

expiryPolicy - custom expiry policy for this operation.

See Also:

Cache.putAll(java.util.Map), ICompletableFuture

putIfAbsent

boolean putIfAbsent(K key,
                  V value,
                  javax.cache.expiry.ExpiryPolicy expiryPolicy)

putIfAbsent operation with custom expiry policy.

Parameters:

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

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

expiryPolicy - custom expiry policy for this operation.

Returns:

See Also:

javax.cache.Cache#putIfAbsent(K,V), ICompletableFuture

replace

boolean replace(K key,
              V oldValue,
              V newValue,
              javax.cache.expiry.ExpiryPolicy expiryPolicy)

replace operation with custom expiry policy.

Parameters:

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

oldValue - the value expected to be associated with the specified key.

newValue - the value to be associated with the specified key.

expiryPolicy - custom expiry policy for this operation.

Returns:

See Also:

javax.cache.Cache#replace(K,V,V), ICompletableFuture

replace

boolean replace(K key,
              V value,
              javax.cache.expiry.ExpiryPolicy expiryPolicy)

replace operation with custom expiry policy.

Parameters:

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

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

expiryPolicy - custom expiry policy for this operation.

Returns:

getAndReplace

V getAndReplace(K key,
              V value,
              javax.cache.expiry.ExpiryPolicy expiryPolicy)

getAndReplace operation with custom expiry policy.

Parameters:

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

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

expiryPolicy - custom expiry policy for this operation.

Returns:

See Also:

javax.cache.Cache#getAndReplace(K,V), ICompletableFuture

size

int size()

Total entry count.

Returns:

total entry count

destroy

void destroy()

Closes the cache, clears the internal content and releases any resource.

See Also:

CacheManager.destroyCache(String)

getLocalCacheStatistics

CacheStatistics getLocalCacheStatistics()

Directly access to local Cache Statistics.

Returns:

CacheStatistics instance or an empty statistics if not enabled