ClientMapProxy (Hazelcast Root 3.8.8 API)

java.lang.Object
- com.hazelcast.client.spi.ClientProxy
- - com.hazelcast.client.proxy.ClientMapProxy<K,V>

Type Parameters:

K - key

V - value

All Implemented Interfaces:

BaseMap<K,V>, DistributedObject, IMap<K,V>, LegacyAsyncMap<K,V>, ConcurrentMap<K,V>, Map<K,V>

Direct Known Subclasses:

NearCachedClientMapProxy
```
public class ClientMapProxy<K,V>
extends ClientProxy
implements IMap<K,V>
```
Proxy implementation of IMap.

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`NULL_AGGREGATOR_IS_NOT_ALLOWED`
`protected static String`	`NULL_KEY_IS_NOT_ALLOWED`
`protected static String`	`NULL_LISTENER_IS_NOT_ALLOWED`
`protected static String`	`NULL_PREDICATE_IS_NOT_ALLOWED`
`protected static String`	`NULL_VALUE_IS_NOT_ALLOWED`

Fields inherited from class com.hazelcast.client.spi.ClientProxy
name

Constructor Summary

Constructors
Constructor and Description

ClientMapProxy(String serviceName, String name)

Constructors
Constructor and Description
`ClientMapProxy(String serviceName, String name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`addEntryListener(EntryListener listener, boolean includeValue)` Adds an entry listener for this map.
`String`	`addEntryListener(EntryListener listener, K key, boolean includeValue)` Adds the specified entry listener for the specified key.
`String`	`addEntryListener(EntryListener listener, Predicate<K,V> predicate, boolean includeValue)` Adds an continuous entry listener for this map.
`String`	`addEntryListener(EntryListener listener, Predicate<K,V> predicate, K key, boolean includeValue)` Adds an continuous entry listener for this map.
`String`	`addEntryListener(MapListener listener, boolean includeValue)` Adds a `MapListener` for this map.
`String`	`addEntryListener(MapListener listener, K key, boolean includeValue)` Adds a `MapListener` for this map.
`String`	`addEntryListener(MapListener listener, Predicate<K,V> predicate, boolean includeValue)` Adds a `MapListener` for this map.
`String`	`addEntryListener(MapListener listener, Predicate<K,V> predicate, K key, boolean includeValue)` Adds a `MapListener` for this map.
`void`	`addIndex(String attribute, boolean ordered)` Adds an index to this map for the specified entries so that queries can run faster.
`String`	`addInterceptor(MapInterceptor interceptor)` Adds an interceptor for this map.
`String`	`addLocalEntryListener(EntryListener listener)` Adds a local entry listener for this map.
`String`	`addLocalEntryListener(EntryListener listener, Predicate<K,V> predicate, boolean includeValue)` Adds a local entry listener for this map.
`String`	`addLocalEntryListener(EntryListener listener, Predicate<K,V> predicate, K key, boolean includeValue)` Adds a local entry listener for this map.
`String`	`addLocalEntryListener(MapListener listener)` Adds a `MapListener` for this map.
`String`	`addLocalEntryListener(MapListener listener, Predicate<K,V> predicate, boolean includeValue)` Adds a `MapListener` for this map.
`String`	`addLocalEntryListener(MapListener listener, Predicate<K,V> predicate, K key, boolean includeValue)` Adds a local entry listener for this map.
`String`	`addPartitionLostListener(MapPartitionLostListener listener)` Adds a MapPartitionLostListener.
`<R> R`	`aggregate(Aggregator<Map.Entry<K,V>,R> aggregator)` Applies the aggregation logic on all map entries and returns the result
`<R> R`	`aggregate(Aggregator<Map.Entry<K,V>,R> aggregator, Predicate<K,V> predicate)` Applies the aggregation logic on map entries filtered with the Predicated and returns the result
`<SuppliedValue,Result> Result`	`aggregate(Supplier<K,V,SuppliedValue> supplier, Aggregation<K,SuppliedValue,Result> aggregation)` Executes a predefined aggregation on the maps data set.
`<SuppliedValue,Result> Result`	`aggregate(Supplier<K,V,SuppliedValue> supplier, Aggregation<K,SuppliedValue,Result> aggregation, JobTracker jobTracker)` Executes a predefined aggregation on the maps data set.
`void`	`clear()` This method clears the map and invokes `MapStore.deleteAll(java.util.Collection<K>)`deleteAll on MapStore which, if connected to a database, will delete the records from that database.
`boolean`	`containsKey(Object key)` Returns `true` if this map contains an entry for the specified key.
`protected boolean`	`containsKeyInternal(Data keyData)`
`boolean`	`containsValue(Object value)`
`void`	`delete(Object key)` Removes the mapping for a key from this map if it is present (optional operation).
`protected void`	`deleteInternal(Data keyData)`
`Set<Map.Entry<K,V>>`	`entrySet()` Returns a `Set` clone of the mappings contained in this map.
`Set<Map.Entry<K,V>>`	`entrySet(Predicate predicate)` Queries the map based on the specified predicate and returns the matching entries.
`Set<Map.Entry<K,V>>`	`entrySetWithPagingPredicate(PagingPredicate pagingPredicate)`
`boolean`	`evict(K key)` Evicts the specified key from this map.
`void`	`evictAll()` Evicts all keys from this map except the locked ones.
`protected boolean`	`evictInternal(Data keyData)`
`Map<K,Object>`	`executeOnEntries(EntryProcessor entryProcessor)` Applies the user defined EntryProcessor to the all entries in the map.
`Map<K,Object>`	`executeOnEntries(EntryProcessor entryProcessor, Predicate predicate)` Applies the user defined EntryProcessor to the entries in the map which satisfies provided predicate.
`Object`	`executeOnKey(K key, EntryProcessor entryProcessor)` Applies the user defined EntryProcessor to the entry mapped by the key.
`Object`	`executeOnKeyInternal(Data keyData, EntryProcessor entryProcessor)`
`Map<K,Object>`	`executeOnKeys(Set<K> keys, EntryProcessor entryProcessor)` Applies the user defined EntryProcessor to the entries mapped by the collection of keys.
`void`	`flush()` If this map has a MapStore, this method flushes all the local dirty entries by calling MapStore.storeAll() and/or MapStore.deleteAll().
`void`	`forceUnlock(K key)` Releases the lock for the specified key regardless of the lock owner.
`V`	`get(Object key)` Returns the value for the specified key, or `null` if this map does not contain this key.
`Map<K,V>`	`getAll(Set<K> keys)` Returns the entries for the given keys.
`protected List<com.hazelcast.client.impl.protocol.codec.MapGetAllCodec.ResponseParameters>`	`getAllInternal(Map<Integer,List<Data>> partitionToKeyData, Map<K,V> result)`
`ICompletableFuture<V>`	`getAsync(K key)` Asynchronously gets the given key.
`protected ICompletableFuture<V>`	`getAsyncInternal(Data keyData)`
`EntryView<K,V>`	`getEntryView(K key)` Returns the `EntryView` for the specified key.
`protected Object`	`getInternal(Data keyData)`
`LocalMapStats`	`getLocalMapStats()` Returns LocalMapStats for this map.
`QueryCache<K,V>`	`getQueryCache(String name)` Returns corresponding `QueryCache` instance for the supplied `name` or null.
`QueryCache<K,V>`	`getQueryCache(String name, MapListener listener, Predicate<K,V> predicate, boolean includeValue)` Creates an always up to date snapshot of this `IMap` according to the supplied parameters.
`QueryCache<K,V>`	`getQueryCache(String name, Predicate<K,V> predicate, boolean includeValue)` Creates an always up to date snapshot of this `IMap` according to the supplied parameters.
`ClientQueryCacheContext`	`getQueryCacheContext()`
`protected long`	`getTimeInMillis(long time, TimeUnit timeunit)`
`boolean`	`isEmpty()` Returns `true` if this map contains no entries.
`boolean`	`isLocked(K key)` Checks the lock for the specified key.
`Iterator<Map.Entry<K,V>>`	`iterator(int fetchSize, int partitionId, boolean prefetchValues)`
`Set<K>`	`keySet()` Returns a set clone of the keys contained in this map.
`Set<K>`	`keySet(Predicate predicate)` Queries the map based on the specified predicate and returns the keys of matching entries.
`void`	`loadAll(boolean replaceExistingValues)` Loads all keys into the store.
`void`	`loadAll(Set<K> keys, boolean replaceExistingValues)` Loads the given keys.
`protected void`	`loadAllInternal(boolean replaceExistingValues, Collection<Data> dataKeys)`
`Set<K>`	`localKeySet()` Returns the locally owned set of keys.
`Set<K>`	`localKeySet(Predicate predicate)` Returns the keys of matching locally owned entries.
`void`	`lock(K key)` Acquires the lock for the specified key.
`void`	`lock(K key, long leaseTime, TimeUnit timeUnit)` Acquires the lock for the specified key for the specified lease time.
`protected void`	`onDestroy()` Called before proxy is destroyed.
`protected void`	`onInitialize()` Called when proxy is created.
`protected Map<K,Object>`	`prepareResult(Collection<Map.Entry<Data,Data>> entries)`
`<R> Collection<R>`	`project(Projection<Map.Entry<K,V>,R> projection)` Applies the projection logic on all map entries and returns the result
`<R> Collection<R>`	`project(Projection<Map.Entry<K,V>,R> projection, Predicate<K,V> predicate)` Applies the projection logic on map entries filtered with the Predicated and returns the result
`V`	`put(K key, V value)` Associates the specified value with the specified key in this map.
`V`	`put(K key, V value, long ttl, TimeUnit timeunit)` Puts an entry into this map with a given ttl (time to live) value.
`void`	`putAll(Map<? extends K,? extends V> m)`
`protected void`	`putAllInternal(Map<Integer,List<Map.Entry<Data,Data>>> entryMap)`
`ICompletableFuture<V>`	`putAsync(K key, V value)` Asynchronously puts the given key and value.
`ICompletableFuture<V>`	`putAsync(K key, V value, long ttl, TimeUnit timeunit)` Asynchronously puts the given key and value into this map with a given ttl (time to live) value.
`protected ICompletableFuture<V>`	`putAsyncInternal(long ttl, TimeUnit timeunit, Data keyData, Data valueData)`
`V`	`putIfAbsent(K key, V value)` If the specified key is not already associated with a value, associate it with the given value.
`V`	`putIfAbsent(K key, V value, long ttl, TimeUnit timeunit)` Puts an entry into this map with a given ttl (time to live) value if the specified key is not already associated with a value.
`protected V`	`putIfAbsentInternal(long ttl, TimeUnit timeunit, Data keyData, Data valueData)`
`protected V`	`putInternal(long ttl, TimeUnit timeunit, Data keyData, Data valueData)`
`void`	`putTransient(K key, V value, long ttl, TimeUnit timeunit)` Same as `#put(K, V, long, java.util.concurrent.TimeUnit)` except that MapStore, if defined, will not be called to store/persist the entry.
`protected void`	`putTransientInternal(long ttl, TimeUnit timeunit, Data keyData, Data valueData)`
`V`	`remove(Object key)` Removes the mapping for a key from this map if it is present.
`boolean`	`remove(Object key, Object value)` Removes the entry for a key only if currently mapped to a given value.
`void`	`removeAll(Predicate<K,V> predicate)` Removes all entries which match with the supplied predicate.
`protected void`	`removeAllInternal(Predicate predicate)`
`ICompletableFuture<V>`	`removeAsync(K key)` Asynchronously removes the given key, returning an `ICompletableFuture` on which the caller can provide an `ExecutionCallback` to be invoked upon remove operation completion or block waiting for the operation to complete with `Future.get()`.
`protected ICompletableFuture<V>`	`removeAsyncInternal(Data keyData)`
`boolean`	`removeEntryListener(String registrationId)` Removes the specified entry listener.
`void`	`removeInterceptor(String id)` Removes the given interceptor for this map so it will not intercept operations anymore.
`protected com.hazelcast.client.impl.protocol.codec.MapRemoveCodec.ResponseParameters`	`removeInternal(Data keyData)`
`protected boolean`	`removeInternal(Data keyData, Data valueData)`
`boolean`	`removePartitionLostListener(String registrationId)` Removes the specified map partition lost listener.
`V`	`replace(K key, V value)` Replaces the entry for a key only if it is currently mapped to some value.
`boolean`	`replace(K key, V oldValue, V newValue)` Replaces the entry for a key only if currently mapped to a given value.
`protected boolean`	`replaceIfSameInternal(Data keyData, Data oldValueData, Data newValueData)`
`protected V`	`replaceInternal(Data keyData, Data valueData)`
`void`	`set(K key, V value)` Puts an entry into this map.
`void`	`set(K key, V value, long ttl, TimeUnit timeunit)` Puts an entry into this map with a given ttl (time to live) value.
`ICompletableFuture<Void>`	`setAsync(K key, V value)` Asynchronously puts the given key and value.
`ICompletableFuture<Void>`	`setAsync(K key, V value, long ttl, TimeUnit timeunit)` Asynchronously puts the given key and value into this map with a given ttl (time to live) value.
`protected ICompletableFuture<Void>`	`setAsyncInternal(long ttl, TimeUnit timeunit, Data keyData, Data valueData)`
`protected void`	`setInternal(long ttl, TimeUnit timeunit, Data keyData, Data valueData)`
`int`	`size()` Returns the number of entries in this map.
`ICompletableFuture`	`submitToKey(K key, EntryProcessor entryProcessor)` Applies the user defined EntryProcessor to the entry mapped by the key.
`void`	`submitToKey(K key, EntryProcessor entryProcessor, ExecutionCallback callback)` Applies the user defined EntryProcessor to the entry mapped by the key with specified ExecutionCallback to listen event status and returns immediately.
`ICompletableFuture`	`submitToKeyInternal(Data keyData, EntryProcessor entryProcessor)`
`void`	`submitToKeyInternal(Data keyData, EntryProcessor entryProcessor, ExecutionCallback callback)`
`String`	`toString()`
`boolean`	`tryLock(K key)` Tries to acquire the lock for the specified key.
`boolean`	`tryLock(K key, long time, TimeUnit timeunit)` Tries to acquire the lock for the specified key.
`boolean`	`tryLock(K key, long time, TimeUnit timeunit, long leaseTime, TimeUnit leaseUnit)` Tries to acquire the lock for the specified key for the specified lease time.
`boolean`	`tryPut(K key, V value, long timeout, TimeUnit timeunit)` Tries to put the given key and value into this map within a specified timeout value.
`protected boolean`	`tryPutInternal(long timeout, TimeUnit timeunit, Data keyData, Data valueData)`
`boolean`	`tryRemove(K key, long timeout, TimeUnit timeunit)` Tries to remove the entry with the given key from this map within the specified timeout value.
`protected boolean`	`tryRemoveInternal(long timeout, TimeUnit timeunit, Data keyData)`
`void`	`unlock(K key)` Releases the lock for the specified key.
`Collection<V>`	`values()` Returns a collection clone of the values contained in this map.
`Collection<V>`	`values(Predicate predicate)` Queries the map based on the specified predicate and returns the values of matching entries.

Methods inherited from class com.hazelcast.client.spi.ClientProxy
deregisterListener, destroy, equals, getClient, getConnectedServerVersion, getContext, getDistributedObjectName, getId, getName, getPartitionKey, getSerializationService, getServiceName, hashCode, invoke, invoke, invokeOnAddress, invokeOnPartition, invokeOnPartitionInterruptibly, onShutdown, postDestroy, preDestroy, registerListener, setContext, toData, toObject

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

Methods inherited from interface java.util.concurrent.ConcurrentMap
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, replaceAll

Methods inherited from interface java.util.Map
equals, hashCode

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

- Field Detail
  - NULL_LISTENER_IS_NOT_ALLOWED
```
protected static final String NULL_LISTENER_IS_NOT_ALLOWED
```
    See Also:
    
    Constant Field Values
  - NULL_KEY_IS_NOT_ALLOWED
```
protected static final String NULL_KEY_IS_NOT_ALLOWED
```
    See Also:
    
    Constant Field Values
  - NULL_VALUE_IS_NOT_ALLOWED
```
protected static final String NULL_VALUE_IS_NOT_ALLOWED
```
    See Also:
    
    Constant Field Values
  - NULL_PREDICATE_IS_NOT_ALLOWED
```
protected static final String NULL_PREDICATE_IS_NOT_ALLOWED
```
    See Also:
    
    Constant Field Values
  - NULL_AGGREGATOR_IS_NOT_ALLOWED
```
protected static final String NULL_AGGREGATOR_IS_NOT_ALLOWED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ClientMapProxy
```
public ClientMapProxy(String serviceName,
                      String name)
```
- Method Detail
  - onInitialize
```
protected void onInitialize()
```
    Description copied from class: ClientProxy
    
    Called when proxy is created. Overriding implementations can add initialization specific logic into this method like registering a listener, creating a cleanup task etc.
    
    Overrides:
    
    onInitialize in class ClientProxy
  - containsKey
```
public boolean containsKey(Object key)
```
    Description copied from interface: IMap
    
    Returns true if this map contains an entry for the specified key.
    
    Warning:
    
    ˆ This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class. The key will first be searched for in memory. If the key is not found, and if a key is attributed, a MapLoader will then attempt to load the key.
    
    Specified by:
    
    containsKey in interface BaseMap<K,V>
    
    Specified by:
    
    containsKey in interface IMap<K,V>
    
    Specified by:
    
    containsKey in interface Map<K,V>
    
    Parameters:
    
    key - The specified key.
    
    Returns:
    
    true if this map contains an entry for the specified key.
  - containsKeyInternal
```
protected boolean containsKeyInternal(Data keyData)
```
  - containsValue
```
public boolean containsValue(Object value)
```
    Description copied from interface: IMap
    
    Specified by:
    
    containsValue in interface IMap<K,V>
    
    Specified by:
    
    containsValue in interface Map<K,V>
  - get
```
public V get(Object key)
```
    Description copied from interface: IMap
    Returns the value for the specified key, or null if this map does not contain this key.
    
    Warning:
    
    This method returns a clone of the original value, so modifying the returned value does not change the actual value in the map. You should put the modified value back to make changes visible to all nodes.
```
      V value = map.get(key);
      value.updateSomeProperty();
      map.put(key, value);
 
```
    Warning-2:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    Specified by:
    
    get in interface BaseMap<K,V>
    
    Specified by:
    
    get in interface IMap<K,V>
    
    Specified by:
    
    get in interface Map<K,V>
    
    Parameters:
    
    key - The specified key.
    
    Returns:
    
    The value for the specified key.
  - getInternal
```
protected Object getInternal(Data keyData)
```
  - put
```
public V put(K key,
             V value)
```
    Description copied from interface: IMap
    
    Associates the specified value with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
    
    Warning:
    
    This method returns a clone of the previous value, not the original (identically equal) value previously put into the map.
    
    Warning-2:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Specified by:
    
    put in interface BaseMap<K,V>
    
    Specified by:
    
    put in interface IMap<K,V>
    
    Specified by:
    
    put in interface Map<K,V>
    
    Parameters:
    
    key - The specified key.
    
    value - The value to associate with the key.
    
    Returns:
    
    Previous value associated with key or null if there was no mapping for key.
  - remove
```
public V remove(Object key)
```
    Description copied from interface: IMap
    
    Removes the mapping for a key from this map if it is present.
    The map will not contain a mapping for the specified key once the call returns.
    
    Warning:
    
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Warning-2:
    
    This method returns a clone of the previous value, not the original (identically equal) value previously put into the map.
    
    Specified by:
    
    remove in interface BaseMap<K,V>
    
    Specified by:
    
    remove in interface IMap<K,V>
    
    Specified by:
    
    remove in interface Map<K,V>
    
    Parameters:
    
    key - Remove the mapping for this key.
    
    Returns:
    
    The previous value associated with key, or null if there was no mapping for key.
  - removeInternal
```
protected com.hazelcast.client.impl.protocol.codec.MapRemoveCodec.ResponseParameters removeInternal(Data keyData)
```
  - remove
```
public boolean remove(Object key,
                      Object value)
```
    Description copied from interface: IMap
    Removes the entry for a key only if currently mapped to a given value. This is equivalent to
```
   if (map.containsKey(key) && map.get(key).equals(value)) {
       map.remove(key);
       return true;
   } else return false;
```
    except that the action is performed atomically.
    
    Warning:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    Specified by:
    
    remove in interface BaseMap<K,V>
    
    Specified by:
    
    remove in interface IMap<K,V>
    
    Specified by:
    
    remove in interface ConcurrentMap<K,V>
    
    Specified by:
    
    remove in interface Map<K,V>
    
    Parameters:
    
    key - The specified key.
    
    value - Remove the key if it has this value.
    
    Returns:
    
    true if the value was removed.
  - removeInternal
```
protected boolean removeInternal(Data keyData,
                                 Data valueData)
```
  - removeAll
```
public void removeAll(Predicate<K,V> predicate)
```
    Description copied from interface: IMap
    
    Removes all entries which match with the supplied predicate. If this map has index, matching entries will be found via index search, otherwise they will be found by full-scan. Note that calling this method also removes all entries from callers near cache.
    
    Specified by:
    
    removeAll in interface IMap<K,V>
    
    Parameters:
    
    predicate - matching entries with this predicate will be removed from this map
  - removeAllInternal
```
protected void removeAllInternal(Predicate predicate)
```
  - delete
```
public void delete(Object key)
```
    Description copied from interface: IMap
    
    Removes the mapping for a key from this map if it is present (optional operation).
    
    Unlike IMap.remove(Object), this operation does not return the removed value, which avoids the serialization cost of the returned value.
    If the removed value will not be used, a delete operation is preferred over a remove operation for better performance.
    
    The map will not contain a mapping for the specified key once the call returns.
    
    Warning:
    This method breaks the contract of EntryListener. When an entry is removed by delete(), it fires an EntryEvent with a null oldValue.
    Also, a listener with predicates will have null values, so only keys can be queried via predicates.
    
    Specified by:
    
    delete in interface BaseMap<K,V>
    
    Specified by:
    
    delete in interface IMap<K,V>
    
    Parameters:
    
    key - key whose mapping is to be removed from the map.
  - deleteInternal
```
protected void deleteInternal(Data keyData)
```
  - flush
```
public void flush()
```
    Description copied from interface: IMap
    
    If this map has a MapStore, this method flushes all the local dirty entries by calling MapStore.storeAll() and/or MapStore.deleteAll().
    
    Specified by:
    
    flush in interface IMap<K,V>
  - getAsync
```
public ICompletableFuture<V> getAsync(K key)
```
    Description copied from interface: IMap
    Asynchronously gets the given key.
```
 ICompletableFuture future = map.getAsync(key);
 // do some other stuff, when ready get the result.
 Object value = future.get();
 
```
    Future.get() will block until the actual map.get() completes. If the application requires timely response, then Future.get(long, TimeUnit) can be used.
```
 try {
   ICompletableFuture future = map.getAsync(key);
   Object value = future.get(40, TimeUnit.MILLISECOND);
 }
 catch (TimeoutException t) {
 // time wasn't enough
 }
 
```
    Additionally, the client can schedule an ExecutionCallback to be invoked upon completion of the ICompletableFuture via ICompletableFuture.andThen(ExecutionCallback) or ICompletableFuture.andThen(ExecutionCallback, Executor):
```
     // assuming a IMap<String, String>
     ICompletableFuture<String> future = map.getAsync("a");
     future.andThen(new ExecutionCallback<String>() {
         public void onResponse(String response) {
             // do something with value in response
         }

         public void onFailure(Throwable t) {
             // handle failure
         }
     });
 
```
    ExecutionException is never thrown.
    
    Warning:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    Specified by:
    
    getAsync in interface IMap<K,V>
    
    Specified by:
    
    getAsync in interface LegacyAsyncMap<K,V>
    
    Parameters:
    
    key - the key of the map entry.
    
    Returns:
    
    ICompletableFuture from which the value of the key can be retrieved.
    
    See Also:
    
    ICompletableFuture
  - getAsyncInternal
```
protected ICompletableFuture<V> getAsyncInternal(Data keyData)
```
  - putAsync
```
public ICompletableFuture<V> putAsync(K key,
                                      V value)
```
    Description copied from interface: IMap
    Asynchronously puts the given key and value.
```
 ICompletableFuture future = map.putAsync(key, value);
 // do some other stuff, when ready get the result.
 Object oldValue = future.get();
 
```
    ICompletableFuture.get() will block until the actual map.put() completes. If the application requires a timely response, then you can use Future.get(timeout, timeunit).
```
 try {
   ICompletableFuture future = map.putAsync(key, newValue);
   Object oldValue = future.get(40, TimeUnit.MILLISECOND);
 }
 catch (TimeoutException t) {
 // time wasn't enough
 }
 
```
    Additionally, the client can schedule an ExecutionCallback to be invoked upon completion of the ICompletableFuture via ICompletableFuture.andThen(ExecutionCallback) or ICompletableFuture.andThen(ExecutionCallback, Executor):
```
     // assuming a IMap<String, String>
     ICompletableFuture<String> future = map.putAsync("a", "b");
     future.andThen(new ExecutionCallback<String>() {
         public void onResponse(String response) {
             // do something with the old value returned by put operation
         }

         public void onFailure(Throwable t) {
             // handle failure
         }
     });
 
```
    ExecutionException is never thrown.
    
    Warning:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    Specified by:
    
    putAsync in interface IMap<K,V>
    
    Specified by:
    
    putAsync in interface LegacyAsyncMap<K,V>
    
    Parameters:
    
    key - the key of the map entry.
    
    value - the new value of the map entry.
    
    Returns:
    
    ICompletableFuture from which the old value of the key can be retrieved.
    
    See Also:
    
    ICompletableFuture
  - putAsync
```
public ICompletableFuture<V> putAsync(K key,
                                      V value,
                                      long ttl,
                                      TimeUnit timeunit)
```
    Description copied from interface: IMap
    Asynchronously puts the given key and value into this map with a given ttl (time to live) value. Entry will expire and get evicted after the ttl. If ttl is 0, then the entry lives forever.
```
 ICompletableFuture future = map.putAsync(key, value, ttl, timeunit);
 // do some other stuff, when ready get the result
 Object oldValue = future.get();
 
```
    ICompletableFuture.get() will block until the actual map.put() completes. If your application requires a timely response, then you can use Future.get(timeout, timeunit).
```
 try {
   ICompletableFuture future = map.putAsync(key, newValue, ttl, timeunit);
   Object oldValue = future.get(40, TimeUnit.MILLISECOND);
 }
 catch (TimeoutException t) {
   // time wasn't enough
 }
 
```
    The client can schedule an ExecutionCallback to be invoked upon completion of the ICompletableFuture via ICompletableFuture.andThen(ExecutionCallback) or ICompletableFuture.andThen(ExecutionCallback, Executor):
```
     // assuming a IMap<String, String>
     ICompletableFuture<String> future = map.putAsync("a", "b", 5, TimeUnit.MINUTES);
     future.andThen(new ExecutionCallback<String>() {
         public void onResponse(String response) {
             // do something with old value returned by put operation
         }

         public void onFailure(Throwable t) {
             // handle failure
         }
     });
 
```
    ExecutionException is never thrown.
    
    Warning 1:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Warning 2:
    Time resolution for TTL is seconds. The given TTL value is rounded to the next closest second value.
    Specified by:
    
    putAsync in interface IMap<K,V>
    
    Specified by:
    
    putAsync in interface LegacyAsyncMap<K,V>
    
    Parameters:
    
    key - the key of the map entry.
    
    value - the new value of the map entry.
    
    ttl - maximum time for this entry to stay in the map. 0 means infinite.
    
    timeunit - time unit for the ttl.
    
    Returns:
    
    ICompletableFuture from which the old value of the key can be retrieved.
    
    See Also:
    
    ICompletableFuture
  - putAsyncInternal
```
protected ICompletableFuture<V> putAsyncInternal(long ttl,
                                                 TimeUnit timeunit,
                                                 Data keyData,
                                                 Data valueData)
```
  - setAsync
```
public ICompletableFuture<Void> setAsync(K key,
                                         V value)
```
    Description copied from interface: IMap
    Asynchronously puts the given key and value. the entry lives forever. Similar to the put operation except that set doesn't return the old value, which is more efficient.
```
 ICompletableFuture<Void> future = map.setAsync(key, value);
 // do some other stuff, when ready wait for completion
 future.get();
 
```
    ICompletableFuture.get() will block until the actual map.set() operation completes. If your application requires a timely response, then you can use ICompletableFuture.get(timeout, timeunit).
```
 try {
     ICompletableFuture<Void> future = map.setAsync(key, newValue);
     future.get(40, TimeUnit.MILLISECOND);
 }
 catch (TimeoutException t) {
     // time wasn't enough
 }
 
```
    You can also schedule an ExecutionCallback to be invoked upon completion of the ICompletableFuture via ICompletableFuture.andThen(ExecutionCallback) or ICompletableFuture.andThen(ExecutionCallback, Executor):
```
     ICompletableFuture<Void> future = map.setAsync("a", "b");
     future.andThen(new ExecutionCallback<String>() {
         public void onResponse(Void response) {
             // Set operation was completed
         }

         public void onFailure(Throwable t) {
             // handle failure
         }
     });
 
```
    ExecutionException is never thrown.
    
    Warning 1:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    Specified by:
    
    setAsync in interface IMap<K,V>
    
    Specified by:
    
    setAsync in interface LegacyAsyncMap<K,V>
    
    Parameters:
    
    key - the key of the map entry.
    
    value - the new value of the map entry.
    
    Returns:
    
    ICompletableFuture on which to block waiting for the operation to complete or register an ExecutionCallback to be invoked upon completion.
    
    See Also:
    
    ICompletableFuture
  - setAsync
```
public ICompletableFuture<Void> setAsync(K key,
                                         V value,
                                         long ttl,
                                         TimeUnit timeunit)
```
    Description copied from interface: IMap
    Asynchronously puts the given key and value into this map with a given ttl (time to live) value. Entry will expire and get evicted after the ttl. If ttl is 0, then the entry lives forever. Similar to the put operation except that set doesn't return the old value, which is more efficient.
```
     ICompletableFuture<Void> future = map.setAsync(key, value, ttl, timeunit);
     // do some other stuff, when you want to make sure set operation is complete:
     future.get();
 
```
    ICompletableFuture.get() will block until the actual map set operation completes. If your application requires a timely response, then you can use Future.get(long, TimeUnit).
```
 try {
     ICompletableFuture future = map.setAsync(key, newValue, ttl, timeunit);
     future.get(40, TimeUnit.MILLISECOND);
 }
 catch (TimeoutException t) {
     // time wasn't enough
 }
 
```
    You can also schedule an ExecutionCallback to be invoked upon completion of the ICompletableFuture via ICompletableFuture.andThen(ExecutionCallback) or ICompletableFuture.andThen(ExecutionCallback, Executor):
```
     ICompletableFuture<Void> future = map.setAsync("a", "b", 5, TimeUnit.MINUTES);
     future.andThen(new ExecutionCallback<String>() {
         public void onResponse(Void response) {
             // Set operation was completed
         }

         public void onFailure(Throwable t) {
             // handle failure
         }
     });
 
```
    ExecutionException is never thrown.
    
    Warning 1:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Warning 2:
    Time resolution for TTL is seconds. The given TTL value is rounded to the next closest second value.
    Specified by:
    
    setAsync in interface IMap<K,V>
    
    Specified by:
    
    setAsync in interface LegacyAsyncMap<K,V>
    
    Parameters:
    
    key - the key of the map entry.
    
    value - the new value of the map entry.
    
    ttl - maximum time for this entry to stay in the map. 0 means infinite.
    
    timeunit - time unit for the ttl.
    
    Returns:
    
    ICompletableFuture on which client code can block waiting for the operation to complete or provide an ExecutionCallback to be invoked upon set operation completion.
    
    See Also:
    
    ICompletableFuture
  - setAsyncInternal
```
protected ICompletableFuture<Void> setAsyncInternal(long ttl,
                                                    TimeUnit timeunit,
                                                    Data keyData,
                                                    Data valueData)
```
  - removeAsync
```
public ICompletableFuture<V> removeAsync(K key)
```
    Description copied from interface: IMap
    
    Asynchronously removes the given key, returning an ICompletableFuture on which the caller can provide an ExecutionCallback to be invoked upon remove operation completion or block waiting for the operation to complete with Future.get().
    
    Warning:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Specified by:
    
    removeAsync in interface IMap<K,V>
    
    Specified by:
    
    removeAsync in interface LegacyAsyncMap<K,V>
    
    Parameters:
    
    key - The key of the map entry to remove.
    
    Returns:
    
    ICompletableFuture from which the value removed from the map can be retrieved.
    
    See Also:
    
    ICompletableFuture
  - removeAsyncInternal
```
protected ICompletableFuture<V> removeAsyncInternal(Data keyData)
```
  - tryRemove
```
public boolean tryRemove(K key,
                         long timeout,
                         TimeUnit timeunit)
```
    Description copied from interface: IMap
    
    Tries to remove the entry with the given key from this map within the specified timeout value. If the key is already locked by another thread and/or member, then this operation will wait the timeout amount for acquiring the lock.
    
    Warning:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Specified by:
    
    tryRemove in interface IMap<K,V>
    
    Parameters:
    
    key - key of the entry.
    
    timeout - maximum time to wait for acquiring the lock for the key.
    
    timeunit - time unit for the timeout.
    
    Returns:
    
    true if the remove is successful, false otherwise.
  - tryRemoveInternal
```
protected boolean tryRemoveInternal(long timeout,
                                    TimeUnit timeunit,
                                    Data keyData)
```
  - tryPut
```
public boolean tryPut(K key,
                      V value,
                      long timeout,
                      TimeUnit timeunit)
```
    Description copied from interface: IMap
    
    Tries to put the given key and value into this map within a specified timeout value. If this method returns false, it means that the caller thread could not acquire the lock for the key within the timeout duration, thus the put operation is not successful.
    
    Warning:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Specified by:
    
    tryPut in interface IMap<K,V>
    
    Parameters:
    
    key - key of the entry.
    
    value - value of the entry.
    
    timeout - maximum time to wait.
    
    timeunit - time unit for the timeout.
    
    Returns:
    
    true if the put is successful, false otherwise.
  - tryPutInternal
```
protected boolean tryPutInternal(long timeout,
                                 TimeUnit timeunit,
                                 Data keyData,
                                 Data valueData)
```
  - put
```
public V put(K key,
             V value,
             long ttl,
             TimeUnit timeunit)
```
    Description copied from interface: IMap
    
    Puts an entry into this map with a given ttl (time to live) value. Entry will expire and get evicted after the ttl. If ttl is 0, then the entry lives forever.
    
    Warning:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Warning-2:
    
    This method returns a clone of the previous value, not the original (identically equal) value previously put into the map.
    
    Warning 3:
    Time resolution for TTL is seconds. The given TTL value is rounded to the next closest second value.
    
    Specified by:
    
    put in interface IMap<K,V>
    
    Parameters:
    
    key - key of the entry
    
    value - value of the entry
    
    ttl - maximum time for this entry to stay in the map 0 means infinite.
    
    timeunit - time unit for the ttl
    
    Returns:
    
    old value of the entry
  - putInternal
```
protected V putInternal(long ttl,
                        TimeUnit timeunit,
                        Data keyData,
                        Data valueData)
```
  - putTransient
```
public void putTransient(K key,
                         V value,
                         long ttl,
                         TimeUnit timeunit)
```
    Description copied from interface: IMap
    
    Same as #put(K, V, long, java.util.concurrent.TimeUnit) except that MapStore, if defined, will not be called to store/persist the entry. If ttl is 0, then the entry lives forever.
    
    Warning 1:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Warning 2:
    Time resolution for TTL is seconds. The given TTL value is rounded to next closest second value.
    
    Specified by:
    
    putTransient in interface IMap<K,V>
    
    Parameters:
    
    key - key of the entry
    
    value - value of the entry
    
    ttl - maximum time for this entry to stay in the map. 0 means infinite.
    
    timeunit - time unit for the ttl
  - putTransientInternal
```
protected void putTransientInternal(long ttl,
                                    TimeUnit timeunit,
                                    Data keyData,
                                    Data valueData)
```
  - putIfAbsent
```
public V putIfAbsent(K key,
                     V value)
```
    Description copied from interface: IMap
    If the specified key is not already associated with a value, associate it with the given value. This is equivalent to
```
   if (!map.containsKey(key))
       return map.put(key, value);
   else
       return map.get(key);
```
    except that the action is performed atomically.
    
    Note:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    Also, this method returns a clone of the previous value, not the original (identically equal) value previously put into the map.
    Specified by:
    
    putIfAbsent in interface BaseMap<K,V>
    
    Specified by:
    
    putIfAbsent in interface IMap<K,V>
    
    Specified by:
    
    putIfAbsent in interface ConcurrentMap<K,V>
    
    Specified by:
    
    putIfAbsent in interface Map<K,V>
    
    Parameters:
    
    key - The specified key.
    
    value - The value to associate with the key when there is no previous value.
    
    Returns:
    
    a clone of the previous value.
  - putIfAbsent
```
public V putIfAbsent(K key,
                     V value,
                     long ttl,
                     TimeUnit timeunit)
```
    Description copied from interface: IMap
    
    Puts an entry into this map with a given ttl (time to live) value if the specified key is not already associated with a value. Entry will expire and get evicted after the ttl.
    
    Warning:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Warning-2:
    
    This method returns a clone of the previous value, not the original (identically equal) value previously put into the map.
    
    Warning 3:
    Time resolution for TTL is seconds. The given TTL value is rounded to the next closest second value.
    
    Specified by:
    
    putIfAbsent in interface IMap<K,V>
    
    Parameters:
    
    key - key of the entry.
    
    value - value of the entry.
    
    ttl - maximum time for this entry to stay in the map.
    
    timeunit - time unit for the ttl.
    
    Returns:
    
    old value of the entry.
  - putIfAbsentInternal
```
protected V putIfAbsentInternal(long ttl,
                                TimeUnit timeunit,
                                Data keyData,
                                Data valueData)
```
  - replace
```
public boolean replace(K key,
                       V oldValue,
                       V newValue)
```
    Description copied from interface: IMap
    Replaces the entry for a key only if currently mapped to a given value. This is equivalent to
```
   if (map.containsKey(key) && map.get(key).equals(oldValue)) {
       map.put(key, newValue);
       return true;
   } else return false;
```
    except that the action is performed atomically.
    
    Warning:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    Specified by:
    
    replace in interface BaseMap<K,V>
    
    Specified by:
    
    replace in interface IMap<K,V>
    
    Specified by:
    
    replace in interface ConcurrentMap<K,V>
    
    Specified by:
    
    replace in interface Map<K,V>
    
    Parameters:
    
    key - The specified key.
    
    oldValue - Replace the key value if it is the old value.
    
    newValue - The new value to replace the old value.
    
    Returns:
    
    true if the value was replaced.
  - replaceIfSameInternal
```
protected boolean replaceIfSameInternal(Data keyData,
                                        Data oldValueData,
                                        Data newValueData)
```
  - replace
```
public V replace(K key,
                 V value)
```
    Description copied from interface: IMap
    Replaces the entry for a key only if it is currently mapped to some value. This is equivalent to
```
   if (map.containsKey(key)) {
       return map.put(key, value);
   } else return null;
```
    except that the action is performed atomically.
    
    Warning:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Warning-2:
    
    This method returns a clone of the previous value, not the original (identically equal) value previously put into the map.
    Specified by:
    
    replace in interface BaseMap<K,V>
    
    Specified by:
    
    replace in interface IMap<K,V>
    
    Specified by:
    
    replace in interface ConcurrentMap<K,V>
    
    Specified by:
    
    replace in interface Map<K,V>
    
    Parameters:
    
    key - The specified key.
    
    value - The value to replace the previous value.
    
    Returns:
    
    The previous value associated with key, or null if there was no mapping for key.
  - replaceInternal
```
protected V replaceInternal(Data keyData,
                            Data valueData)
```
  - set
```
public void set(K key,
                V value,
                long ttl,
                TimeUnit timeunit)
```
    Description copied from interface: IMap
    
    Puts an entry into this map with a given ttl (time to live) value. Entry will expire and get evicted after the ttl. If ttl is 0, then the entry lives forever. Similar to the put operation except that set doesn't return the old value, which is more efficient.
    
    Warning 1:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Warning 2:
    Time resolution for TTL is seconds. The given TTL value is rounded to the next closest second value.
    
    Specified by:
    
    set in interface IMap<K,V>
    
    Parameters:
    
    key - key of the entry
    
    value - value of the entry
    
    ttl - maximum time for this entry to stay in the map 0 means infinite.
    
    timeunit - time unit for the ttl
  - setInternal
```
protected void setInternal(long ttl,
                           TimeUnit timeunit,
                           Data keyData,
                           Data valueData)
```
  - lock
```
public void lock(K key)
```
    Description copied from interface: IMap
    
    Acquires the lock for the specified key.
    If the lock is not available, then the current thread becomes disabled for thread scheduling purposes and lies dormant until the lock has been acquired.
    You get a lock whether the value is present in the map or not. Other threads (possibly on other systems) would block on their invoke of lock() until the non-existent key is unlocked. If the lock holder introduces the key to the map, the put() operation is not blocked. If a thread not holding a lock on the non-existent key tries to introduce the key while a lock exists on the non-existent key, the put() operation blocks until it is unlocked.
    Scope of the lock is this map only. Acquired lock is only for the key in this map.
    Locks are re-entrant so if the key is locked N times then it should be unlocked N times before another thread can acquire it.
    There is no lock timeout on this method. Locks will be held infinitely.
    Warning:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Specified by:
    
    lock in interface IMap<K,V>
    
    Parameters:
    
    key - key to lock.
  - lock
```
public void lock(K key,
                 long leaseTime,
                 TimeUnit timeUnit)
```
    Description copied from interface: IMap
    
    Acquires the lock for the specified key for the specified lease time.
    After lease time, the lock will be released.
    
    If the lock is not available, then the current thread becomes disabled for thread scheduling purposes and lies dormant until the lock has been acquired.
    Scope of the lock is this map only. Acquired lock is only for the key in this map.
    Locks are re-entrant, so if the key is locked N times then it should be unlocked N times before another thread can acquire it.
    
    Warning:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Specified by:
    
    lock in interface IMap<K,V>
    
    Parameters:
    
    key - the key to lock.
    
    leaseTime - time to wait before releasing the lock.
    
    timeUnit - unit of time to specify lease time.
  - isLocked
```
public boolean isLocked(K key)
```
    Description copied from interface: IMap
    
    Checks the lock for the specified key.
    If the lock is acquired then returns true, else returns false.
    
    Warning:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Specified by:
    
    isLocked in interface IMap<K,V>
    
    Parameters:
    
    key - the key that is checked for lock.
    
    Returns:
    
    true if lock is acquired, false otherwise.
  - tryLock
```
public boolean tryLock(K key)
```
    Description copied from interface: IMap
    
    Tries to acquire the lock for the specified key.
    If the lock is not available then the current thread doesn't wait and returns false immediately.
    
    Warning:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Specified by:
    
    tryLock in interface IMap<K,V>
    
    Parameters:
    
    key - the key to lock.
    
    Returns:
    
    true if lock is acquired, false otherwise.
  - tryLock
```
public boolean tryLock(K key,
                       long time,
                       TimeUnit timeunit)
                throws InterruptedException
```
    Description copied from interface: IMap
    Tries to acquire the lock for the specified key.
    If the lock is not available, then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of two things happens:
    - the lock is acquired by the current thread, or
    - the specified waiting time elapses.
    Warning:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    Specified by:
    
    tryLock in interface IMap<K,V>
    
    Parameters:
    
    key - key to lock in this map.
    
    time - maximum time to wait for the lock.
    
    timeunit - time unit of the time argument.
    
    Returns:
    
    true if the lock was acquired and false if the waiting time elapsed before the lock was acquired.
    
    Throws:
    
    InterruptedException
  - tryLock
```
public boolean tryLock(K key,
                       long time,
                       TimeUnit timeunit,
                       long leaseTime,
                       TimeUnit leaseUnit)
                throws InterruptedException
```
    Description copied from interface: IMap
    Tries to acquire the lock for the specified key for the specified lease time.
    After lease time, the lock will be released.
    
    If the lock is not available, then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of two things happens:
    - the lock is acquired by the current thread, or
    - the specified waiting time elapses.
    Warning:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    Specified by:
    
    tryLock in interface IMap<K,V>
    
    Parameters:
    
    key - key to lock in this map.
    
    time - maximum time to wait for the lock.
    
    timeunit - time unit of the time argument.
    
    leaseTime - time to wait before releasing the lock.
    
    leaseUnit - unit of time to specify lease time.
    
    Returns:
    
    true if the lock was acquired and false if the waiting time elapsed before the lock was acquired.
    
    Throws:
    
    InterruptedException
  - unlock
```
public void unlock(K key)
```
    Description copied from interface: IMap
    
    Releases the lock for the specified key. It never blocks and returns immediately.
    
    If the current thread is the holder of this lock, then the hold count is decremented. If the hold count is zero, then the lock is released. If the current thread is not the holder of this lock, then IllegalMonitorStateException is thrown.
    
    Warning:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Specified by:
    
    unlock in interface IMap<K,V>
    
    Parameters:
    
    key - the key to lock.
  - forceUnlock
```
public void forceUnlock(K key)
```
    Description copied from interface: IMap
    
    Releases the lock for the specified key regardless of the lock owner. It always successfully unlocks the key, never blocks, and returns immediately.
    
    Warning:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Specified by:
    
    forceUnlock in interface IMap<K,V>
    
    Parameters:
    
    key - the key to lock.
  - addLocalEntryListener
```
public String addLocalEntryListener(MapListener listener)
```
    Description copied from interface: IMap
    
    Adds a MapListener for this map. To receive an event, you should implement a corresponding MapListener sub-interface for that event.
    Note that entries in distributed map are partitioned across the cluster members; each member owns and manages the some portion of the entries. Owned entries are called local entries. This listener will be listening for the events of local entries. Let's say your cluster has member1 and member2. On member2 you added a local listener and from member1, you call map.put(key2, value2). If the key2 is owned by member2 then the local listener will be notified for the add/update event. Also note that entries can migrate to other nodes for load balancing and/or membership change.
    
    Specified by:
    
    addLocalEntryListener in interface IMap<K,V>
    
    Parameters:
    
    listener - MapListener for this map.
    
    Returns:
    
    A UUID.randomUUID().toString() which is used as a key to remove the listener.
    
    See Also:
    
    IMap.localKeySet(), MapListener
  - addLocalEntryListener
```
public String addLocalEntryListener(EntryListener listener)
```
    Description copied from interface: IMap
    
    Adds a local entry listener for this map. The added listener will only be listening for the events (add/remove/update/evict) of the locally owned entries.
    Note that entries in distributed map are partitioned across the cluster members; each member owns and manages the some portion of the entries. Owned entries are called local entries. This listener will be listening for the events of local entries. Let's say your cluster has member1 and member2. On member2 you added a local listener and from member1, you call map.put(key2, value2). If the key2 is owned by member2 then the local listener will be notified for the add/update event. Also note that entries can migrate to other nodes for load balancing and/or membership change.
    
    Specified by:
    
    addLocalEntryListener in interface IMap<K,V>
    
    Parameters:
    
    listener - entry listener.
    
    Returns:
    
    A UUID.randomUUID().toString() which is used as a key to remove the listener.
    
    See Also:
    
    IMap.localKeySet()
  - addLocalEntryListener
```
public String addLocalEntryListener(MapListener listener,
                                    Predicate<K,V> predicate,
                                    boolean includeValue)
```
    Description copied from interface: IMap
    
    Adds a MapListener for this map. To receive an event, you should implement a corresponding MapListener sub-interface for that event. Listener will get notified for map events filtered by the given predicate.
    
    Specified by:
    
    addLocalEntryListener in interface IMap<K,V>
    
    Parameters:
    
    listener - MapListener for this map.
    
    predicate - predicate for filtering entries
    
    includeValue - true if EntryEvent should contain the value.
    
    Returns:
    
    A UUID.randomUUID().toString() which is used as a key to remove the listener.
    
    See Also:
    
    MapListener
  - addLocalEntryListener
```
public String addLocalEntryListener(EntryListener listener,
                                    Predicate<K,V> predicate,
                                    boolean includeValue)
```
    Description copied from interface: IMap
    
    Adds a local entry listener for this map. The added listener will only be listening for the events (add/remove/update/evict) of the locally owned entries. Listener will get notified for map add/remove/update/evict events filtered by the given predicate.
    
    Specified by:
    
    addLocalEntryListener in interface IMap<K,V>
    
    Parameters:
    
    listener - entry listener
    
    predicate - predicate for filtering entries
    
    includeValue - true if EntryEvent should contain the value.
    
    Returns:
    
    A UUID.randomUUID().toString() which is used as a key to remove the listener.
  - addLocalEntryListener
```
public String addLocalEntryListener(MapListener listener,
                                    Predicate<K,V> predicate,
                                    K key,
                                    boolean includeValue)
```
    Description copied from interface: IMap
    
    Adds a local entry listener for this map. The added listener will only be listening for the events (add/remove/update/evict) of the locally owned entries. Listener will get notified for map add/remove/update/evict events filtered by the given predicate.
    
    Specified by:
    
    addLocalEntryListener in interface IMap<K,V>
    
    Parameters:
    
    listener - MapListener for this map.
    
    predicate - predicate for filtering entries.
    
    key - key to listen for.
    
    includeValue - true if EntryEvent should contain the value.
    
    Returns:
    
    A UUID.randomUUID().toString() which is used as a key to remove the listener.
    
    See Also:
    
    MapListener
  - addLocalEntryListener
```
public String addLocalEntryListener(EntryListener listener,
                                    Predicate<K,V> predicate,
                                    K key,
                                    boolean includeValue)
```
    Description copied from interface: IMap
    
    Adds a local entry listener for this map. The added listener will only be listening for the events (add/remove/update/evict) of the locally owned entries. Listener will get notified for map add/remove/update/evict events filtered by the given predicate.
    
    Specified by:
    
    addLocalEntryListener in interface IMap<K,V>
    
    Parameters:
    
    listener - entry listener.
    
    predicate - predicate for filtering entries.
    
    key - key to listen for.
    
    includeValue - true if EntryEvent should contain the value.
    
    Returns:
    
    A UUID.randomUUID().toString() which is used as a key to remove the listener.
  - addInterceptor
```
public String addInterceptor(MapInterceptor interceptor)
```
    Description copied from interface: IMap
    
    Adds an interceptor for this map. Added interceptor will intercept operations and execute user defined methods and will cancel operations if user defined method throw exception.
    
    Specified by:
    
    addInterceptor in interface IMap<K,V>
    
    Parameters:
    
    interceptor - map interceptor.
    
    Returns:
    
    id of registered interceptor.
  - removeInterceptor
```
public void removeInterceptor(String id)
```
    Description copied from interface: IMap
    
    Removes the given interceptor for this map so it will not intercept operations anymore.
    
    Specified by:
    
    removeInterceptor in interface IMap<K,V>
    
    Parameters:
    
    id - registration id of the map interceptor.
  - addEntryListener
```
public String addEntryListener(MapListener listener,
                               boolean includeValue)
```
    Description copied from interface: IMap
    
    Adds a MapListener for this map. To receive an event, you should implement a corresponding MapListener sub-interface for that event.
    
    Specified by:
    
    addEntryListener in interface IMap<K,V>
    
    Parameters:
    
    listener - MapListener for this map.
    
    includeValue - true if EntryEvent should contain the value.
    
    Returns:
    
    A UUID.randomUUID().toString() which is used as a key to remove the listener.
    
    See Also:
    
    MapListener
  - addEntryListener
```
public String addEntryListener(EntryListener listener,
                               boolean includeValue)
```
    Description copied from interface: IMap
    
    Adds an entry listener for this map. Listener will get notified for all map add/remove/update/evict events.
    
    Specified by:
    
    addEntryListener in interface IMap<K,V>
    
    Parameters:
    
    listener - the added entry listener for this map.
    
    includeValue - true if EntryEvent should contain the value.
    
    Returns:
    
    A UUID.randomUUID().toString() which is used as a key to remove the listener.
  - removeEntryListener
```
public boolean removeEntryListener(String registrationId)
```
    Description copied from interface: IMap
    
    Removes the specified entry listener. Returns silently if there is no such listener added before.
    
    Specified by:
    
    removeEntryListener in interface IMap<K,V>
    
    Parameters:
    
    registrationId - id of registered listener.
    
    Returns:
    
    true if registration is removed, false otherwise.
  - addPartitionLostListener
```
public String addPartitionLostListener(MapPartitionLostListener listener)
```
    Description copied from interface: IMap
    
    Adds a MapPartitionLostListener.
    The addPartitionLostListener returns a register-id. This id is needed to remove the MapPartitionLostListener using the IMap.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 map partition lost events due to design limitations.
    
    Specified by:
    
    addPartitionLostListener in interface IMap<K,V>
    
    Parameters:
    
    listener - the added MapPartitionLostListener.
    
    Returns:
    
    returns the registration id for the MapPartitionLostListener.
    
    See Also:
    
    IMap.removePartitionLostListener(String)
  - removePartitionLostListener
```
public boolean removePartitionLostListener(String registrationId)
```
    Description copied from interface: IMap
    
    Removes the specified map partition lost listener. Returns silently if there is no such listener added before.
    
    Specified by:
    
    removePartitionLostListener in interface IMap<K,V>
    
    Parameters:
    
    registrationId - id of registered listener.
    
    Returns:
    
    true if registration is removed, false otherwise.
  - addEntryListener
```
public String addEntryListener(MapListener listener,
                               K key,
                               boolean includeValue)
```
    Description copied from interface: IMap
    
    Adds a MapListener for this map. To receive an event, you should implement a corresponding MapListener sub-interface for that event.
    
    Warning:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Specified by:
    
    addEntryListener in interface IMap<K,V>
    
    Parameters:
    
    listener - MapListener for this map.
    
    key - key to listen for.
    
    includeValue - true if EntryEvent should contain the value.
    
    Returns:
    
    A UUID.randomUUID().toString() which is used as a key to remove the listener.
    
    See Also:
    
    MapListener
  - addEntryListener
```
public String addEntryListener(EntryListener listener,
                               K key,
                               boolean includeValue)
```
    Description copied from interface: IMap
    
    Adds the specified entry listener for the specified key. The listener will get notified for all add/remove/update/evict events of the specified key only.
    
    Warning:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Specified by:
    
    addEntryListener in interface IMap<K,V>
    
    Parameters:
    
    listener - specified entry listener.
    
    key - key to listen for.
    
    includeValue - true if EntryEvent should contain the value.
    
    Returns:
    
    A UUID.randomUUID().toString() which is used as a key to remove the listener.
  - addEntryListener
```
public String addEntryListener(MapListener listener,
                               Predicate<K,V> predicate,
                               K key,
                               boolean includeValue)
```
    Description copied from interface: IMap
    
    Adds a MapListener for this map. To receive an event, you should implement a corresponding MapListener sub-interface for that event.
    
    Specified by:
    
    addEntryListener in interface IMap<K,V>
    
    Parameters:
    
    listener - the continuous MapListener for this map.
    
    predicate - predicate for filtering entries.
    
    key - key to listen for.
    
    includeValue - true if EntryEvent should contain the value.
    
    Returns:
    
    A UUID.randomUUID().toString() which is used as a key to remove the listener.
    
    See Also:
    
    MapListener
  - addEntryListener
```
public String addEntryListener(EntryListener listener,
                               Predicate<K,V> predicate,
                               K key,
                               boolean includeValue)
```
    Description copied from interface: IMap
    
    Adds an continuous entry listener for this map. Listener will get notified for map add/remove/update/evict events filtered by the given predicate.
    
    Specified by:
    
    addEntryListener in interface IMap<K,V>
    
    Parameters:
    
    listener - the continuous entry listener for this map.
    
    predicate - predicate for filtering entries.
    
    key - key to listen for.
    
    includeValue - true if EntryEvent should contain the value.
    
    Returns:
    
    A UUID.randomUUID().toString() which is used as a key to remove the listener.
  - addEntryListener
```
public String addEntryListener(MapListener listener,
                               Predicate<K,V> predicate,
                               boolean includeValue)
```
    Description copied from interface: IMap
    
    Adds a MapListener for this map. To receive an event, you should implement a corresponding MapListener sub-interface for that event.
    
    Specified by:
    
    addEntryListener in interface IMap<K,V>
    
    Parameters:
    
    listener - the added continuous MapListener for this map.
    
    predicate - predicate for filtering entries.
    
    includeValue - true if EntryEvent should contain the value.
    
    Returns:
    
    A UUID.randomUUID().toString() which is used as a key to remove the listener.
    
    See Also:
    
    MapListener
  - addEntryListener
```
public String addEntryListener(EntryListener listener,
                               Predicate<K,V> predicate,
                               boolean includeValue)
```
    Description copied from interface: IMap
    
    Adds an continuous entry listener for this map. Listener will get notified for map add/remove/update/evict events filtered by the given predicate.
    
    Specified by:
    
    addEntryListener in interface IMap<K,V>
    
    Parameters:
    
    listener - the added continuous entry listener for this map.
    
    predicate - predicate for filtering entries.
    
    includeValue - true if EntryEvent should contain the value.
    
    Returns:
    
    A UUID.randomUUID().toString() which is used as a key to remove the listener.
  - getEntryView
```
public EntryView<K,V> getEntryView(K key)
```
    Description copied from interface: IMap
    
    Returns the EntryView for the specified key.
    
    Warning:
    
    This method returns a clone of original mapping, modifying the returned value does not change the actual value in the map. One should put modified value back to make changes visible to all nodes.
    
    Warning-2:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Specified by:
    
    getEntryView in interface IMap<K,V>
    
    Parameters:
    
    key - the key of the entry.
    
    Returns:
    
    EntryView of the specified key.
    
    See Also:
    
    EntryView
  - evict
```
public boolean evict(K key)
```
    Description copied from interface: IMap
    
    Evicts the specified key from this map. If a MapStore is defined for this map, then the entry is not deleted from the underlying MapStore, evict only removes the entry from the memory.
    
    Warning:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Specified by:
    
    evict in interface IMap<K,V>
    
    Parameters:
    
    key - the specified key to evict from this map.
    
    Returns:
    
    true if the key is evicted, false otherwise.
  - evictInternal
```
protected boolean evictInternal(Data keyData)
```
  - evictAll
```
public void evictAll()
```
    Description copied from interface: IMap
    
    Evicts all keys from this map except the locked ones.
    If a MapStore is defined for this map, deleteAll is not called by this method. If you do want to deleteAll to be called use the IMap.clear() method.
    The EVICT_ALL event is fired for any registered listeners. See MapEvictedListener.mapEvicted(MapEvent) .
    
    Specified by:
    
    evictAll in interface IMap<K,V>
    
    See Also:
    
    IMap.clear()
  - loadAll
```
public void loadAll(boolean replaceExistingValues)
```
    Description copied from interface: IMap
    
    Loads all keys into the store. This is a batch load operation so that an implementation can optimize the multiple loads.
    
    Specified by:
    
    loadAll in interface IMap<K,V>
    
    Parameters:
    
    replaceExistingValues - when true, existing values in the Map will be replaced by those loaded from the MapLoader void loadAll(boolean replaceExistingValues));
  - loadAll
```
public void loadAll(Set<K> keys,
                    boolean replaceExistingValues)
```
    Description copied from interface: IMap
    
    Loads the given keys. This is a batch load operation so that an implementation can optimize the multiple loads.
    
    Specified by:
    
    loadAll in interface IMap<K,V>
    
    Parameters:
    
    keys - keys of the values entries to load.
    
    replaceExistingValues - when true, existing values in the Map will be replaced by those loaded from the MapLoader.
  - loadAllInternal
```
protected void loadAllInternal(boolean replaceExistingValues,
                               Collection<Data> dataKeys)
```
  - keySet
```
public Set<K> keySet()
```
    Description copied from interface: IMap
    
    Returns a set clone of the keys contained in this map.
    
    Warning:
    The set is NOT backed by the map, so changes to the map are NOT reflected in the set, and vice-versa.
    This method is always executed by a distributed query, so it may throw a QueryResultSizeExceededException if GroupProperty.QUERY_RESULT_SIZE_LIMIT is configured.
    
    Specified by:
    
    keySet in interface IMap<K,V>
    
    Specified by:
    
    keySet in interface Map<K,V>
    
    Returns:
    
    a set clone of the keys contained in this map.
    
    See Also:
    
    GroupProperty.QUERY_RESULT_SIZE_LIMIT
  - getAll
```
public Map<K,V> getAll(Set<K> keys)
```
    Description copied from interface: IMap
    
    Returns the entries for the given keys. If any keys are not present in the Map, it will call MapLoader.loadAll(java.util.Collection).
    
    Warning:
    The returned map is NOT backed by the original map, so changes to the original map are NOT reflected in the returned map, and vice-versa.
    
    Warning-2:
    This method uses hashCode and equals of the binary form of the keys, not the actual implementations of hashCode and equals defined in the key's class.
    
    Specified by:
    
    getAll in interface IMap<K,V>
    
    Parameters:
    
    keys - keys to get.
    
    Returns:
    
    map of entries.
  - getAllInternal
```
protected List<com.hazelcast.client.impl.protocol.codec.MapGetAllCodec.ResponseParameters> getAllInternal(Map<Integer,List<Data>> partitionToKeyData,
                                                                                                          Map<K,V> result)
```
  - values
```
public Collection<V> values()
```
    Description copied from interface: IMap
    
    Returns a collection clone of the values contained in this map.
    
    Warning:
    The collection is NOT backed by the map, so changes to the map are NOT reflected in the collection, and vice-versa.
    This method is always executed by a distributed query, so it may throw a QueryResultSizeExceededException if GroupProperty.QUERY_RESULT_SIZE_LIMIT is configured.
    
    Specified by:
    
    values in interface IMap<K,V>
    
    Specified by:
    
    values in interface Map<K,V>
    
    Returns:
    
    a collection clone of the values contained in this map
    
    See Also:
    
    GroupProperty.QUERY_RESULT_SIZE_LIMIT
  - entrySet
```
public Set<Map.Entry<K,V>> entrySet()
```
    Description copied from interface: IMap
    
    Returns a Set clone of the mappings contained in this map.
    
    Warning:
    The set is NOT backed by the map, so changes to the map are NOT reflected in the set, and vice-versa.
    This method is always executed by a distributed query, so it may throw a QueryResultSizeExceededException if GroupProperty.QUERY_RESULT_SIZE_LIMIT is configured.
    
    Specified by:
    
    entrySet in interface IMap<K,V>
    
    Specified by:
    
    entrySet in interface Map<K,V>
    
    Returns:
    
    a set clone of the keys mappings in this map
    
    See Also:
    
    GroupProperty.QUERY_RESULT_SIZE_LIMIT
  - keySet
```
public Set<K> keySet(Predicate predicate)
```
    Description copied from interface: IMap
    
    Queries the map based on the specified predicate and returns the keys of matching entries.
    Specified predicate runs on all members in parallel.
    
    Warning:
    The set is NOT backed by the map, so changes to the map are NOT reflected in the set, and vice-versa.
    This method is always executed by a distributed query, so it may throw a QueryResultSizeExceededException if GroupProperty.QUERY_RESULT_SIZE_LIMIT is configured.
    
    Specified by:
    
    keySet in interface IMap<K,V>
    
    Parameters:
    
    predicate - specified query criteria.
    
    Returns:
    
    result key set of the query.
    
    See Also:
    
    GroupProperty.QUERY_RESULT_SIZE_LIMIT
  - entrySet
```
public Set<Map.Entry<K,V>> entrySet(Predicate predicate)
```
    Description copied from interface: IMap
    
    Queries the map based on the specified predicate and returns the matching entries.
    Specified predicate runs on all members in parallel.
    
    Warning:
    The set is NOT backed by the map, so changes to the map are NOT reflected in the set, and vice-versa.
    This method is always executed by a distributed query, so it may throw a QueryResultSizeExceededException if GroupProperty.QUERY_RESULT_SIZE_LIMIT is configured.
    
    Specified by:
    
    entrySet in interface IMap<K,V>
    
    Parameters:
    
    predicate - specified query criteria.
    
    Returns:
    
    result entry set of the query.
    
    See Also:
    
    GroupProperty.QUERY_RESULT_SIZE_LIMIT
  - entrySetWithPagingPredicate
```
public Set<Map.Entry<K,V>> entrySetWithPagingPredicate(PagingPredicate pagingPredicate)
```
  - values
```
public Collection<V> values(Predicate predicate)
```
    Description copied from interface: IMap
    
    Queries the map based on the specified predicate and returns the values of matching entries.
    Specified predicate runs on all members in parallel.
    
    Warning:
    The collection is NOT backed by the map, so changes to the map are NOT reflected in the collection, and vice-versa.
    This method is always executed by a distributed query, so it may throw a QueryResultSizeExceededException if GroupProperty.QUERY_RESULT_SIZE_LIMIT is configured.
    
    Specified by:
    
    values in interface IMap<K,V>
    
    Parameters:
    
    predicate - specified query criteria.
    
    Returns:
    
    result value collection of the query.
    
    See Also:
    
    GroupProperty.QUERY_RESULT_SIZE_LIMIT
  - localKeySet
```
public Set<K> localKeySet()
```
    Description copied from interface: IMap
    
    Returns the locally owned set of keys.
    Each key in this map is owned and managed by a specific member in the cluster.
    Note that ownership of these keys might change over time so that key ownerships can be almost evenly distributed in the cluster.
    
    Warning:
    The set is NOT backed by the map, so changes to the map are NOT reflected in the set, and vice-versa.
    This method is always executed by a distributed query, so it may throw a QueryResultSizeExceededException if GroupProperty.QUERY_RESULT_SIZE_LIMIT is configured.
    
    Specified by:
    
    localKeySet in interface IMap<K,V>
    
    Returns:
    
    locally owned keys.
    
    See Also:
    
    GroupProperty.QUERY_RESULT_SIZE_LIMIT
  - localKeySet
```
public Set<K> localKeySet(Predicate predicate)
```
    Description copied from interface: IMap
    
    Returns the keys of matching locally owned entries.
    Each key in this map is owned and managed by a specific member in the cluster.
    Note that ownership of these keys might change over time so that key ownerships can be almost evenly distributed in the cluster.
    
    Warning:
    The set is NOT backed by the map, so changes to the map are NOT reflected in the set, and vice-versa.
    This method is always executed by a distributed query, so it may throw a QueryResultSizeExceededException if GroupProperty.QUERY_RESULT_SIZE_LIMIT is configured.
    
    Specified by:
    
    localKeySet in interface IMap<K,V>
    
    Parameters:
    
    predicate - specified query criteria.
    
    Returns:
    
    keys of matching locally owned entries.
    
    See Also:
    
    GroupProperty.QUERY_RESULT_SIZE_LIMIT
  - addIndex
```
public void addIndex(String attribute,
                     boolean ordered)
```
    Description copied from interface: IMap
    Adds an index to this map for the specified entries so that queries can run faster.
    Let's say your map values are Employee objects.
```
   public class Employee implements Serializable {
       private boolean active = false;
       private int age;
       private String name = null;
       // other fields.

       // getters setter

   }
 
```
    If you are querying your values mostly based on age and active then you should consider indexing these fields.
```
   IMap imap = Hazelcast.getMap("employees");
   imap.addIndex("age", true);        // ordered, since we have ranged queries for this field
   imap.addIndex("active", false);    // not ordered, because boolean field cannot have range
 
```
    Index attribute should either have a getter method or be public. You should also make sure to add the indexes before adding entries to this map.
    
    Time to Index
    Indexing time is executed in parallel on each partition by operation threads. The Map is not blocked during this operation.
    The time taken in proportional to the size of the Map and the number Members.
    
    Searches while indexes are being built
    Until the index finishes being created, any searches for the attribute will use a full Map scan, thus avoiding using a partially built index and returning incorrect results.
    Specified by:
    
    addIndex in interface IMap<K,V>
    
    Parameters:
    
    attribute - index attribute of value
    
    ordered - true if index should be ordered, false otherwise.
  - getLocalMapStats
```
public LocalMapStats getLocalMapStats()
```
    Description copied from interface: IMap
    
    Returns LocalMapStats for this map. LocalMapStats is the statistics for the local portion of this distributed map and contains information such as ownedEntryCount backupEntryCount, lastUpdateTime, lockedEntryCount.
    Since this stats are only for the local portion of this map, if you need the cluster-wide MapStats then you need to get the LocalMapStats from all members of the cluster and combine them.
    
    Specified by:
    
    getLocalMapStats in interface IMap<K,V>
    
    Returns:
    
    this map's local statistics.
  - executeOnKey
```
public Object executeOnKey(K key,
                           EntryProcessor entryProcessor)
```
    Description copied from interface: IMap
    
    Applies the user defined EntryProcessor to the entry mapped by the key. Returns the the object which is result of the process() method of EntryProcessor.
    The EntryProcessor may implement the Offloadable and ReadOnly interfaces. If the EntryProcessor implements the Offloadable interface the processing will be offloaded to the given ExecutorService allowing unblocking the partition-thread, which means that other partition-operations may proceed. The key will be locked for the time-span of the processing in order to not generate a write-conflict. In this case the threading looks as follows: 1.) partition-thread (fetch & lock) 2.) execution-thread (process) 3.) partition-thread (set & unlock, or just unlock if no changes) If the EntryProcessor implements the Offloadable and ReadOnly interfaces the processing will be offloaded to the given ExecutorService allowing unblocking the partition-thread. Since the EntryProcessor is not supposed to do any changes to the Entry the key will NOT be locked for the time-span of the processing. In this case the threading looks as follows: 1.) partition-thread (fetch & lock) 2.) execution-thread (process) In this case the EntryProcessor.getBackupProcessor() has to return null; otherwise an IllegalArgumentException exception is thrown. If the EntryProcessor implements only ReadOnly without implementing Offloadable the processing unit will not be offloaded, however, the EntryProcessor will not wait for the lock to be acquired, since the EP will not do any modifications. Using offloading is useful if the EntryProcessor encompasses heavy logic that may stall the partition-thread. If the EntryProcessor implements ReadOnly and modifies the entry it is processing an UnsupportedOperationException will be thrown. Offloading will not be applied to backup partitions. It is possible to initialize the EntryBackupProcessor with some input provided by the EntryProcessor in the EntryProcessor.getBackupProcessor() method. The input allows providing context to the EntryBackupProcessor - for example the "delta" so that the EntryBackupProcessor does not have to calculate the "delta" but it may just apply it.
    
    Specified by:
    
    executeOnKey in interface IMap<K,V>
    
    Returns:
    
    result of entry process.
    
    See Also:
    
    Offloadable, ReadOnly
  - executeOnKeyInternal
```
public Object executeOnKeyInternal(Data keyData,
                                   EntryProcessor entryProcessor)
```
  - submitToKey
```
public void submitToKey(K key,
                        EntryProcessor entryProcessor,
                        ExecutionCallback callback)
```
    Description copied from interface: IMap
    
    Applies the user defined EntryProcessor to the entry mapped by the key with specified ExecutionCallback to listen event status and returns immediately. The EntryProcessor may implement the Offloadable and ReadOnly interfaces. If the EntryProcessor implements the Offloadable interface the processing will be offloaded to the given ExecutorService allowing unblocking the partition-thread, which means that other partition-operations may proceed. The key will be locked for the time-span of the processing in order to not generate a write-conflict. In this case the threading looks as follows: 1.) partition-thread (fetch & lock) 2.) execution-thread (process) 3.) partition-thread (set & unlock, or just unlock if no changes) If the EntryProcessor implements the Offloadable and ReadOnly interfaces the processing will be offloaded to the given ExecutorService allowing unblocking the partition-thread. Since the EntryProcessor is not supposed to do any changes to the Entry the key will NOT be locked for the time-span of the processing. In this case the threading looks as follows: 1.) partition-thread (fetch & lock) 2.) execution-thread (process) In this case the EntryProcessor.getBackupProcessor() has to return null; otherwise an IllegalArgumentException exception is thrown. If the EntryProcessor implements only ReadOnly without implementing Offloadable the processing unit will not be offloaded, however, the EntryProcessor will not wait for the lock to be acquired, since the EP will not do any modifications. If the EntryProcessor implements ReadOnly and modifies the entry it is processing an UnsupportedOperationException will be thrown. Using offloading is useful if the EntryProcessor encompasses heavy logic that may stall the partition-thread. Offloading will not be applied to backup partitions. It is possible to initialize the EntryBackupProcessor with some input provided by the EntryProcessor in the EntryProcessor.getBackupProcessor() method. The input allows providing context to the EntryBackupProcessor - for example the "delta" so that the EntryBackupProcessor does not have to calculate the "delta" but it may just apply it.
    
    Specified by:
    
    submitToKey in interface IMap<K,V>
    
    Parameters:
    
    key - key to be processed.
    
    entryProcessor - processor to process the key.
    
    callback - to listen whether operation is finished or not.
    
    See Also:
    
    Offloadable, ReadOnly
  - submitToKeyInternal
```
public void submitToKeyInternal(Data keyData,
                                EntryProcessor entryProcessor,
                                ExecutionCallback callback)
```
  - submitToKey
```
public ICompletableFuture submitToKey(K key,
                                      EntryProcessor entryProcessor)
```
    Description copied from interface: IMap
    
    Applies the user defined EntryProcessor to the entry mapped by the key. Returns immediately with a ICompletableFuture representing that task.
    EntryProcessor is not cancellable, so calling ICompletableFuture.cancel() method won't cancel the operation of EntryProcessor. The EntryProcessor may implement the Offloadable and ReadOnly interfaces. If the EntryProcessor implements the Offloadable interface the processing will be offloaded to the given ExecutorService allowing unblocking the partition-thread, which means that other partition-operations may proceed. The key will be locked for the time-span of the processing in order to not generate a write-conflict. In this case the threading looks as follows: 1.) partition-thread (fetch & lock) 2.) execution-thread (process) 3.) partition-thread (set & unlock, or just unlock if no changes) If the EntryProcessor implements the Offloadable and ReadOnly interfaces the processing will be offloaded to the given ExecutorService allowing unblocking the partition-thread. Since the EntryProcessor is not supposed to do any changes to the Entry the key will NOT be locked for the time-span of the processing. In this case the threading looks as follows: 1.) partition-thread (fetch & lock) 2.) execution-thread (process) In this case the EntryProcessor.getBackupProcessor() has to return null; otherwise an IllegalArgumentException exception is thrown. If the EntryProcessor implements only ReadOnly without implementing Offloadable the processing unit will not be offloaded, however, the EntryProcessor will not wait for the lock to be acquired, since the EP will not do any modifications. If the EntryProcessor implements ReadOnly and modifies the entry it is processing a UnsupportedOperationException will be thrown. Using offloading is useful if the EntryProcessor encompasses heavy logic that may stall the partition-thread. Offloading will not be applied to backup partitions. It is possible to initialize the EntryBackupProcessor with some input provided by the EntryProcessor in the EntryProcessor.getBackupProcessor() method. The input allows providing context to the EntryBackupProcessor - for example the "delta" so that the EntryBackupProcessor does not have to calculate the "delta" but it may just apply it.
    
    Specified by:
    
    submitToKey in interface IMap<K,V>
    
    Specified by:
    
    submitToKey in interface LegacyAsyncMap<K,V>
    
    Parameters:
    
    key - key to be processed
    
    entryProcessor - processor to process the key
    
    Returns:
    
    ICompletableFuture from which the result of the operation can be retrieved.
    
    See Also:
    
    Offloadable, ReadOnly, ICompletableFuture
  - submitToKeyInternal
```
public ICompletableFuture submitToKeyInternal(Data keyData,
                                              EntryProcessor entryProcessor)
```
  - executeOnEntries
```
public Map<K,Object> executeOnEntries(EntryProcessor entryProcessor)
```
    Description copied from interface: IMap
    
    Applies the user defined EntryProcessor to the all entries in the map. Returns the results mapped by each key in the map.
    
    Specified by:
    
    executeOnEntries in interface IMap<K,V>
  - prepareResult
```
protected Map<K,Object> prepareResult(Collection<Map.Entry<Data,Data>> entries)
```
  - executeOnEntries
```
public Map<K,Object> executeOnEntries(EntryProcessor entryProcessor,
                                      Predicate predicate)
```
    Description copied from interface: IMap
    
    Applies the user defined EntryProcessor to the entries in the map which satisfies provided predicate. Returns the results mapped by each key in the map.
    
    Specified by:
    
    executeOnEntries in interface IMap<K,V>
  - aggregate
```
public <R> R aggregate(Aggregator<Map.Entry<K,V>,R> aggregator)
```
    Description copied from interface: IMap
    
    Applies the aggregation logic on all map entries and returns the result
    Fast-Aggregations are the successor of the Map-Reduce Aggregators. They are equivalent to the Map-Reduce Aggregators in most of the use-cases, but instead of running on the Map-Reduce engine they run on the Query infrastructure. Their performance is tens to hundreds times better due to the fact that they run in parallel for each partition and are highly optimized for speed and low memory consumption.
    
    Specified by:
    
    aggregate in interface IMap<K,V>
    
    Type Parameters:
    
    R - type of the result
    
    Parameters:
    
    aggregator - aggregator to aggregate the entries with
    
    Returns:
    
    the result of the given type
  - aggregate
```
public <R> R aggregate(Aggregator<Map.Entry<K,V>,R> aggregator,
                       Predicate<K,V> predicate)
```
    Description copied from interface: IMap
    
    Applies the aggregation logic on map entries filtered with the Predicated and returns the result
    Fast-Aggregations are the successor of the Map-Reduce Aggregators. They are equivalent to the Map-Reduce Aggregators in most of the use-cases, but instead of running on the Map-Reduce engine they run on the Query infrastructure. Their performance is tens to hundreds times better due to the fact that they run in parallel for each partition and are highly optimized for speed and low memory consumption.
    
    Specified by:
    
    aggregate in interface IMap<K,V>
    
    Type Parameters:
    
    R - type of the result
    
    Parameters:
    
    aggregator - aggregator to aggregate the entries with
    
    predicate - predicate to filter the entries with
    
    Returns:
    
    the result of the given type
  - project
```
public <R> Collection<R> project(Projection<Map.Entry<K,V>,R> projection)
```
    Description copied from interface: IMap
    
    Applies the projection logic on all map entries and returns the result
    
    Specified by:
    
    project in interface IMap<K,V>
    
    Type Parameters:
    
    R - type of the result
    
    Parameters:
    
    projection - projection to transform the entries with. May return null.
    
    Returns:
    
    the result of the given type
  - project
```
public <R> Collection<R> project(Projection<Map.Entry<K,V>,R> projection,
                                 Predicate<K,V> predicate)
```
    Description copied from interface: IMap
    
    Applies the projection logic on map entries filtered with the Predicated and returns the result
    
    Specified by:
    
    project in interface IMap<K,V>
    
    Type Parameters:
    
    R - type of the result
    
    Parameters:
    
    projection - projection to transform the entries with. May return null.
    
    predicate - predicate to filter the entries with
    
    Returns:
    
    the result of the given type
  - aggregate
```
public <SuppliedValue,Result> Result aggregate(Supplier<K,V,SuppliedValue> supplier,
                                               Aggregation<K,SuppliedValue,Result> aggregation)
```
    Description copied from interface: IMap
    
    Executes a predefined aggregation on the maps data set. The Supplier is used to either select or to select and extract a (sub-)value. A predefined set of aggregations can be found in Aggregations.
    
    Specified by:
    
    aggregate in interface IMap<K,V>
    
    Type Parameters:
    
    SuppliedValue - the final type emitted from the supplier.
    
    Result - the resulting aggregation value type.
    
    Parameters:
    
    supplier - the supplier to select and / or extract a (sub-)value from the map.
    
    aggregation - the aggregation that is being executed against the map.
    
    Returns:
    
    the aggregated value.
  - aggregate
```
public <SuppliedValue,Result> Result aggregate(Supplier<K,V,SuppliedValue> supplier,
                                               Aggregation<K,SuppliedValue,Result> aggregation,
                                               JobTracker jobTracker)
```
    Description copied from interface: IMap
    
    Executes a predefined aggregation on the maps data set. The Supplier is used to either select or to select and extract a (sub-)value. A predefined set of aggregations can be found in Aggregations.
    
    Specified by:
    
    aggregate in interface IMap<K,V>
    
    Type Parameters:
    
    SuppliedValue - the final type emitted from the supplier.
    
    Result - the resulting aggregation value type.
    
    Parameters:
    
    supplier - the supplier to select and / or extract a (sub-)value from the map.
    
    aggregation - the aggregation that is being executed against the map.
    
    jobTracker - the JobTracker instance to execute the aggregation.
    
    Returns:
    
    the aggregated value
  - getQueryCache
```
public QueryCache<K,V> getQueryCache(String name)
```
    Description copied from interface: IMap
    
    Returns corresponding QueryCache instance for the supplied name or null.
    If there is a previously created QueryCache with the supplied name or if a declarative configuration exists for the supplied name this method returns or creates the instance respectively, otherwise returns null.
    
    Specified by:
    
    getQueryCache in interface IMap<K,V>
    
    Parameters:
    
    name - the name of QueryCache
    
    Returns:
    
    the QueryCache instance or null if there is no corresponding QueryCacheConfig
    
    See Also:
    
    QueryCache
  - getQueryCache
```
public QueryCache<K,V> getQueryCache(String name,
                                     Predicate<K,V> predicate,
                                     boolean includeValue)
```
    Description copied from interface: IMap
    
    Creates an always up to date snapshot of this IMap according to the supplied parameters.
    If there is a previously created QueryCache with the supplied name, this method returns that QueryCache and ignores predicate and includeValue parameters. Otherwise it creates and returns a new QueryCache instance.
    Also note that if there exists a QueryCacheConfig for the supplied name, predicate and includeValue parameters will overwrite corresponding ones in QueryCacheConfig.
    
    Specified by:
    
    getQueryCache in interface IMap<K,V>
    
    Parameters:
    
    name - the name of QueryCache
    
    predicate - the predicate for filtering entries
    
    includeValue - true if this QueryCache is allowed to cache values of entries, otherwise false
    
    Returns:
    
    the QueryCache instance with the supplied name
    
    See Also:
    
    QueryCache
  - getQueryCache
```
public QueryCache<K,V> getQueryCache(String name,
                                     MapListener listener,
                                     Predicate<K,V> predicate,
                                     boolean includeValue)
```
    Description copied from interface: IMap
    
    Creates an always up to date snapshot of this IMap according to the supplied parameters.
    If there is a previously created QueryCache with the supplied name, this method returns that QueryCache and ignores listener, predicate and includeValue parameters. Otherwise it creates and returns a new QueryCache instance.
    Also note that if there exists a QueryCacheConfig for the supplied name, listener,predicate and includeValue parameters will overwrite corresponding ones in QueryCacheConfig.
    
    Specified by:
    
    getQueryCache in interface IMap<K,V>
    
    Parameters:
    
    name - the name of QueryCache
    
    listener - the MapListener which will be used to listen this QueryCache
    
    predicate - the predicate for filtering entries
    
    includeValue - true if this QueryCache is allowed to cache values of entries, otherwise false
    
    Returns:
    
    the QueryCache instance with the supplied name
    
    See Also:
    
    QueryCache
  - executeOnKeys
```
public Map<K,Object> executeOnKeys(Set<K> keys,
                                   EntryProcessor entryProcessor)
```
    Description copied from interface: IMap
    
    Applies the user defined EntryProcessor to the entries mapped by the collection of keys. the results mapped by each key in the collection.
    
    Specified by:
    
    executeOnKeys in interface IMap<K,V>
    
    Returns:
    
    result of entry process.
  - set
```
public void set(K key,
                V value)
```
    Description copied from interface: IMap
    
    Puts an entry into this map. Similar to the put operation except that set doesn't return the old value, which is more efficient.
    
    Warning:
    This method breaks the contract of EntryListener. When an entry is updated by set(), it fires an EntryEvent with a null oldValue.
    
    Warning-2:
    This method uses hashCode and equals of the binary form of the key, not the actual implementations of hashCode and equals defined in the key's class.
    
    Specified by:
    
    set in interface BaseMap<K,V>
    
    Specified by:
    
    set in interface IMap<K,V>
    
    Parameters:
    
    key - key of the entry.
    
    value - value of the entry.
  - size
```
public int size()
```
    Description copied from interface: BaseMap
    
    Returns the number of entries in this map.
    
    Specified by:
    
    size in interface BaseMap<K,V>
    
    Specified by:
    
    size in interface Map<K,V>
    
    Returns:
    
    the number of entries in this map.
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: BaseMap
    
    Returns true if this map contains no entries.
    
    Specified by:
    
    isEmpty in interface BaseMap<K,V>
    
    Specified by:
    
    isEmpty in interface Map<K,V>
    
    Returns:
    
    true if this map contains no entries.
  - putAll
```
public void putAll(Map<? extends K,? extends V> m)
```
    Description copied from interface: IMap
    
    No atomicity guarantees are given. It could be that in case of failure some of the key/value-pairs get written, while others are not.
    
    Specified by:
    
    putAll in interface IMap<K,V>
    
    Specified by:
    
    putAll in interface Map<K,V>
  - putAllInternal
```
protected void putAllInternal(Map<Integer,List<Map.Entry<Data,Data>>> entryMap)
                       throws RuntimeException
```
    Throws:
    
    RuntimeException
  - clear
```
public void clear()
```
    Description copied from interface: IMap
    
    This method clears the map and invokes MapStore.deleteAll(java.util.Collection<K>)deleteAll on MapStore which, if connected to a database, will delete the records from that database.
    The MAP_CLEARED event is fired for any registered listeners. See MapClearedListener.mapCleared(MapEvent).
    To clear a map without calling MapStore.deleteAll(java.util.Collection<K>), use IMap.evictAll().
    
    Specified by:
    
    clear in interface IMap<K,V>
    
    Specified by:
    
    clear in interface Map<K,V>
    
    See Also:
    
    IMap.evictAll()
  - iterator
```
public Iterator<Map.Entry<K,V>> iterator(int fetchSize,
                                         int partitionId,
                                         boolean prefetchValues)
```
  - getTimeInMillis
```
protected long getTimeInMillis(long time,
                               TimeUnit timeunit)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getQueryCacheContext
```
public ClientQueryCacheContext getQueryCacheContext()
```
  - onDestroy
```
protected void onDestroy()
```
    Description copied from class: ClientProxy
    
    Called before proxy is destroyed. Overriding implementations should clean/release resources created during initialization.
    
    Overrides:
    
    onDestroy in class ClientProxy

Class ClientMapProxy<K,V>

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.hazelcast.client.spi.ClientProxy

Constructor Summary

Method Summary

Methods inherited from class com.hazelcast.client.spi.ClientProxy

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.concurrent.ConcurrentMap

Methods inherited from interface java.util.Map

Methods inherited from interface com.hazelcast.core.DistributedObject

Field Detail

NULL_LISTENER_IS_NOT_ALLOWED

NULL_KEY_IS_NOT_ALLOWED

NULL_VALUE_IS_NOT_ALLOWED

NULL_PREDICATE_IS_NOT_ALLOWED

NULL_AGGREGATOR_IS_NOT_ALLOWED

Constructor Detail

ClientMapProxy

Method Detail

onInitialize

containsKey

containsKeyInternal

containsValue

get

getInternal

put

remove

removeInternal

remove

removeInternal

removeAll

removeAllInternal

delete

deleteInternal

flush

getAsync

getAsyncInternal

putAsync

putAsync

putAsyncInternal

setAsync

setAsync

setAsyncInternal

removeAsync

removeAsyncInternal

tryRemove

tryRemoveInternal

tryPut

tryPutInternal

put

putInternal

putTransient

putTransientInternal

putIfAbsent

putIfAbsent

putIfAbsentInternal

replace

replaceIfSameInternal

replace

replaceInternal

set

setInternal

lock

lock

isLocked

tryLock

tryLock

tryLock

unlock

forceUnlock

addLocalEntryListener

addLocalEntryListener

addLocalEntryListener

addLocalEntryListener

addLocalEntryListener

addLocalEntryListener

addInterceptor

removeInterceptor