com.hazelcast.cache

Interface ICache<K,V>

Type Parameters:

K - key

V - 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 interface

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() close the cache, clear the internal content and release any resource
V	get(K key, javax.cache.expiry.ExpiryPolicy expiryPolicy) Get with custom expiry policy
Map<K,V>	getAll(Set<? extends K> keys, javax.cache.expiry.ExpiryPolicy expiryPolicy) getAll with custom expiry policy
V	getAndPut(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy) getAndPut with custom expiry policy
Future<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.
Future<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
Future<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 with custom expiry policy
Future<V>	getAndReplaceAsync(K key, V value) Asynchronously replaces the entry for a key only if currently mapped to some
Future<V>	getAndReplaceAsync(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy) Asynchronously replaces the entry for a key only if currently mapped to some using custom expiry policy
Future<V>	getAsync(K key) Asynchronously get an entry from cache
Future<V>	getAsync(K key, javax.cache.expiry.ExpiryPolicy expiryPolicy) Asynchronously get 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 with custom expiry policy
void	putAll(Map<? extends K,? extends V> map, javax.cache.expiry.ExpiryPolicy expiryPolicy) putAll with custom expiry policy
Future<Void>	putAsync(K key, V value) Asynchronously associates the specified value with the specified key in the cache.
Future<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 with custom expiry policy
Future<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
Future<Boolean>	removeAsync(K key) Asynchronously removes the mapping for a key from this cache if it is present.
Future<Boolean>	removeAsync(K key, V oldValue) Asynchronously removes the mapping for a key only if currently mapped to the given value.
boolean	replace(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy) replace with custom expiry policy
boolean	replace(K key, V oldValue, V newValue, javax.cache.expiry.ExpiryPolicy expiryPolicy) replace with custom expiry policy
Future<Boolean>	replaceAsync(K key, V value) Asynchronously replaces the entry for a key
Future<Boolean>	replaceAsync(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy) Asynchronously replaces the entry for a key only if currently mapped to some value.
Future<Boolean>	replaceAsync(K key, V oldValue, V newValue) Asynchronously replaces the entry for a key only if currently mapped to a given value.
Future<Boolean>	replaceAsync(K key, V oldValue, V newValue, javax.cache.expiry.ExpiryPolicy expiryPolicy) Asynchronously replaces the entry for a key only if 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

Future<V> getAsync(K key)

Asynchronously get 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), Future

getAsync

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

Asynchronously get 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), Future

putAsync

Future<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 - value to be associated with the specified key

Returns:

Future

See Also:

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

putAsync

Future<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 - 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), Future

putIfAbsentAsync

Future<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 - key with which the specified value is to be associated

value - value to be associated with the specified key

expiryPolicy -

Returns:

See Also:

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

getAndPutAsync

Future<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 - value to be associated with the specified key

Returns:

Future

See Also:

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

getAndPutAsync

Future<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 - 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), Future

removeAsync

Future<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), Future

removeAsync

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

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

Parameters:

key - the key whose associated value is to be returned

oldValue - value expected to be associated with the specified key

Returns:

Future

See Also:

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

getAndRemoveAsync

Future<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), Future

replaceAsync

Future<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 - value to be associated with the specified key

Returns:

Future

See Also:

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

replaceAsync

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

Asynchronously replaces the entry for a key only if 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), Future

replaceAsync

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

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

Parameters:

key - key with which the specified value is associated

oldValue - value expected to be associated with the specified key

newValue - value to be associated with the specified key

Returns:

See Also:

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

replaceAsync

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

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

Parameters:

key - key with which the specified value is associated

oldValue - value expected to be associated with the specified key

newValue - 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), Future

getAndReplaceAsync

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

Asynchronously replaces the entry for a key only if currently mapped to some

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), Future

getAndReplaceAsync

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

Asynchronously replaces the entry for a key only if currently mapped to some 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), Future

get

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

Get with custom expiry policy

Parameters:

key - the key whose associated value is to be returned

expiryPolicy -

Returns:

See Also:

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

getAll

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

getAll with custom expiry policy

Parameters:

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

expiryPolicy -

Returns:

See Also:

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

put

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

put with custom expiry policy

Parameters:

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

value - value to be associated with the specified key

expiryPolicy -

See Also:

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

getAndPut

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

getAndPut with custom expiry policy

Parameters:

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

value - value to be associated with the specified key

expiryPolicy -

Returns:

See Also:

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

putAll

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

putAll with custom expiry policy

Parameters:

map - mappings to be stored in this cache

expiryPolicy -

See Also:

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

putIfAbsent

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

putIfAbsent with custom expiry policy

Parameters:

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

value - value to be associated with the specified key

expiryPolicy -

Returns:

See Also:

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

replace

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

replace with custom expiry policy

Parameters:

key - key with which the specified value is associated

oldValue - value expected to be associated with the specified key

newValue - value to be associated with the specified key

expiryPolicy -

Returns:

See Also:

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

replace

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

replace 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 -

Returns:

getAndReplace

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

getAndReplace with custom expiry policy

Parameters:

key - key with which the specified value is associated

value - value to be associated with the specified key

expiryPolicy -

Returns:

See Also:

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

size

int size()

total entry count

Returns:

total entry count

destroy

void destroy()

close the cache, clear the internal content and release any resource

See Also:

CacheManager.destroyCache(String)

getLocalCacheStatistics

CacheStatistics getLocalCacheStatistics()

Directly access to local Cache Statistics

Returns:

CacheStatistics