CacheProxy (Hazelcast Root 3.8.5 API)

java.lang.Object
- com.hazelcast.spi.AbstractDistributedObject<ICacheService>
- - com.hazelcast.cache.impl.CacheProxy<K,V>

Type Parameters:

K - the type of key.

V - the type of value.

All Implemented Interfaces:

ICache<K,V>, CacheSyncListenerCompleter, ICacheInternal<K,V>, DistributedObject, PrefixedDistributedObject, Closeable, AutoCloseable, Iterable<javax.cache.Cache.Entry<K,V>>, javax.cache.Cache<K,V>
```
public class CacheProxy<K,V>
extends AbstractDistributedObject<ICacheService>
```
ICache implementation

This proxy is the implementation of ICache and javax.cache.Cache which is returned by HazelcastServerCacheManager. It represents a cache for server or embedded mode.

Each cache method actually is an operation which is sent to related partition(s) or node(s). Operations are executed on partition's or node's executor pools and the results are delivered to the user.

In order to access a CacheProxy by name, a cacheManager should be used. It's advised to use ICache instead.

Nested Class Summary
- Nested classes/interfaces inherited from interface javax.cache.Cache
  javax.cache.Cache.Entry<K,V>

Field Summary

Fields
Modifier and Type	Field and Description
`protected CacheConfig<K,V>`	`cacheConfig`
`protected ICacheService`	`cacheService`
`protected ILogger`	`logger`
`protected String`	`name`
`protected String`	`nameWithPrefix`
`protected CacheOperationProvider`	`operationProvider`
`protected IPartitionService`	`partitionService`
`protected SerializationService`	`serializationService`

Fields inherited from class com.hazelcast.spi.AbstractDistributedObject
PARTITIONING_STRATEGY

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addListenerLocally(String regId, javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)`
`String`	`addPartitionLostListener(CachePartitionLostListener listener)` Adds a CachePartitionLostListener.
`void`	`clear()`
`protected void`	`clearInternal()`
`void`	`close()`
`protected void`	`closeListeners()`
`boolean`	`containsKey(K key)`
`void`	`countDownCompletionLatch(int countDownLatchId)`
`void`	`deregisterCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)`
`protected void`	`deregisterCompletionLatch(Integer countDownLatchId)`
`protected void`	`ensureOpen()`
`boolean`	`equals(Object o)`
`V`	`get(K key)`
`V`	`get(K key, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Retrieves the mapped value of the given key using a custom `ExpiryPolicy`.
`Map<K,V>`	`getAll(Set<? extends K> keys)`
`Map<K,V>`	`getAll(Set<? extends K> keys, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Gets a collection of entries from the cache with custom expiry policy, returning them as `Map` of the values associated with the set of keys requested.
`V`	`getAndPut(K key, V value)`
`V`	`getAndPut(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Associates the specified value with the specified key in this cache using a custom `ExpiryPolicy`, returning an existing value if one existed.
`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 `ExpiryPolicy`.
`V`	`getAndRemove(K key)`
`ICompletableFuture<V>`	`getAndRemoveAsync(K key)` Asynchronously removes the entry for a key and returns the previously assigned value or null if no value was assigned.
`V`	`getAndReplace(K key, V value)`
`V`	`getAndReplace(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Atomically replaces the assigned value of the given key by the specified value using a custom `ExpiryPolicy` and returns the previously assigned value.
`ICompletableFuture<V>`	`getAndReplaceAsync(K key, V value)` Asynchronously replaces the assigned value of the given key by the specified value and returns the previously assigned value.
`ICompletableFuture<V>`	`getAndReplaceAsync(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Asynchronously replaces the assigned value of the given key by the specified value using a custom `ExpiryPolicy` and returns the previously assigned value.
`InternalCompletableFuture<V>`	`getAsync(K key)` Asynchronously retrieves the mapped value of the given key using a custom `ExpiryPolicy`.
`InternalCompletableFuture<V>`	`getAsync(K key, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Asynchronously gets an entry from cache using a custom `ExpiryPolicy`.
`javax.cache.CacheManager`	`getCacheManager()`
`<C extends javax.cache.configuration.Configuration<K,V>> C`	`getConfiguration(Class<C> clazz)`
`protected String`	`getDistributedObjectName()`
`protected String`	`getListenerIdLocal(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)`
`CacheStatistics`	`getLocalCacheStatistics()` Directly access local Cache Statistics.
`String`	`getName()` Returns the unique name for this DistributedObject.
`String`	`getPrefixedName()` Returns the unique prefixed name for this DistributedObject.
`String`	`getServiceName()` Returns the service name for this object.
`int`	`hashCode()`
`protected void`	`injectDependencies(Object obj)`
`<T> T`	`invoke(K key, javax.cache.processor.EntryProcessor<K,V,T> entryProcessor, Object... arguments)`
`protected <T> InternalCompletableFuture<T>`	`invoke(Operation op, Data keyData, boolean completionOperation)`
`protected <T> InternalCompletableFuture<T>`	`invoke(Operation op, int partitionId, boolean completionOperation)`
`<T> Map<K,javax.cache.processor.EntryProcessorResult<T>>`	`invokeAll(Set<? extends K> keys, javax.cache.processor.EntryProcessor<K,V,T> entryProcessor, Object... arguments)`
`boolean`	`isClosed()`
`boolean`	`isDestroyed()`
`Iterator<javax.cache.Cache.Entry<K,V>>`	`iterator()`
`Iterator<javax.cache.Cache.Entry<K,V>>`	`iterator(int fetchSize)` Creates and returns a cluster wide iterator to iterate on all entries owned by this cache.
`Iterator<javax.cache.Cache.Entry<K,V>>`	`iterator(int fetchSize, int partitionId, boolean prefetchValues)`
`void`	`loadAll(Set<? extends K> keys, boolean replaceExistingValues, javax.cache.integration.CompletionListener completionListener)`
`void`	`open()`
`protected void`	`postDestroy()`
`protected boolean`	`preDestroy()`
`void`	`put(K key, V value)`
`void`	`put(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Associates the specified value with the specified key in the cache using a custom `ExpiryPolicy`.
`void`	`putAll(Map<? extends K,? extends V> map)`
`void`	`putAll(Map<? extends K,? extends V> map, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Copies all of the entries from the given map to the cache using a custom `ExpiryPolicy`.
`InternalCompletableFuture<Void>`	`putAsync(K key, V value)` Asynchronously associates the specified value with the specified key in the cache.
`InternalCompletableFuture<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 `ExpiryPolicy`.
`protected <T> InternalCompletableFuture<T>`	`putAsyncInternal(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy, boolean isGet, boolean withCompletionEvent)`
`boolean`	`putIfAbsent(K key, V value)`
`boolean`	`putIfAbsent(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Associates the specified key with the given value if and only if there is not yet a mapping defined for the specified key.
`InternalCompletableFuture<Boolean>`	`putIfAbsentAsync(K key, V value)` Asynchronously associates the specified key with the given value if and only if there is not yet a mapping defined for the specified key.
`InternalCompletableFuture<Boolean>`	`putIfAbsentAsync(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Asynchronously associates the specified key with the given value if and only if there is not yet a mapping defined for the specified key.
`protected InternalCompletableFuture<Boolean>`	`putIfAbsentAsyncInternal(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy, boolean withCompletionEvent)`
`void`	`registerCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)`
`void`	`registerCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration, boolean addToConfig)` Registers the provided listener configuration.
`protected Integer`	`registerCompletionLatch(int count)`
`boolean`	`remove(K key)`
`boolean`	`remove(K key, V oldValue)`
`void`	`removeAll()`
`void`	`removeAll(Set<? extends K> keys)`
`protected void`	`removeAllInternal(Set<? extends K> keys)`
`InternalCompletableFuture<Boolean>`	`removeAsync(K key)` Asynchronously removes the mapping for a key from this cache if it is present.
`InternalCompletableFuture<Boolean>`	`removeAsync(K key, V oldValue)` Asynchronously removes the mapping for the given key if and only if the currently mapped value equals to the value of `oldValue`.
`protected <T> InternalCompletableFuture<T>`	`removeAsyncInternal(K key, V oldValue, boolean hasOldValue, boolean isGet, boolean withCompletionEvent)`
`protected String`	`removeListenerLocally(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)`
`boolean`	`removePartitionLostListener(String id)` Removes the specified cache partition lost listener.
`boolean`	`replace(K key, V value)`
`boolean`	`replace(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Atomically replaces the assigned value of the given key by the specified value using a custom `ExpiryPolicy`.
`boolean`	`replace(K key, V oldValue, V newValue)`
`boolean`	`replace(K key, V oldValue, V newValue, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Atomically replaces the currently assigned value for the given key with the specified `newValue` if and only if the currently assigned value equals the value of `oldValue` using a custom `ExpiryPolicy`.
`ICompletableFuture<Boolean>`	`replaceAsync(K key, V value)` Asynchronously replaces the assigned value of the given key by the specified value.
`ICompletableFuture<Boolean>`	`replaceAsync(K key, V value, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Asynchronously replaces the assigned value of the given key by the specified value using a custom `ExpiryPolicy`.
`ICompletableFuture<Boolean>`	`replaceAsync(K key, V oldValue, V newValue)` Asynchronously replaces the currently assigned value for the given key with the specified `newValue` if and only if the currently assigned value equals the value of `oldValue`.
`ICompletableFuture<Boolean>`	`replaceAsync(K key, V oldValue, V newValue, javax.cache.expiry.ExpiryPolicy expiryPolicy)` Asynchronously replaces the currently assigned value for the given key with the specified `newValue` if and only if the currently assigned value equals the value of `oldValue` using a custom `ExpiryPolicy`.
`protected <T> InternalCompletableFuture<T>`	`replaceAsyncInternal(K key, V oldValue, V newValue, javax.cache.expiry.ExpiryPolicy expiryPolicy, boolean hasOldValue, boolean isGet, boolean withCompletionEvent)`
`int`	`size()` Total entry count.
`protected void`	`submitLoadAllTask(com.hazelcast.cache.impl.AbstractCacheProxyBase.LoadAllTask loadAllTask)`
`String`	`toString()`
`<T> T`	`unwrap(Class<T> clazz)`
`protected void`	`updateCacheListenerConfigOnOtherNodes(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration, boolean isRegister)`
`protected void`	`waitCompletionLatch(Integer countDownLatchId)`
`protected void`	`waitCompletionLatch(Integer countDownLatchId, int offset)`

Methods inherited from class com.hazelcast.spi.AbstractDistributedObject
destroy, getNameAsPartitionAwareData, getNodeEngine, getOperationService, getPartitionId, getPartitionKey, getService, invalidate, invokeOnPartition, throwNotActiveException, toData

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.hazelcast.cache.impl.ICacheInternal
open

Methods inherited from interface com.hazelcast.cache.ICache
destroy, isDestroyed

Methods inherited from interface javax.cache.Cache
close, getName, isClosed

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface com.hazelcast.core.PrefixedDistributedObject
getPrefixedName

Methods inherited from interface com.hazelcast.core.DistributedObject
getName, getPartitionKey, getServiceName

- Field Detail
  - logger
```
protected final ILogger logger
```
  - cacheConfig
```
protected final CacheConfig<K,V> cacheConfig
```
  - name
```
protected final String name
```
  - nameWithPrefix
```
protected final String nameWithPrefix
```
  - cacheService
```
protected final ICacheService cacheService
```
  - serializationService
```
protected final SerializationService serializationService
```
  - operationProvider
```
protected final CacheOperationProvider operationProvider
```
  - partitionService
```
protected final IPartitionService partitionService
```
- Method Detail
  - get
```
public V get(K key)
```
  - getAll
```
public Map<K,V> getAll(Set<? extends K> keys)
```
  - containsKey
```
public boolean containsKey(K key)
```
  - loadAll
```
public void loadAll(Set<? extends K> keys,
                    boolean replaceExistingValues,
                    javax.cache.integration.CompletionListener completionListener)
```
  - put
```
public void put(K key,
                V value)
```
  - getAndPut
```
public V getAndPut(K key,
                   V value)
```
  - putAll
```
public void putAll(Map<? extends K,? extends V> map)
```
  - putIfAbsent
```
public boolean putIfAbsent(K key,
                           V value)
```
  - remove
```
public boolean remove(K key)
```
  - remove
```
public boolean remove(K key,
                      V oldValue)
```
  - getAndRemove
```
public V getAndRemove(K key)
```
  - replace
```
public boolean replace(K key,
                       V oldValue,
                       V newValue)
```
  - replace
```
public boolean replace(K key,
                       V value)
```
  - getAndReplace
```
public V getAndReplace(K key,
                       V value)
```
  - removeAll
```
public void removeAll(Set<? extends K> keys)
```
  - removeAll
```
public void removeAll()
```
  - clear
```
public void clear()
```
  - getConfiguration
```
public <C extends javax.cache.configuration.Configuration<K,V>> C getConfiguration(Class<C> clazz)
```
  - invoke
```
public <T> T invoke(K key,
                    javax.cache.processor.EntryProcessor<K,V,T> entryProcessor,
                    Object... arguments)
             throws javax.cache.processor.EntryProcessorException
```
    Throws:
    
    javax.cache.processor.EntryProcessorException
  - invokeAll
```
public <T> Map<K,javax.cache.processor.EntryProcessorResult<T>> invokeAll(Set<? extends K> keys,
                                                                          javax.cache.processor.EntryProcessor<K,V,T> entryProcessor,
                                                                          Object... arguments)
```
  - unwrap
```
public <T> T unwrap(Class<T> clazz)
```
  - registerCacheEntryListener
```
public void registerCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)
```
  - registerCacheEntryListener
```
public void registerCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration,
                                       boolean addToConfig)
```
    Description copied from interface: ICacheInternal
    
    Registers the provided listener configuration.
    
    Parameters:
    
    cacheEntryListenerConfiguration - The cache configuration to be used for registering the entry listener
    
    addToConfig - If true, the configuration is added to the existing listeners in the cache config.
  - deregisterCacheEntryListener
```
public void deregisterCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)
```
  - updateCacheListenerConfigOnOtherNodes
```
protected void updateCacheListenerConfigOnOtherNodes(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration,
                                                     boolean isRegister)
```
  - iterator
```
public Iterator<javax.cache.Cache.Entry<K,V>> iterator()
```
  - iterator
```
public Iterator<javax.cache.Cache.Entry<K,V>> iterator(int fetchSize)
```
    Description copied from interface: ICache
    Creates and returns a cluster wide iterator to iterate on all entries owned by this cache.
    
    The ordering of iteration over entries is undefined.
    
    During iteration, any entries that are:
    - read will have their appropriate CacheEntryReadListeners notified.
    - removed will have their appropriate CacheEntryRemoveListeners notified.
    Iterator.next() may return null if the entry is no longer present, has expired or has been evicted.
    Parameters:
    
    fetchSize - size for fetching keys in bulk. This size can be thought of as page size for iteration. But notice that at every fetch, only keys are retrieved, not values. Values are retrieved on each iterate.
    
    See Also:
    
    Cache.iterator()
  - iterator
```
public Iterator<javax.cache.Cache.Entry<K,V>> iterator(int fetchSize,
                                                       int partitionId,
                                                       boolean prefetchValues)
```
  - addPartitionLostListener
```
public String addPartitionLostListener(CachePartitionLostListener listener)
```
    Description copied from interface: ICache
    
    Adds a CachePartitionLostListener.
    The addPartitionLostListener returns a registration ID. This ID is needed to remove the CachePartitionLostListener using the ICache.removePartitionLostListener(String) method.
    There is no check for duplicate registrations, so if you register the listener twice, it will get events twice. IMPORTANT: Please @see com.hazelcast.partition.PartitionLostListener for weaknesses. IMPORTANT: Listeners registered from HazelcastClient may miss some of the cache partition lost events due to design limitations.
    
    Parameters:
    
    listener - the added CachePartitionLostListener.
    
    Returns:
    
    returns the registration id for the CachePartitionLostListener.
    
    See Also:
    
    ICache.removePartitionLostListener(String)
  - removePartitionLostListener
```
public boolean removePartitionLostListener(String id)
```
    Description copied from interface: ICache
    
    Removes the specified cache partition lost listener. Returns silently if there is no such listener added before.
    
    Parameters:
    
    id - ID of registered listener.
    
    Returns:
    
    true if registration is removed, false otherwise.
  - getAsync
```
public InternalCompletableFuture<V> getAsync(K key)
```
    Description copied from interface: ICache
    
    Asynchronously retrieves the mapped value of the given key using a custom ExpiryPolicy. If no mapping exists null is returned.
    If the cache is configured for read-through operation mode, the underlying configured CacheLoader might be called to retrieve the value of the key from any kind of external resource.
    The resulting ICompletableFuture instance may throw a ClassCastException as the operations result if the Cache is configured to perform runtime-type-checking, and the key or value types are incompatible with those that have been configured for the Cache.
    
    Parameters:
    
    key - The key whose associated value is to be returned.
    
    Returns:
    
    ICompletableFuture retrieve the value assigned to the given key.
    
    See Also:
    
    javax.cache.Cache#get(K), ICompletableFuture
  - getAsync
```
public InternalCompletableFuture<V> getAsync(K key,
                                             javax.cache.expiry.ExpiryPolicy expiryPolicy)
```
    Description copied from interface: ICache
    
    Asynchronously gets an entry from cache using a custom ExpiryPolicy.
    If the cache is configured for read-through operation mode, the underlying configured CacheLoader might be called to retrieve the value of the key from any kind of external resource.
    The resulting ICompletableFuture instance may throw a ClassCastException as the operations result if the Cache is configured to perform runtime-type-checking, and the key or value types are incompatible with those that have been configured for the Cache.
    
    Parameters:
    
    key - The key whose associated value is to be returned.
    
    expiryPolicy - The custom expiry policy for this operation, a null value is equivalent to ICache.getAsync(Object).
    
    Returns:
    
    ICompletableFuture retrieve the value assigned to the given key.
    
    See Also:
    
    javax.cache.Cache#get(K), ICompletableFuture
  - putAsync
```
public InternalCompletableFuture<Void> putAsync(K key,
                                                V value)
```
    Description copied from interface: ICache
    
    Asynchronously associates the specified value with the specified key in the cache.
    In case a previous assignment already exists, the previous value is overridden by the new given value.
    If the cache is configured for write-through operation mode, the underlying configured CacheWriter might be called to store the value of the key to any kind of external resource.
    
    Parameters:
    
    key - The key whose associated value is to be returned.
    
    value - The value to be associated with the specified key.
    
    Returns:
    
    ICompletableFuture notify when the operation succeeds.
    
    See Also:
    
    javax.cache.Cache#put(K,V), ICompletableFuture
  - putAsync
```
public InternalCompletableFuture<Void> putAsync(K key,
                                                V value,
                                                javax.cache.expiry.ExpiryPolicy expiryPolicy)
```
    Description copied from interface: ICache
    
    Asynchronously associates the specified value with the specified key in the cache using a custom ExpiryPolicy.
    In case a previous assignment already exists, the previous value is overridden by the new given value.
    If the cache is configured for write-through operation mode, the underlying configured CacheWriter might be called to store the value of the key to any kind of external resource.
    
    Parameters:
    
    key - The key whose associated value is to be returned.
    
    value - The value to be associated with the specified key.
    
    expiryPolicy - The custom expiry policy for this operation, a null value is equivalent to ICache.putAsync(Object, Object).
    
    Returns:
    
    ICompletableFuture notify when the operation succeeds.
    
    See Also:
    
    javax.cache.Cache#put(K,V), ICompletableFuture
  - putIfAbsentAsync
```
public InternalCompletableFuture<Boolean> putIfAbsentAsync(K key,
                                                           V value)
```
    Description copied from interface: ICache
    Asynchronously associates the specified key with the given value if and only if there is not yet a mapping defined for the specified key.
    This is equivalent to:
```
   if (!cache.containsKey(key)) {}
     cache.put(key, value);
     return true;
   } else {
     return false;
   }
 
```
    except that the action is performed atomically.
    If the cache is configured for write-through operation mode, the underlying configured CacheWriter might be called to store the value of the key to any kind of external resource.
    Parameters:
    
    key - The key that is associated with the specified value.
    
    value - The value to which the specified key is associated.
    
    Returns:
    
    ICompletableFuture notify if a previous value was assigned with the key
    
    See Also:
    
    javax.cache.Cache#putIfAbsent(K,V), ICompletableFuture
  - putIfAbsentAsync
```
public InternalCompletableFuture<Boolean> putIfAbsentAsync(K key,
                                                           V value,
                                                           javax.cache.expiry.ExpiryPolicy expiryPolicy)
```
    Description copied from interface: ICache
    Asynchronously associates the specified key with the given value if and only if there is not yet a mapping defined for the specified key. using a custom ExpiryPolicy.
    This is equivalent to:
```
   if (!cache.containsKey(key)) {}
     cache.put(key, value);
     return true;
   } else {
     return false;
   }
 
```
    except that the action is performed atomically.
    If the cache is configured for write-through operation mode, the underlying configured CacheWriter might be called to store the value of the key to any kind of external resource.
    Parameters:
    
    key - The key that is associated with the specified value.
    
    value - The value to which the specified key is associated.
    
    expiryPolicy - custom expiry policy for this operation, a null value is equivalent to ICache.putIfAbsentAsync(Object, Object)
    
    Returns:
    
    ICompletableFuture notify if a previous value was assigned with the key
    
    See Also:
    
    javax.cache.Cache#putIfAbsent(K,V), ICompletableFuture
  - getAndPutAsync
```
public ICompletableFuture<V> getAndPutAsync(K key,
                                            V value)
```
    Description copied from interface: ICache
    
    Asynchronously associates the specified value with the specified key in this cache, returning an existing value if one existed.
    In case a previous assignment already exists, the previous value is overridden by the new given value and the previous value is returned to the caller. This is equivalent to the Map.put(Object, Object) operation.
    If the cache is configured for write-through operation mode, the underlying configured CacheWriter might be called to store the value of the key to any kind of external resource.
    
    Parameters:
    
    key - The key whose associated value is to be returned.
    
    value - The value that is associated with the specified key.
    
    Returns:
    
    ICompletableFuture retrieve a possible previously assigned value for the given key.
    
    See Also:
    
    javax.cache.Cache#getAndPut(K,V), ICompletableFuture
  - getAndPutAsync
```
public ICompletableFuture<V> getAndPutAsync(K key,
                                            V value,
                                            javax.cache.expiry.ExpiryPolicy expiryPolicy)
```
    Description copied from interface: ICache
    
    Asynchronously associates the specified value with the specified key in this cache, returning an existing value if one existed using a custom ExpiryPolicy.
    In case a previous assignment already exists, the previous value is overridden by the new given value and the previous value is returned to the caller. This is equivalent to the Map.put(Object, Object) operation.
    If the cache is configured for write-through operation mode, the underlying configured CacheWriter might be called to store the value of the key to any kind of external resource.
    
    Parameters:
    
    key - The key whose associated value is to be returned.
    
    value - The value to associate with the specified key.
    
    expiryPolicy - The custom expiry policy for this operation, a null value is equivalent to ICache.getAndPutAsync(Object, Object).
    
    Returns:
    
    ICompletableFuture retrieve a possible previously assigned value for the given key.
    
    See Also:
    
    javax.cache.Cache#getAndPut(K,V), ICompletableFuture
  - removeAsync
```
public InternalCompletableFuture<Boolean> removeAsync(K key)
```
    Description copied from interface: ICache
    
    Asynchronously removes the mapping for a key from this cache if it is present.
    If the cache is configured for write-through operation mode, the underlying configured CacheWriter might be called to store the value of the key to any kind of external resource.
    The resulting ICompletableFuture instance may throw a ClassCastException as the operations result if the Cache is configured to perform runtime-type-checking, and the key or value types are incompatible with those that have been configured for the Cache.
    
    Parameters:
    
    key - The key whose mapping is to be removed.
    
    Returns:
    
    ICompletableFuture notify if mapping could be removed or not.
    
    See Also:
    
    javax.cache.Cache#remove(K), ICompletableFuture
  - removeAsync
```
public InternalCompletableFuture<Boolean> removeAsync(K key,
                                                      V oldValue)
```
    Description copied from interface: ICache
    Asynchronously removes the mapping for the given key if and only if the currently mapped value equals to the value of oldValue.
    This is equivalent to:
```
   if (cache.containsKey(key) && equals(cache.get(key), oldValue) {
     cache.remove(key);
     return true;
   } else {
     return false;
   }
 
```
    except that the action is performed atomically.
    If the cache is configured for write-through operation mode, the underlying configured CacheWriter might be called to store the value of the key to any kind of external resource.
    The resulting ICompletableFuture instance may throw a ClassCastException as the operations result if the Cache is configured to perform runtime-type-checking, and the key or value types are incompatible with those that have been configured for the Cache.
    Parameters:
    
    key - The key whose mapping is to be removed if the mapped value is oldValue.
    
    oldValue - The value expected to be associated with the specified key.
    
    Returns:
    
    ICompletableFuture notify if mapping could be removed or not.
    
    See Also:
    
    javax.cache.Cache#remove(K,V), ICompletableFuture
  - getAndRemoveAsync
```
public ICompletableFuture<V> getAndRemoveAsync(K key)
```
    Description copied from interface: ICache
    
    Asynchronously removes the entry for a key and returns the previously assigned value or null if no value was assigned.
    If the cache is configured for write-through operation mode, the underlying configured CacheWriter might be called to store the value of the key to any kind of external resource.
    The resulting ICompletableFuture instance may throw a ClassCastException as the operations result if the Cache is configured to perform runtime-type-checking, and the key or value types are incompatible with those that have been configured for the Cache.
    
    Parameters:
    
    key - The key to be removed and whose associated value is to be returned.
    
    Returns:
    
    ICompletableFuture retrieve a possible previously assigned value for the removed key.
    
    See Also:
    
    javax.cache.Cache#getAndRemove(K), ICompletableFuture
  - replaceAsync
```
public ICompletableFuture<Boolean> replaceAsync(K key,
                                                V value)
```
    Description copied from interface: ICache
    
    Asynchronously replaces the assigned value of the given key by the specified value.
    If the cache is configured for write-through operation mode, the underlying configured CacheWriter might be called to store the value of the key to any kind of external resource.
    
    Parameters:
    
    key - The key whose associated value is to be replaced.
    
    value - The new value to be associated with the specified key.
    
    Returns:
    
    ICompletableFuture notify if the operation succeeds or not.
    
    See Also:
    
    javax.cache.Cache#replace(K,V), ICompletableFuture
  - replaceAsync
```
public ICompletableFuture<Boolean> replaceAsync(K key,
                                                V value,
                                                javax.cache.expiry.ExpiryPolicy expiryPolicy)
```
    Description copied from interface: ICache
    
    Asynchronously replaces the assigned value of the given key by the specified value using a custom ExpiryPolicy.
    If the cache is configured for write-through operation mode, the underlying configured CacheWriter might be called to store the value of the key to any kind of external resource.
    
    Parameters:
    
    key - The key whose assigned value is replaced by the specified value.
    
    value - The specified value to be associated with the given key.
    
    expiryPolicy - The custom expiry policy for this operation, a null value is equivalent to ICache.replaceAsync(Object, Object)
    
    Returns:
    
    ICompletableFuture notify if the operation succeeds or not.
    
    See Also:
    
    javax.cache.Cache#replace(K,V), ICompletableFuture
  - replaceAsync
```
public ICompletableFuture<Boolean> replaceAsync(K key,
                                                V oldValue,
                                                V newValue)
```
    Description copied from interface: ICache
    Asynchronously replaces the currently assigned value for the given key with the specified newValue if and only if the currently assigned value equals the value of oldValue.
    This is equivalent to:
```
   if (cache.containsKey(key) && equals(cache.get(key), oldValue) {
     cache.put(key, newValue);
     return true;
   } else {
     return false;
   }
 
```
    except that the action is performed atomically.
    If the cache is configured for write-through operation mode, the underlying configured CacheWriter might be called to store the value of the key to any kind of external resource.
    The resulting ICompletableFuture instance may throw a ClassCastException as the operations result if the Cache is configured to perform runtime-type-checking, and the key or value types are incompatible with those that have been configured for the Cache.
    Parameters:
    
    key - The key that will have its assigned value replaced.
    
    oldValue - The old value expected to be associated with the specified key.
    
    newValue - The new value to be associated with the specified key.
    
    Returns:
    
    ICompletableFuture notify if the operation succeeds or not.
    
    See Also:
    
    javax.cache.Cache#replace(K,V,V), ICompletableFuture
  - replaceAsync
```
public ICompletableFuture<Boolean> replaceAsync(K key,
                                                V oldValue,
                                                V newValue,
                                                javax.cache.expiry.ExpiryPolicy expiryPolicy)
```
    Description copied from interface: ICache
    Asynchronously replaces the currently assigned value for the given key with the specified newValue if and only if the currently assigned value equals the value of oldValue using a custom ExpiryPolicy.
    This is equivalent to:
```
   if (cache.containsKey(key) && equals(cache.get(key), oldValue) {
     cache.put(key, newValue);
     return true;
   } else {
     return false;
   }
 
```
    except that the action is performed atomically.
    If the cache is configured for write-through operation mode, the underlying configured CacheWriter might be called to store the value of the key to any kind of external resource.
    The resulting ICompletableFuture instance may throw a ClassCastException as the operations result if the Cache is configured to perform runtime-type-checking, and the key or value types are incompatible with those that have been configured for the Cache.
    Parameters:
    
    key - The key that will have its assigned value replaced.
    
    oldValue - The old value expected to be associated with the specified key.
    
    newValue - The new value to be associated with the specified key.
    
    expiryPolicy - The custom expiry policy for this operation, a null value is equivalent to ICache.replaceAsync(Object, Object, Object).
    
    Returns:
    
    ICompletableFuture to get notified if the operation succeed or not.
    
    See Also:
    
    javax.cache.Cache#replace(K,V,V), ICompletableFuture
  - getAndReplaceAsync
```
public ICompletableFuture<V> getAndReplaceAsync(K key,
                                                V value)
```
    Description copied from interface: ICache
    
    Asynchronously replaces the assigned value of the given key by the specified value and returns the previously assigned value.
    If the cache is configured for write-through operation mode, the underlying configured CacheWriter might be called to store the value of the key to any kind of external resource.
    
    Parameters:
    
    key - The key whose value is replaced.
    
    value - The new value to be associated with the specified key.
    
    Returns:
    
    ICompletableFuture to retrieve a possible previously assigned value for the given key.
    
    See Also:
    
    javax.cache.Cache#getAndReplace(K,V), ICompletableFuture
  - getAndReplaceAsync
```
public ICompletableFuture<V> getAndReplaceAsync(K key,
                                                V value,
                                                javax.cache.expiry.ExpiryPolicy expiryPolicy)
```
    Description copied from interface: ICache
    
    Asynchronously replaces the assigned value of the given key by the specified value using a custom ExpiryPolicy and returns the previously assigned value.
    If the cache is configured for write-through operation mode, the underlying configured CacheWriter might be called to store the value of the key to any kind of external resource.
    
    Parameters:
    
    key - The key whose value is replaced.
    
    value - The new value to be associated with the specified key.
    
    expiryPolicy - The custom expiry policy for this operation, a null value is equivalent to Cache.getAndReplace(Object, Object)
    
    Returns:
    
    ICompletableFuture to retrieve a possible previously assigned value for the given key.
    
    See Also:
    
    javax.cache.Cache#getAndReplace(K,V), ICompletableFuture
  - get
```
public V get(K key,
             javax.cache.expiry.ExpiryPolicy expiryPolicy)
```
    Description copied from interface: ICache
    
    Retrieves the mapped value of the given key using a custom ExpiryPolicy. If no mapping exists null is returned.
    If the cache is configured for read-through operation mode, the underlying configured CacheLoader might be called to retrieve the value of the key from any kind of external resource.
    
    Parameters:
    
    key - The key whose mapped value is to be returned.
    
    expiryPolicy - The custom expiry policy for this operation, a null value is equivalent to Cache.get(Object).
    
    Returns:
    
    The value assigned to the given key, or null if not assigned.
    
    See Also:
    
    javax.cache.Cache#get(K)
  - getAll
```
public Map<K,V> getAll(Set<? extends K> keys,
                       javax.cache.expiry.ExpiryPolicy expiryPolicy)
```
    Description copied from interface: ICache
    
    Gets a collection of entries from the cache with custom expiry policy, returning them as Map of the values associated with the set of keys requested.
    If the cache is configured for read-through operation mode, the underlying configured CacheLoader might be called to retrieve the values of the keys from any kind of external resource.
    
    Parameters:
    
    keys - The keys whose associated values are to be returned.
    
    expiryPolicy - The custom expiry policy for this operation, a null value is equivalent to Cache.getAll(java.util.Set).
    
    Returns:
    
    A map of entries that were found for the given keys. Keys not found in the cache are not in the returned map.
    
    See Also:
    
    Cache.getAll(java.util.Set)
  - put
```
public void put(K key,
                V value,
                javax.cache.expiry.ExpiryPolicy expiryPolicy)
```
    Description copied from interface: ICache
    
    Associates the specified value with the specified key in the cache using a custom ExpiryPolicy.
    
    Parameters:
    
    key - The key that has the specified value associated with it.
    
    value - The value to be associated with the key.
    
    expiryPolicy - The custom expiry policy for this operation, a null value is equivalent to Cache.put(Object, Object).
    
    See Also:
    
    javax.cache.Cache#put(K,V)
  - getAndPut
```
public V getAndPut(K key,
                   V value,
                   javax.cache.expiry.ExpiryPolicy expiryPolicy)
```
    Description copied from interface: ICache
    
    Associates the specified value with the specified key in this cache using a custom ExpiryPolicy, returning an existing value if one existed.
    
    Parameters:
    
    key - The key that has the specified value associated with it.
    
    value - The value to be associated with the key.
    
    expiryPolicy - The custom expiry policy for this operation, a null value is equivalent to Cache.getAndPut(Object, Object).
    
    Returns:
    
    The value previously assigned to the given key, or null if not assigned.
    
    See Also:
    
    javax.cache.Cache#getAndPut(K,V)
  - putAll
```
public void putAll(Map<? extends K,? extends V> map,
                   javax.cache.expiry.ExpiryPolicy expiryPolicy)
```
    Description copied from interface: ICache
    
    Copies all of the entries from the given map to the cache using a custom ExpiryPolicy.
    Puts of single entries happen atomically but there is no transactional guarantee over the complete putAll operation. If other concurrent operations modify or remove all or single values of the provided map, the result is undefined.
    If the cache is configured for write-through operation mode, the underlying configured CacheWriter might be called to store the values of the keys to any kind of external resource.
    
    Parameters:
    
    map - The mappings to be stored in this cache.
    
    expiryPolicy - The custom expiry policy for this operation, a null value is equivalent to Cache.putAll(java.util.Map).
    
    See Also:
    
    Cache.putAll(java.util.Map)
  - putIfAbsent
```
public boolean putIfAbsent(K key,
                           V value,
                           javax.cache.expiry.ExpiryPolicy expiryPolicy)
```
    Description copied from interface: ICache
    Associates the specified key with the given value if and only if there is not yet a mapping defined for the specified key.
    This is equivalent to:
```
   if (!cache.containsKey(key)) {}
     cache.put(key, value);
     return true;
   } else {
     return false;
   }
 
```
    except that the action is performed atomically.
    If the cache is configured for write-through operation mode, the underlying configured CacheWriter might be called to store the value of the key to any kind of external resource.
    Parameters:
    
    key - The key that is associated with the specified value.
    
    value - The value that has the specified key associated with it.
    
    expiryPolicy - The custom expiry policy for this operation, a null value is equivalent to Cache.putIfAbsent(Object, Object).
    
    Returns:
    
    true if a value was set, false otherwise.
    
    See Also:
    
    javax.cache.Cache#putIfAbsent(K,V)
  - replace
```
public boolean replace(K key,
                       V oldValue,
                       V newValue,
                       javax.cache.expiry.ExpiryPolicy expiryPolicy)
```
    Description copied from interface: ICache
    Atomically replaces the currently assigned value for the given key with the specified newValue if and only if the currently assigned value equals the value of oldValue using a custom ExpiryPolicy.
    This is equivalent to:
```
   if (cache.containsKey(key) && equals(cache.get(key), oldValue) {
     cache.put(key, newValue);
     return true;
   } else {
     return false;
   }
 
```
    except that the action is performed atomically.
    If the cache is configured for write-through operation mode, the underlying configured CacheWriter might be called to store the value of the key to any kind of external resource.
    Parameters:
    
    key - The key with the value to be replaced.
    
    oldValue - The old value expected to be associated with the specified key.
    
    newValue - The new value to be associated with the specified key.
    
    expiryPolicy - The custom expiry policy for this operation, a null value is equivalent to Cache.replace(Object, Object, Object).
    
    Returns:
    
    true if a value was replaced, false otherwise.
    
    See Also:
    
    javax.cache.Cache#replace(K,V,V)
  - replace
```
public boolean replace(K key,
                       V value,
                       javax.cache.expiry.ExpiryPolicy expiryPolicy)
```
    Description copied from interface: ICache
    
    Atomically replaces the assigned value of the given key by the specified value using a custom ExpiryPolicy.
    If the cache is configured for write-through operation mode, the underlying configured CacheWriter might be called to store the value of the key to any kind of external resource.
    
    Parameters:
    
    key - The key whose value is replaced.
    
    value - The new value to be associated with the specified key.
    
    expiryPolicy - The custom expiry policy for this operation, a null value is equivalent to Cache.replace(Object, Object)
    
    Returns:
    
    true if a value was replaced, false otherwise.
    
    See Also:
    
    javax.cache.Cache#replace(K,V)
  - getAndReplace
```
public V getAndReplace(K key,
                       V value,
                       javax.cache.expiry.ExpiryPolicy expiryPolicy)
```
    Description copied from interface: ICache
    
    Atomically replaces the assigned value of the given key by the specified value using a custom ExpiryPolicy and returns the previously assigned value.
    If the cache is configured for write-through operation mode, the underlying configured CacheWriter might be called to store the value of the key to any kind of external resource.
    
    Parameters:
    
    key - The key whose value is replaced.
    
    value - The new value to be associated with the specified key.
    
    expiryPolicy - The custom expiry policy for this operation, a null value is equivalent to Cache.getAndReplace(Object, Object).
    
    Returns:
    
    The old value previously assigned to the given key.
    
    See Also:
    
    javax.cache.Cache#getAndReplace(K,V)
  - size
```
public int size()
```
    Description copied from interface: ICache
    
    Total entry count.
    
    Returns:
    
    total entry count
  - getCacheManager
```
public javax.cache.CacheManager getCacheManager()
```
    Specified by:
    
    getCacheManager in interface javax.cache.Cache<K,V>
  - postDestroy
```
protected void postDestroy()
```
    Overrides:
    
    postDestroy in class AbstractDistributedObject<ICacheService>
  - invoke
```
protected <T> InternalCompletableFuture<T> invoke(Operation op,
                                                  int partitionId,
                                                  boolean completionOperation)
```
  - invoke
```
protected <T> InternalCompletableFuture<T> invoke(Operation op,
                                                  Data keyData,
                                                  boolean completionOperation)
```
  - removeAsyncInternal
```
protected <T> InternalCompletableFuture<T> removeAsyncInternal(K key,
                                                               V oldValue,
                                                               boolean hasOldValue,
                                                               boolean isGet,
                                                               boolean withCompletionEvent)
```
  - replaceAsyncInternal
```
protected <T> InternalCompletableFuture<T> replaceAsyncInternal(K key,
                                                                V oldValue,
                                                                V newValue,
                                                                javax.cache.expiry.ExpiryPolicy expiryPolicy,
                                                                boolean hasOldValue,
                                                                boolean isGet,
                                                                boolean withCompletionEvent)
```
  - putAsyncInternal
```
protected <T> InternalCompletableFuture<T> putAsyncInternal(K key,
                                                            V value,
                                                            javax.cache.expiry.ExpiryPolicy expiryPolicy,
                                                            boolean isGet,
                                                            boolean withCompletionEvent)
```
  - putIfAbsentAsyncInternal
```
protected InternalCompletableFuture<Boolean> putIfAbsentAsyncInternal(K key,
                                                                      V value,
                                                                      javax.cache.expiry.ExpiryPolicy expiryPolicy,
                                                                      boolean withCompletionEvent)
```
  - clearInternal
```
protected void clearInternal()
```
  - removeAllInternal
```
protected void removeAllInternal(Set<? extends K> keys)
```
  - addListenerLocally
```
protected void addListenerLocally(String regId,
                                  javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)
```
  - removeListenerLocally
```
protected String removeListenerLocally(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)
```
  - getListenerIdLocal
```
protected String getListenerIdLocal(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)
```
  - closeListeners
```
protected void closeListeners()
```
  - countDownCompletionLatch
```
public void countDownCompletionLatch(int countDownLatchId)
```
    Specified by:
    
    countDownCompletionLatch in interface CacheSyncListenerCompleter
  - registerCompletionLatch
```
protected Integer registerCompletionLatch(int count)
```
  - deregisterCompletionLatch
```
protected void deregisterCompletionLatch(Integer countDownLatchId)
```
  - waitCompletionLatch
```
protected void waitCompletionLatch(Integer countDownLatchId)
```
  - waitCompletionLatch
```
protected void waitCompletionLatch(Integer countDownLatchId,
                                   int offset)
```
  - getLocalCacheStatistics
```
public CacheStatistics getLocalCacheStatistics()
```
    Description copied from interface: ICache
    
    Directly access local Cache Statistics.
    
    Specified by:
    
    getLocalCacheStatistics in interface ICache<K,V>
    
    Returns:
    
    CacheStatistics instance or an empty statistics if not enabled.
  - injectDependencies
```
protected void injectDependencies(Object obj)
```
  - getServiceName
```
public String getServiceName()
```
    Description copied from interface: DistributedObject
    
    Returns the service name for this object.
    
    Specified by:
    
    getServiceName in interface DistributedObject
    
    Specified by:
    
    getServiceName in class AbstractDistributedObject<ICacheService>
    
    Returns:
    
    the service name for this object.
  - getDistributedObjectName
```
protected String getDistributedObjectName()
```
    Overrides:
    
    getDistributedObjectName in class AbstractDistributedObject<ICacheService>
  - getName
```
public String getName()
```
    Description copied from interface: DistributedObject
    
    Returns the unique name for this DistributedObject. The returned value will never be null. The suggested way for getting name is retrieving it through DistributedObjectUtil.getName(DistributedObject) because this might be also a PrefixedDistributedObject.
    
    Specified by:
    
    getName in interface DistributedObject
    
    Returns:
    
    the unique name for this object.
  - getPrefixedName
```
public String getPrefixedName()
```
    Description copied from interface: PrefixedDistributedObject
    
    Returns the unique prefixed name for this DistributedObject. The returned value will never be null.
    
    Specified by:
    
    getPrefixedName in interface PrefixedDistributedObject
    
    Returns:
    
    the unique prefixed name for this object.
  - ensureOpen
```
protected void ensureOpen()
```
  - close
```
public void close()
```
  - preDestroy
```
protected boolean preDestroy()
```
    Overrides:
    
    preDestroy in class AbstractDistributedObject<ICacheService>
  - isClosed
```
public boolean isClosed()
```
  - isDestroyed
```
public boolean isDestroyed()
```
  - open
```
public void open()
```
  - submitLoadAllTask
```
protected void submitLoadAllTask(com.hazelcast.cache.impl.AbstractCacheProxyBase.LoadAllTask loadAllTask)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class AbstractDistributedObject<ICacheService>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AbstractDistributedObject<ICacheService>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractDistributedObject<ICacheService>

Class CacheProxy<K,V>

ICache implementation

Nested Class Summary

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

Field Summary

Fields inherited from class com.hazelcast.spi.AbstractDistributedObject

Method Summary

Methods inherited from class com.hazelcast.spi.AbstractDistributedObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.hazelcast.cache.impl.ICacheInternal

Methods inherited from interface com.hazelcast.cache.ICache

Methods inherited from interface javax.cache.Cache

Methods inherited from interface java.lang.Iterable

Methods inherited from interface com.hazelcast.core.PrefixedDistributedObject

Methods inherited from interface com.hazelcast.core.DistributedObject

Field Detail

logger

cacheConfig

name

nameWithPrefix

cacheService

serializationService

operationProvider

partitionService

Method Detail

get

getAll

containsKey

loadAll

put

getAndPut

putAll

putIfAbsent

remove

remove

getAndRemove

replace

replace

getAndReplace

removeAll

removeAll

clear

getConfiguration

invoke

invokeAll

unwrap

registerCacheEntryListener

registerCacheEntryListener

deregisterCacheEntryListener

updateCacheListenerConfigOnOtherNodes

iterator

iterator

iterator

addPartitionLostListener

removePartitionLostListener

getAsync

getAsync

putAsync

putAsync

putIfAbsentAsync

putIfAbsentAsync

getAndPutAsync

getAndPutAsync

removeAsync

removeAsync

getAndRemoveAsync

replaceAsync

replaceAsync

replaceAsync

replaceAsync

getAndReplaceAsync

getAndReplaceAsync

get

getAll

put

getAndPut

putAll

putIfAbsent

replace

replace