IMap (Hazelcast Root 3.9.2 API)

Type Parameters:

K - key

V - value

All Superinterfaces:

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

All Known Implementing Classes:

ClientMapProxy, MapProxyImpl, NearCachedClientMapProxy, NearCachedMapProxyImpl
```
public interface IMap<K,V>
extends ConcurrentMap<K,V>, LegacyAsyncMap<K,V>
```
Concurrent, distributed, observable and queryable map.
This class is not a general-purpose ConcurrentMap implementation! While this class implements the Map interface, it intentionally violates Map's general contract, which mandates the use of the equals method when comparing objects. Instead of the equals method, this implementation compares the serialized byte version of the objects.
Gotchas:
- Methods, including but not limited to get, containsKey, containsValue, evict, remove, put, putIfAbsent, replace, lock, unlock, do not use hashCode and equals implementations of keys. Instead, they use hashCode and equals of binary (serialized) forms of the objects.
- The get method returns a clone of original values, 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. For additional info, see get(Object).
- Methods, including but not limited to keySet, values, entrySet, return a collection clone of the values. The collection is NOT backed by the map, so changes to the map are NOT reflected in the collection, and vice-versa.
This class does not allow null to be used as a key or value.
Entry Processing
The following operations are lock-aware, since they operate on a single key only. If the key is locked the EntryProcessor will wait until it acquires the lock.
There are however following methods that run the EntryProcessor on more than one entry. These operations are not lock-aware. The EntryProcessor will process the entries no matter if they are locked or not. The user may however check if an entry is locked by casting the Map.Entry to LockAware and invoking the LockAware.isLocked() method.
This applies to both EntryProcessor and backup EntryProcessor.
Split-brain
Behaviour of IMap under split-brain scenarios should be taken into account when using this data structure. During a split, each partitioned cluster will either create a brand new IMap or it will continue to use the primary or back-up version.
When the split heals, Hazelcast by default, performs a PutIfAbsentMapMergePolicy. Users can also decide to specify their own map merge policies, these policies when used in concert with CRDTs (Convergent and Commutative Replicated Data Types) can ensure against data loss during a split-brain.
As a defensive mechanism against such inconsistency, consider using the in-built split-brain protection for IMap. Using this functionality it is possible to restrict operations in smaller partitioned clusters. It should be noted that there is still an inconsistency window between the time of the split and the actual detection. Therefore using this reduces the window of inconsistency but can never completely eliminate it.
See Also:

ConcurrentMap

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

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`addEntryListener(EntryListener listener, boolean includeValue)` Deprecated. please use `addEntryListener(MapListener, boolean)` instead
`String`	`addEntryListener(EntryListener listener, K key, boolean includeValue)` Deprecated. please use `addEntryListener(MapListener, Object, boolean)` instead
`String`	`addEntryListener(EntryListener listener, Predicate<K,V> predicate, boolean includeValue)` Deprecated. please use `addEntryListener(MapListener, com.hazelcast.query.Predicate, boolean)` instead
`String`	`addEntryListener(EntryListener listener, Predicate<K,V> predicate, K key, boolean includeValue)` Deprecated. please use `addEntryListener(MapListener, com.hazelcast.query.Predicate, Object, boolean)` instead
`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)` Deprecated. please use `addLocalEntryListener(MapListener)` instead
`String`	`addLocalEntryListener(EntryListener listener, Predicate<K,V> predicate, boolean includeValue)` Deprecated. please use `addLocalEntryListener(MapListener, com.hazelcast.query.Predicate, boolean)` instead
`String`	`addLocalEntryListener(EntryListener listener, Predicate<K,V> predicate, K key, boolean includeValue)` Deprecated. please use `addLocalEntryListener(MapListener, com.hazelcast.query.Predicate, Object, boolean)` instead
`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)` Deprecated. please use fast-aggregations `aggregate(Aggregator)` or `aggregate(Aggregator, Predicate)` instead
`<SuppliedValue,Result> Result`	`aggregate(Supplier<K,V,SuppliedValue> supplier, Aggregation<K,SuppliedValue,Result> aggregation, JobTracker jobTracker)` Deprecated. please use fast-aggregations `aggregate(Aggregator)` or `aggregate(Aggregator, Predicate)` instead
`void`	`clear()` 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.
`boolean`	`containsValue(Object value)`
`void`	`delete(Object key)` Removes the mapping for a key from this map if it is present (optional operation).
`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.
`boolean`	`evict(K key)` Evicts the specified key from this map.
`void`	`evictAll()` Evicts all keys from this map except the locked ones.
`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.
`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.
`ICompletableFuture<V>`	`getAsync(K key)` Asynchronously gets the given key.
`EntryView<K,V>`	`getEntryView(K key)` Returns the `EntryView` for the specified key.
`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.
`boolean`	`isLocked(K key)` Checks the lock for the specified key.
`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.
`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.
`<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)`
`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.
`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.
`void`	`putTransient(K key, V value, long ttl, TimeUnit timeunit)` Same as `#put(K, V, long, java.util.concurrent.TimeUnit)` except that the MapStore, if defined, will not be called to store/persist the entry.
`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.
`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()`.
`boolean`	`removeEntryListener(String id)` Removes the specified entry listener.
`void`	`removeInterceptor(String id)` Removes the given interceptor for this map, so it will not intercept operations anymore.
`boolean`	`removePartitionLostListener(String id)` 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.
`void`	`set(K key, V value)` Puts an entry into this map without returning the old value (which is more efficient than `put()`).
`void`	`set(K key, V value, long ttl, TimeUnit timeunit)` Puts an entry into this map with a given TTL (time to live) value, without returning the old value (which is more efficient than `put()`).
`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 an entry into this map with a given TTL (time to live) value, without returning the old value (which is more efficient than `put()`).
`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.
`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 leaseTimeunit)` 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.
`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.
`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 interface java.util.concurrent.ConcurrentMap
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, replaceAll

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

Methods inherited from interface com.hazelcast.core.BaseMap
isEmpty, size

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

- Method Detail
  - putAll
```
void putAll(Map<? extends K,? extends V> m)
```
    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.
    Warning:
    If you have previously set a TTL for the key, the TTL remains unchanged and the entry will expire when the initial TTL has elapsed.
    
    Specified by:
    
    putAll in interface Map<K,V>
  - containsKey
```
boolean containsKey(Object key)
```
    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 Map<K,V>
    
    Parameters:
    
    key - The specified key.
    
    Returns:
    
    true if this map contains an entry for the specified key.
    
    Throws:
    
    NullPointerException - if the specified key is null
  - containsValue
```
boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map<K,V>
    
    Throws:
    
    NullPointerException - if the specified value is null
  - get
```
V get(Object key)
```
    Returns the value for the specified key, or null if this map does not contain this key.
    Warning 1:
    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 Map<K,V>
    
    Parameters:
    
    key - The specified key.
    
    Returns:
    
    The value for the specified key.
    
    Throws:
    
    NullPointerException - if the specified key is null
  - put
```
V put(K key,
      V value)
```
    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 1:
    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.
    Warning 3:
    If you have previously set a TTL for the key, the TTL remains unchanged and the entry will expire when the initial TTL has elapsed.
    
    Specified by:
    
    put in interface BaseMap<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.
    
    Throws:
    
    NullPointerException - if the specified key or value is null
  - remove
```
V remove(Object key)
```
    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 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:
    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 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.
    
    Throws:
    
    NullPointerException - if the specified key is null
  - remove
```
boolean remove(Object key,
               Object value)
```
    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 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.
    
    Throws:
    
    NullPointerException - if the specified key or value is null
  - removeAll
```
void removeAll(Predicate<K,V> predicate)
```
    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.
    
    Parameters:
    
    predicate - matching entries with this predicate will be removed from this map
    
    Throws:
    
    NullPointerException - if the specified predicate is null
  - delete
```
void delete(Object key)
```
    Removes the mapping for a key from this map if it is present (optional operation).
    Unlike 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>
    
    Parameters:
    
    key - key whose mapping is to be removed from the map
    
    Throws:
    
    ClassCastException - if the key is of an inappropriate type for this map (optional)
    
    NullPointerException - if the specified key is null
  - flush
```
void flush()
```
    If this map has a MapStore, this method flushes all the local dirty entries by calling MapStore.storeAll() and/or MapStore.deleteAll().
  - getAll
```
Map<K,V> getAll(Set<K> keys)
```
    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 1:
    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.
    
    Parameters:
    
    keys - keys to get (keys inside the collection cannot be null)
    
    Returns:
    
    map of entries
    
    Throws:
    
    NullPointerException - if any of the specified keys are null
  - loadAll
```
void loadAll(boolean replaceExistingValues)
```
    Loads all keys into the store. This is a batch load operation so that an implementation can optimize the multiple loads.
    
    Parameters:
    
    replaceExistingValues - when true, existing values in the Map will be replaced by those loaded from the MapLoader void loadAll(boolean replaceExistingValues));
    
    Since:
    
    3.3
  - loadAll
```
void loadAll(Set<K> keys,
             boolean replaceExistingValues)
```
    Loads the given keys. This is a batch load operation so that an implementation can optimize the multiple loads.
    
    Parameters:
    
    keys - keys of the values entries to load (keys inside the collection cannot be null)
    
    replaceExistingValues - when true, existing values in the Map will be replaced by those loaded from the MapLoader
    
    Since:
    
    3.3
  - clear
```
void clear()
```
    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 evictAll().
    
    Specified by:
    
    clear in interface Map<K,V>
    
    See Also:
    
    evictAll()
  - getAsync
```
ICompletableFuture<V> getAsync(K key)
```
    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 LegacyAsyncMap<K,V>
    
    Parameters:
    
    key - the key of the map entry
    
    Returns:
    
    ICompletableFuture from which the value of the key can be retrieved
    
    Throws:
    
    NullPointerException - if the specified key is null
    
    See Also:
    
    ICompletableFuture
  - putAsync
```
ICompletableFuture<V> putAsync(K key,
                               V value)
```
    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 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:
    If you have previously set a TTL for the key, the TTL remains unchanged and the entry will expire when the initial TTL has elapsed.
    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
    
    Throws:
    
    NullPointerException - if the specified key or value is null
    
    See Also:
    
    ICompletableFuture
  - putAsync
```
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.
    The entry will expire and get evicted after the TTL. If the TTL is 0, then the entry lives forever. If the TTL is negative, then the TTL from the map configuration will be used (default: 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 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, negative means map config default)
    
    timeunit - time unit for the TTL
    
    Returns:
    
    ICompletableFuture from which the old value of the key can be retrieved
    
    Throws:
    
    NullPointerException - if the specified key or value is null
    
    See Also:
    
    ICompletableFuture
  - setAsync
```
ICompletableFuture<Void> setAsync(K key,
                                  V value)
```
    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.
    Warning 2:
    If you have previously set a TTL for the key, the TTL remains unchanged and the entry will expire when the initial TTL has elapsed.
    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
    
    Throws:
    
    NullPointerException - if the specified key or value is null
    
    See Also:
    
    ICompletableFuture
  - setAsync
```
ICompletableFuture<Void> setAsync(K key,
                                  V value,
                                  long ttl,
                                  TimeUnit timeunit)
```
    Asynchronously puts an entry into this map with a given TTL (time to live) value, without returning the old value (which is more efficient than put()).
    The entry will expire and get evicted after the TTL. If the TTL is 0, then the entry lives forever. If the TTL is negative, then the TTL from the map configuration will be used (default: forever).
```
   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 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, negative means map config default)
    
    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
    
    Throws:
    
    NullPointerException - if the specified key or value is null
    
    See Also:
    
    ICompletableFuture
  - removeAsync
```
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().
    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 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
    
    Throws:
    
    NullPointerException - if the specified key is null
    
    See Also:
    
    ICompletableFuture
  - tryRemove
```
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. 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.
    
    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
    
    Throws:
    
    NullPointerException - if the specified key is null
  - tryPut
```
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. 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 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:
    If you have previously set a TTL for the key, the TTL remains unchanged and the entry will expire when the initial TTL has elapsed.
    
    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
    
    Throws:
    
    NullPointerException - if the specified key or value is null
  - put
```
V put(K key,
      V value,
      long ttl,
      TimeUnit timeunit)
```
    Puts an entry into this map with a given TTL (time to live) value.
    The entry will expire and get evicted after the TTL. If the TTL is 0, then the entry lives forever. If the TTL is negative, then the TTL from the map configuration will be used (default: 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:
    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 BaseMap<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, negative means map config default)
    
    timeunit - time unit for the TTL
    
    Returns:
    
    old value of the entry
    
    Throws:
    
    NullPointerException - if the specified key or value is null
  - putTransient
```
void putTransient(K key,
                  V value,
                  long ttl,
                  TimeUnit timeunit)
```
    Same as #put(K, V, long, java.util.concurrent.TimeUnit) except that the MapStore, if defined, will not be called to store/persist the entry.
    The entry will expire and get evicted after the TTL. If the TTL is 0, then the entry lives forever. If the TTL is negative, then the TTL from the map configuration will be used (default: 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.
    
    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, negative means map config default)
    
    timeunit - time unit for the TTL
    
    Throws:
    
    NullPointerException - if the specified key or value is null
  - putIfAbsent
```
V putIfAbsent(K key,
              V value)
```
    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 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
    
    Throws:
    
    NullPointerException - if the specified key or value is null
  - putIfAbsent
```
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.
    The entry will expire and get evicted after the TTL. If the TTL is 0, then the entry lives forever. If the TTL is negative, then the TTL from the map configuration will be used (default: 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:
    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.
    
    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, negative means map config default)
    
    timeunit - time unit for the TTL
    
    Returns:
    
    old value of the entry
    
    Throws:
    
    NullPointerException - if the specified key or value is null
  - replace
```
boolean replace(K key,
                V oldValue,
                V newValue)
```
    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 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.
    
    Throws:
    
    NullPointerException - if any of the specified parameters are null
  - replace
```
V replace(K key,
          V value)
```
    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 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:
    This method returns a clone of the previous value, not the original (identically equal) value previously put into the map.
    Warning 3:
    If you have previously set a TTL for the key, the same TTL will be again set on the new value.
    Specified by:
    
    replace in interface BaseMap<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.
    
    Throws:
    
    NullPointerException - if the specified key or value is null
  - set
```
void set(K key,
         V value)
```
    Puts an entry into this map without returning the old value (which is more efficient than put()).
    Warning 1:
    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.
    Warning 3:
    If you have previously set a TTL for the key, the TTL remains unchanged and the entry will expire when the initial TTL has elapsed.
    
    Specified by:
    
    set in interface BaseMap<K,V>
    
    Parameters:
    
    key - key of the entry
    
    value - value of the entry
    
    Throws:
    
    NullPointerException - if the specified key or value is null
  - set
```
void set(K key,
         V value,
         long ttl,
         TimeUnit timeunit)
```
    Puts an entry into this map with a given TTL (time to live) value, without returning the old value (which is more efficient than put()).
    The entry will expire and get evicted after the TTL. If the TTL is 0, then the entry lives forever. If the TTL is negative, then the TTL from the map configuration will be used (default: 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 the next closest second value.
    
    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, negative means map config default)
    
    timeunit - time unit for the TTL
    
    Throws:
    
    NullPointerException - if the specified key or value is null
  - lock
```
void lock(K key)
```
    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.
    
    Parameters:
    
    key - key to lock
    
    Throws:
    
    NullPointerException - if the specified key is null
  - lock
```
void lock(K key,
          long leaseTime,
          TimeUnit timeUnit)
```
    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.
    
    Parameters:
    
    key - the key to lock
    
    leaseTime - time to wait before releasing the lock
    
    timeUnit - unit of time to specify lease time
    
    Throws:
    
    NullPointerException - if the specified key is null
  - isLocked
```
boolean isLocked(K key)
```
    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.
    
    Parameters:
    
    key - the key that is checked for lock
    
    Returns:
    
    true if lock is acquired, false otherwise
    
    Throws:
    
    NullPointerException - if the specified key is null
  - tryLock
```
boolean tryLock(K key)
```
    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.
    
    Parameters:
    
    key - the key to lock
    
    Returns:
    
    true if lock is acquired, false otherwise
    
    Throws:
    
    NullPointerException - if the specified key is null
  - tryLock
```
boolean tryLock(K key,
                long time,
                TimeUnit timeunit)
         throws InterruptedException
```
    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.
    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, false if the waiting time elapsed before the lock was acquired
    
    Throws:
    
    NullPointerException - if the specified key is null
    
    InterruptedException
  - tryLock
```
boolean tryLock(K key,
                long time,
                TimeUnit timeunit,
                long leaseTime,
                TimeUnit leaseTimeunit)
         throws InterruptedException
```
    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.
    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
    
    leaseTimeunit - unit of time to specify lease time
    
    Returns:
    
    true if the lock was acquired, false if the waiting time elapsed before the lock was acquired
    
    Throws:
    
    NullPointerException - if the specified key is null
    
    InterruptedException
  - unlock
```
void unlock(K key)
```
    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.
    
    Parameters:
    
    key - the key to lock
    
    Throws:
    
    NullPointerException - if the specified key is null
    
    IllegalMonitorStateException - if the current thread does not hold this lock
  - forceUnlock
```
void forceUnlock(K key)
```
    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.
    
    Parameters:
    
    key - the key to lock
    
    Throws:
    
    NullPointerException - if the specified key is null
  - addLocalEntryListener
```
String addLocalEntryListener(MapListener listener)
```
    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.
    
    Parameters:
    
    listener - MapListener for this map
    
    Returns:
    
    a UUID.randomUUID().toString() which is used as a key to remove the listener
    
    Throws:
    
    UnsupportedOperationException - if this operation is not supported, for example on a Hazelcast client
    
    NullPointerException - if the listener is null
    
    See Also:
    
    localKeySet(), MapListener
  - addLocalEntryListener
```
String addLocalEntryListener(EntryListener listener)
```
    Deprecated. please use addLocalEntryListener(MapListener) instead
    
    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.
    
    Parameters:
    
    listener - entry listener
    
    Returns:
    
    a UUID.randomUUID().toString() which is used as a key to remove the listener
    
    Throws:
    
    UnsupportedOperationException - if this operation isn't supported, for example on a Hazelcast client
    
    NullPointerException - if the listener is null
    
    See Also:
    
    localKeySet()
  - addLocalEntryListener
```
String addLocalEntryListener(MapListener listener,
                             Predicate<K,V> predicate,
                             boolean includeValue)
```
    Adds a MapListener for this map.
    To receive an event, you should implement a corresponding MapListener sub-interface for that event. The listener will get notified for map events filtered by the given predicate.
    
    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
    
    Throws:
    
    UnsupportedOperationException - if this operation isn't supported, for example on a Hazelcast client
    
    NullPointerException - if the listener is null
    
    NullPointerException - if the predicate is null
    
    See Also:
    
    MapListener
  - addLocalEntryListener
```
String addLocalEntryListener(EntryListener listener,
                             Predicate<K,V> predicate,
                             boolean includeValue)
```
    Deprecated. please use addLocalEntryListener(MapListener, com.hazelcast.query.Predicate, boolean) instead
    
    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. The listener will get notified for map add/remove/update/evict events filtered by the given predicate.
    
    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
    
    Throws:
    
    NullPointerException - if the listener is null
    
    NullPointerException - if the predicate is null
  - addLocalEntryListener
```
String addLocalEntryListener(MapListener listener,
                             Predicate<K,V> predicate,
                             K key,
                             boolean includeValue)
```
    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. The listener will get notified for map add/remove/update/evict events filtered by the given predicate.
    
    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
    
    Throws:
    
    NullPointerException - if the listener is null
    
    NullPointerException - if the predicate is null
    
    See Also:
    
    MapListener
  - addLocalEntryListener
```
String addLocalEntryListener(EntryListener listener,
                             Predicate<K,V> predicate,
                             K key,
                             boolean includeValue)
```
    Deprecated. please use addLocalEntryListener(MapListener, com.hazelcast.query.Predicate, Object, boolean) instead
    
    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. The listener will get notified for map add/remove/update/evict events filtered by the given predicate.
    
    Parameters:
    
    listener - entry listener
    
    predicate - predicate for filtering entries
    
    key - key to listen fo
    
    includeValue - true if EntryEvent should contain the value
    
    Returns:
    
    a UUID.randomUUID().toString() which is used as a key to remove the listener
    
    Throws:
    
    NullPointerException - if the listener is null
    
    NullPointerException - if the predicate is null
  - addInterceptor
```
String addInterceptor(MapInterceptor interceptor)
```
    Adds an interceptor for this map.
    Added interceptor will intercept operations and execute user defined methods. They will cancel operations if the user defined method throws an exception.
    
    Parameters:
    
    interceptor - map interceptor
    
    Returns:
    
    ID of registered interceptor
  - removeInterceptor
```
void removeInterceptor(String id)
```
    Removes the given interceptor for this map, so it will not intercept operations anymore.
    
    Parameters:
    
    id - registration ID of the map interceptor
  - addEntryListener
```
String addEntryListener(MapListener listener,
                        boolean includeValue)
```
    Adds a MapListener for this map.
    To receive an event, you should implement a corresponding MapListener sub-interface for that event.
    
    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
    
    Throws:
    
    NullPointerException - if the specified listener is null
    
    See Also:
    
    MapListener
  - addEntryListener
```
String addEntryListener(EntryListener listener,
                        boolean includeValue)
```
    Deprecated. please use addEntryListener(MapListener, boolean) instead
    
    Adds an entry listener for this map.
    The listener will get notified for all map add/remove/update/evict events.
    
    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
    
    Throws:
    
    NullPointerException - if the specified listener is null
  - removeEntryListener
```
boolean removeEntryListener(String id)
```
    Removes the specified entry listener.
    Returns silently if there is no such listener added before.
    
    Parameters:
    
    id - ID of registered listener
    
    Returns:
    
    true if registration is removed, false otherwise
  - addPartitionLostListener
```
String addPartitionLostListener(MapPartitionLostListener listener)
```
    Adds a MapPartitionLostListener.
    The addPartitionLostListener returns a register ID. This ID is needed to remove the MapPartitionLostListener using the removePartitionLostListener(String) method.
    There is no check for duplicate registrations, so if you register the listener twice, it will get events twice.
    Warning 1:
    Please see PartitionLostListener for weaknesses.
    Warning 2:
    Listeners registered from HazelcastClient may miss some of the map partition lost events due to design limitations.
    
    Parameters:
    
    listener - the added MapPartitionLostListener
    
    Returns:
    
    returns the registration ID for the MapPartitionLostListener
    
    Throws:
    
    NullPointerException - if listener is null
    
    See Also:
    
    removePartitionLostListener(String), PartitionLostListener
  - removePartitionLostListener
```
boolean removePartitionLostListener(String id)
```
    Removes the specified map partition lost listener.
    Returns silently if there is no such listener was added before.
    
    Parameters:
    
    id - ID of registered listener
    
    Returns:
    
    true if registration is removed, false otherwise
  - addEntryListener
```
String addEntryListener(MapListener listener,
                        K key,
                        boolean includeValue)
```
    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.
    
    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
    
    Throws:
    
    NullPointerException - if the specified listener is null
    
    NullPointerException - if the specified key is null
    
    See Also:
    
    MapListener
  - addEntryListener
```
String addEntryListener(EntryListener listener,
                        K key,
                        boolean includeValue)
```
    Deprecated. please use addEntryListener(MapListener, Object, boolean) instead
    
    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.
    
    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
    
    Throws:
    
    NullPointerException - if the specified listener is null
    
    NullPointerException - if the specified key is null
  - addEntryListener
```
String addEntryListener(MapListener listener,
                        Predicate<K,V> predicate,
                        boolean includeValue)
```
    Adds a MapListener for this map.
    To receive an event, you should implement a corresponding MapListener sub-interface for that event.
    
    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
    
    Throws:
    
    NullPointerException - if the specified listener is null
    
    NullPointerException - if the specified predicate is null
    
    See Also:
    
    MapListener
  - addEntryListener
```
String addEntryListener(EntryListener listener,
                        Predicate<K,V> predicate,
                        boolean includeValue)
```
    Deprecated. please use addEntryListener(MapListener, com.hazelcast.query.Predicate, boolean) instead
    
    Adds an continuous entry listener for this map.
    The listener will get notified for map add/remove/update/evict events filtered by the given predicate.
    
    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
    
    Throws:
    
    NullPointerException - if the specified listener is null
    
    NullPointerException - if the specified predicate is null
  - addEntryListener
```
String addEntryListener(MapListener listener,
                        Predicate<K,V> predicate,
                        K key,
                        boolean includeValue)
```
    Adds a MapListener for this map.
    To receive an event, you should implement a corresponding MapListener sub-interface for that event.
    
    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
    
    Throws:
    
    NullPointerException - if the specified listener is null
    
    NullPointerException - if the specified predicate is null
    
    See Also:
    
    MapListener
  - addEntryListener
```
String addEntryListener(EntryListener listener,
                        Predicate<K,V> predicate,
                        K key,
                        boolean includeValue)
```
    Deprecated. please use addEntryListener(MapListener, com.hazelcast.query.Predicate, Object, boolean) instead
    
    Adds an continuous entry listener for this map.
    The listener will get notified for map add/remove/update/evict events filtered by the given predicate.
    
    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
    
    Throws:
    
    NullPointerException - if the specified listener is null
    
    NullPointerException - if the specified predicate is null
  - getEntryView
```
EntryView<K,V> getEntryView(K key)
```
    Returns the EntryView for the specified key.
    Warning 1:
    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.
    
    Parameters:
    
    key - the key of the entry
    
    Returns:
    
    EntryView of the specified key
    
    Throws:
    
    NullPointerException - if the specified key is null
    
    See Also:
    
    EntryView
  - evict
```
boolean evict(K key)
```
    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.
    
    Parameters:
    
    key - the specified key to evict from this map
    
    Returns:
    
    true if the key is evicted, false otherwise
    
    Throws:
    
    NullPointerException - if the specified key is null
  - evictAll
```
void evictAll()
```
    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 clear() method.
    The EVICT_ALL event is fired for any registered listeners. See MapEvictedListener.mapEvicted(MapEvent) .
    
    Since:
    
    3.3
    
    See Also:
    
    clear()
  - keySet
```
Set<K> keySet()
```
    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 BaseMap<K,V>
    
    Specified by:
    
    keySet in interface Map<K,V>
    
    Returns:
    
    a set clone of the keys contained in this map
    
    Throws:
    
    QueryResultSizeExceededException - if query result size limit is exceeded
    
    See Also:
    
    GroupProperty.QUERY_RESULT_SIZE_LIMIT
  - values
```
Collection<V> values()
```
    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 BaseMap<K,V>
    
    Specified by:
    
    values in interface Map<K,V>
    
    Returns:
    
    a collection clone of the values contained in this map
    
    Throws:
    
    QueryResultSizeExceededException - if query result size limit is exceeded
    
    See Also:
    
    GroupProperty.QUERY_RESULT_SIZE_LIMIT
  - entrySet
```
Set<Map.Entry<K,V>> entrySet()
```
    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 Map<K,V>
    
    Returns:
    
    a set clone of the keys mappings in this map
    
    Throws:
    
    QueryResultSizeExceededException - if query result size limit is exceeded
    
    See Also:
    
    GroupProperty.QUERY_RESULT_SIZE_LIMIT
  - keySet
```
Set<K> keySet(Predicate predicate)
```
    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 BaseMap<K,V>
    
    Parameters:
    
    predicate - specified query criteria
    
    Returns:
    
    result key set of the query
    
    Throws:
    
    QueryResultSizeExceededException - if query result size limit is exceeded
    
    NullPointerException - if the predicate is null
    
    See Also:
    
    GroupProperty.QUERY_RESULT_SIZE_LIMIT
  - entrySet
```
Set<Map.Entry<K,V>> entrySet(Predicate predicate)
```
    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.
    
    Parameters:
    
    predicate - specified query criteria
    
    Returns:
    
    result entry set of the query
    
    Throws:
    
    QueryResultSizeExceededException - if query result size limit is exceeded
    
    NullPointerException - if the predicate is null
    
    See Also:
    
    GroupProperty.QUERY_RESULT_SIZE_LIMIT
  - values
```
Collection<V> values(Predicate predicate)
```
    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 BaseMap<K,V>
    
    Parameters:
    
    predicate - specified query criteria
    
    Returns:
    
    result value collection of the query
    
    Throws:
    
    QueryResultSizeExceededException - if query result size limit is exceeded
    
    NullPointerException - if the predicate is null
    
    See Also:
    
    GroupProperty.QUERY_RESULT_SIZE_LIMIT
  - localKeySet
```
Set<K> localKeySet()
```
    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.
    
    Returns:
    
    locally owned keys
    
    Throws:
    
    QueryResultSizeExceededException - if query result size limit is exceeded
    
    See Also:
    
    GroupProperty.QUERY_RESULT_SIZE_LIMIT
  - localKeySet
```
Set<K> localKeySet(Predicate predicate)
```
    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.
    
    Parameters:
    
    predicate - specified query criteria
    
    Returns:
    
    keys of matching locally owned entries
    
    Throws:
    
    QueryResultSizeExceededException - if query result size limit is exceeded
    
    See Also:
    
    GroupProperty.QUERY_RESULT_SIZE_LIMIT
  - addIndex
```
void addIndex(String attribute,
              boolean ordered)
```
    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.
    Parameters:
    
    attribute - index attribute of value
    
    ordered - true if index should be ordered, false otherwise.
  - getLocalMapStats
```
LocalMapStats getLocalMapStats()
```
    Returns LocalMapStats for this map.
    LocalMapStats are 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.
    
    Returns:
    
    this map's local statistics
  - executeOnKey
```
Object executeOnKey(K key,
                    EntryProcessor entryProcessor)
```
    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.
    Returns:
    
    result of entry process
    
    Throws:
    
    NullPointerException - if the specified key is null
    
    See Also:
    
    Offloadable, ReadOnly
  - executeOnKeys
```
Map<K,Object> executeOnKeys(Set<K> keys,
                            EntryProcessor entryProcessor)
```
    Applies the user defined EntryProcessor to the entries mapped by the collection of keys. the results mapped by each key in the collection.
    
    Returns:
    
    result of entry process
    
    Throws:
    
    NullPointerException - if the specified key is null
    
    IllegalArgumentException - if the specified keys set is empty
  - submitToKey
```
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.
    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.
    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
  - submitToKey
```
ICompletableFuture submitToKey(K key,
                               EntryProcessor entryProcessor)
```
    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 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
  - executeOnEntries
```
Map<K,Object> executeOnEntries(EntryProcessor entryProcessor)
```
    Applies the user defined EntryProcessor to the all entries in the map. Returns the results mapped by each key in the map.
  - executeOnEntries
```
Map<K,Object> executeOnEntries(EntryProcessor entryProcessor,
                               Predicate predicate)
```
    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.
  - aggregate
```
<R> R aggregate(Aggregator<Map.Entry<K,V>,R> aggregator)
```
    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.
    
    Type Parameters:
    
    R - type of the result
    
    Parameters:
    
    aggregator - aggregator to aggregate the entries with
    
    Returns:
    
    the result of the given type
    
    Since:
    
    3.8
  - aggregate
```
<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
    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.
    
    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
    
    Since:
    
    3.8
  - project
```
<R> Collection<R> project(Projection<Map.Entry<K,V>,R> projection)
```
    Applies the projection logic on all map entries and returns the result
    
    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
    
    Since:
    
    3.8
  - project
```
<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
    
    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
    
    Since:
    
    3.8
  - aggregate
```
@Deprecated
<SuppliedValue,Result> Result aggregate(Supplier<K,V,SuppliedValue> supplier,
                                                    Aggregation<K,SuppliedValue,Result> aggregation)
```
    Deprecated. please use fast-aggregations aggregate(Aggregator) or aggregate(Aggregator, Predicate) instead
    
    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.
    
    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
```
@Deprecated
<SuppliedValue,Result> Result aggregate(Supplier<K,V,SuppliedValue> supplier,
                                                    Aggregation<K,SuppliedValue,Result> aggregation,
                                                    JobTracker jobTracker)
```
    Deprecated. please use fast-aggregations aggregate(Aggregator) or aggregate(Aggregator, Predicate) instead
    
    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.
    
    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
```
@Beta
QueryCache<K,V> getQueryCache(String name)
```
    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.
    
    Parameters:
    
    name - the name of QueryCache
    
    Returns:
    
    the QueryCache instance or null if there is no corresponding QueryCacheConfig
    
    Throws:
    
    NullPointerException - if the specified name is null
    
    Since:
    
    3.8
    
    See Also:
    
    QueryCache
  - getQueryCache
```
@Beta
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.
    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.
    
    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
    
    Throws:
    
    NullPointerException - if the specified name or predicate is null
    
    Since:
    
    3.8
    
    See Also:
    
    QueryCache
  - getQueryCache
```
@Beta
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.
    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.
    
    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
    
    Throws:
    
    NullPointerException - if the specified name or listener or predicate is null
    
    Since:
    
    3.8
    
    See Also:
    
    QueryCache

Interface IMap<K,V>

Nested Class Summary

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

Method Summary

Methods inherited from interface java.util.concurrent.ConcurrentMap

Methods inherited from interface java.util.Map

Methods inherited from interface com.hazelcast.core.BaseMap

Methods inherited from interface com.hazelcast.core.DistributedObject

Method Detail

putAll

containsKey

containsValue

get

put

remove

remove

removeAll

delete

flush

getAll

loadAll

loadAll

clear

getAsync

putAsync

putAsync

setAsync

setAsync

removeAsync

tryRemove

tryPut

put

putTransient

putIfAbsent

putIfAbsent

replace

replace

set

set

lock

lock

isLocked

tryLock

tryLock

tryLock

unlock

forceUnlock

addLocalEntryListener

addLocalEntryListener

addLocalEntryListener

addLocalEntryListener

addLocalEntryListener

addLocalEntryListener

addInterceptor

removeInterceptor

addEntryListener

addEntryListener

removeEntryListener

addPartitionLostListener

removePartitionLostListener

addEntryListener

addEntryListener

addEntryListener

addEntryListener

addEntryListener

addEntryListener

getEntryView

evict

evictAll

keySet

values

entrySet

keySet

entrySet

values

localKeySet

localKeySet

addIndex

getLocalMapStats

executeOnKey