K
- keyV
- valuepublic class ClientMapProxy<K,V> extends ClientProxy implements IMap<K,V>, EventJournalReader<EventJournalMapEvent<K,V>>
IMap
.Modifier and Type | Field and Description |
---|---|
protected static String |
NULL_AGGREGATOR_IS_NOT_ALLOWED |
protected static String |
NULL_KEY_IS_NOT_ALLOWED |
protected static String |
NULL_LISTENER_IS_NOT_ALLOWED |
protected static String |
NULL_PREDICATE_IS_NOT_ALLOWED |
protected static String |
NULL_PROJECTION_IS_NOT_ALLOWED |
protected static String |
NULL_VALUE_IS_NOT_ALLOWED |
name
Constructor and Description |
---|
ClientMapProxy(String serviceName,
String name,
ClientContext context) |
Modifier and Type | Method and Description |
---|---|
String |
addEntryListener(EntryListener listener,
boolean includeValue)
Adds an entry listener for this map.
|
String |
addEntryListener(EntryListener listener,
K key,
boolean includeValue)
Adds the specified entry listener for the specified key.
|
String |
addEntryListener(EntryListener listener,
Predicate<K,V> predicate,
boolean includeValue)
Adds an continuous entry listener for this map.
|
String |
addEntryListener(EntryListener listener,
Predicate<K,V> predicate,
K key,
boolean includeValue)
Adds an continuous entry listener for this map.
|
String |
addEntryListener(MapListener listener,
boolean includeValue)
Adds a
MapListener for this map. |
String |
addEntryListener(MapListener listener,
K key,
boolean includeValue)
Adds a
MapListener for this map. |
String |
addEntryListener(MapListener listener,
Predicate<K,V> predicate,
boolean includeValue)
Adds a
MapListener for this map. |
String |
addEntryListener(MapListener listener,
Predicate<K,V> predicate,
K key,
boolean includeValue)
Adds a
MapListener for this map. |
void |
addIndex(String attribute,
boolean ordered)
Adds an index to this map for the specified entries so
that queries can run faster.
|
String |
addInterceptor(MapInterceptor interceptor)
Adds an interceptor for this map.
|
String |
addLocalEntryListener(EntryListener listener)
Adds a local entry listener for this map.
|
String |
addLocalEntryListener(EntryListener listener,
Predicate<K,V> predicate,
boolean includeValue)
Adds a local entry listener for this map.
|
String |
addLocalEntryListener(EntryListener listener,
Predicate<K,V> predicate,
K key,
boolean includeValue)
Adds a local entry listener for this map.
|
String |
addLocalEntryListener(MapListener listener)
Adds a
MapListener for this map. |
String |
addLocalEntryListener(MapListener listener,
Predicate<K,V> predicate,
boolean includeValue)
Adds a
MapListener for this map. |
String |
addLocalEntryListener(MapListener listener,
Predicate<K,V> predicate,
K key,
boolean includeValue)
Adds a local entry listener for this map.
|
String |
addPartitionLostListener(MapPartitionLostListener listener)
Adds a MapPartitionLostListener.
|
<R> R |
aggregate(Aggregator<Map.Entry<K,V>,R> aggregator)
Applies the aggregation logic on all map entries and returns the result
|
<R> R |
aggregate(Aggregator<Map.Entry<K,V>,R> aggregator,
Predicate<K,V> predicate)
Applies the aggregation logic on map entries filtered with the Predicated and returns the result
|
<SuppliedValue,Result> |
aggregate(Supplier<K,V,SuppliedValue> supplier,
Aggregation<K,SuppliedValue,Result> aggregation)
Executes a predefined aggregation on the maps data set.
|
<SuppliedValue,Result> |
aggregate(Supplier<K,V,SuppliedValue> supplier,
Aggregation<K,SuppliedValue,Result> aggregation,
JobTracker jobTracker)
Executes a predefined aggregation on the maps data set.
|
void |
clear()
Clears the map and invokes
MapStore.deleteAll(java.util.Collection<K>) deleteAll on MapStore which,
if connected to a database, will delete the records from that database. |
boolean |
containsKey(Object key)
Returns
true if this map contains an entry for the specified
key. |
protected boolean |
containsKeyInternal(Object key) |
boolean |
containsValue(Object value) |
void |
delete(Object key)
Removes the mapping for a key from this map if it is present (optional operation).
|
protected void |
deleteInternal(Object key) |
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.
|
protected boolean |
evictInternal(Object key) |
Map<K,Object> |
executeOnEntries(EntryProcessor entryProcessor)
Applies the user defined EntryProcessor to the all entries in the map.
|
Map<K,Object> |
executeOnEntries(EntryProcessor entryProcessor,
Predicate predicate)
Applies the user defined EntryProcessor to the entries in the map which satisfies provided predicate.
|
Object |
executeOnKey(K key,
EntryProcessor entryProcessor)
Applies the user defined EntryProcessor to the entry mapped by the key.
|
Object |
executeOnKeyInternal(Object key,
EntryProcessor entryProcessor) |
Map<K,Object> |
executeOnKeys(Set<K> keys,
EntryProcessor entryProcessor)
Applies the user defined EntryProcessor to the entries mapped by the collection of keys.
|
protected void |
fillPartitionToKeyData(Set<K> keys,
Map<Integer,List<Data>> partitionToKeyData,
Map<Object,Data> keyMap,
Map<Data,Object> reverseKeyMap) |
void |
flush()
If this map has a MapStore, this method flushes
all the local dirty entries by calling MapStore.storeAll() and/or MapStore.deleteAll().
|
void |
forceUnlock(K key)
Releases the lock for the specified key regardless of the lock owner.
|
V |
get(Object key)
Returns the value for the specified key, or
null if this map does not contain this key. |
Map<K,V> |
getAll(Set<K> keys)
Returns the entries for the given keys.
|
protected void |
getAllInternal(Set<K> keys,
Map<Integer,List<Data>> partitionToKeyData,
List<Object> resultingKeyValuePairs) |
ICompletableFuture<V> |
getAsync(K key)
Asynchronously gets the given key.
|
protected ICompletableFuture<V> |
getAsyncInternal(Object key) |
EntryView<K,V> |
getEntryView(K key)
Returns the
EntryView for the specified key. |
protected Object |
getInternal(Object 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. |
ClientQueryCacheContext |
getQueryCacheContext() |
boolean |
isEmpty()
Returns true if this map contains no entries.
|
boolean |
isLocked(K key)
Checks the lock for the specified key.
|
Iterator<Map.Entry<K,V>> |
iterator(int fetchSize,
int partitionId,
boolean prefetchValues)
Returns an iterator for iterating entries in the
partitionId . |
<R> Iterator<R> |
iterator(int fetchSize,
int partitionId,
Projection<Map.Entry<K,V>,R> projection,
Predicate<K,V> predicate)
Returns an iterator for iterating the result of the projection on entries in the
partitionId which
satisfy the predicate . |
Set<K> |
keySet()
Returns a set clone of the keys contained in this map.
|
Set<K> |
keySet(Predicate predicate)
Queries the map based on the specified predicate and
returns the keys of matching entries.
|
void |
loadAll(boolean replaceExistingValues)
Loads all keys into the store.
|
void |
loadAll(Set<K> keys,
boolean replaceExistingValues)
Loads the given keys.
|
protected void |
loadAllInternal(boolean replaceExistingValues,
Collection<?> 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.
|
protected void |
onDestroy()
Called before proxy is destroyed.
|
protected void |
onInitialize()
Called when proxy is created.
|
protected Map<K,Object> |
prepareResult(Collection<Map.Entry<Data,Data>> entries) |
<R> Collection<R> |
project(Projection<Map.Entry<K,V>,R> projection)
Applies the projection logic on all map entries and returns the result
|
<R> Collection<R> |
project(Projection<Map.Entry<K,V>,R> projection,
Predicate<K,V> predicate)
Applies the projection logic on map entries filtered with the Predicated and returns the result
|
V |
put(K key,
V value)
Associates the specified value with the specified key in this map.
|
V |
put(K key,
V value,
long ttl,
TimeUnit timeunit)
Puts an entry into this map with a given TTL (time to live) value.
|
void |
putAll(Map<? extends K,? extends V> map) |
protected void |
putAllInternal(Map<? extends K,? extends V> map,
Map<Integer,List<Map.Entry<Data,Data>>> entryMap) |
ICompletableFuture<V> |
putAsync(K key,
V value)
Asynchronously puts the given key and value.
|
ICompletableFuture<V> |
putAsync(K key,
V value,
long ttl,
TimeUnit timeunit)
Asynchronously puts the given key and value into this map with a given TTL (time to live) value.
|
protected ICompletableFuture<V> |
putAsyncInternal(long ttl,
TimeUnit timeunit,
Object key,
Object 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.
|
protected V |
putIfAbsentInternal(long ttl,
TimeUnit timeunit,
Object key,
Object value) |
protected V |
putInternal(long ttl,
TimeUnit timeunit,
Object key,
Object 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. |
protected void |
putTransientInternal(long ttl,
TimeUnit timeunit,
Object key,
Object value) |
<T> ICompletableFuture<ReadResultSet<T>> |
readFromEventJournal(long startSequence,
int minSize,
int maxSize,
int partitionId,
Predicate<? super EventJournalMapEvent<K,V>> predicate,
Projection<? super EventJournalMapEvent<K,V>,T> projection)
Reads from the event journal.
|
V |
remove(Object key)
Removes the mapping for a key from this map if it is present.
|
boolean |
remove(Object key,
Object value)
Removes the entry for a key only if currently mapped to a given value.
|
void |
removeAll(Predicate<K,V> predicate)
Removes all entries which match with the supplied predicate.
|
protected void |
removeAllInternal(Predicate predicate) |
ICompletableFuture<V> |
removeAsync(K key)
Asynchronously removes the given key, returning an
ICompletableFuture on which
the caller can provide an ExecutionCallback to be invoked upon remove operation
completion or block waiting for the operation to complete with Future.get() . |
protected ICompletableFuture<V> |
removeAsyncInternal(Object key) |
boolean |
removeEntryListener(String registrationId)
Removes the specified entry listener.
|
void |
removeInterceptor(String id)
Removes the given interceptor for this map, so it will not intercept operations anymore.
|
protected com.hazelcast.client.impl.protocol.codec.MapRemoveCodec.ResponseParameters |
removeInternal(Object key) |
protected boolean |
removeInternal(Object key,
Object value) |
boolean |
removePartitionLostListener(String registrationId)
Removes the specified map partition lost listener.
|
V |
replace(K key,
V value)
Replaces the entry for a key only if it is currently mapped to some value.
|
boolean |
replace(K key,
V oldValue,
V newValue)
Replaces the entry for a key only if currently mapped to a given value.
|
protected boolean |
replaceIfSameInternal(Object key,
Object oldValue,
Object newValue) |
protected V |
replaceInternal(Object key,
Object 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() ). |
protected ICompletableFuture<Void> |
setAsyncInternal(long ttl,
TimeUnit timeunit,
Object key,
Object value) |
protected void |
setInternal(long ttl,
TimeUnit timeunit,
Object key,
Object value) |
int |
size()
Returns the number of entries in this map.
|
ICompletableFuture |
submitToKey(K key,
EntryProcessor entryProcessor)
Applies the user defined EntryProcessor to the entry mapped by the key.
|
void |
submitToKey(K key,
EntryProcessor entryProcessor,
ExecutionCallback callback)
Applies the user defined EntryProcessor to the entry mapped by the key with
specified ExecutionCallback to listen event status and returns immediately.
|
ICompletableFuture |
submitToKeyInternal(Object key,
EntryProcessor entryProcessor) |
void |
submitToKeyInternal(Object key,
EntryProcessor entryProcessor,
ExecutionCallback callback) |
ICompletableFuture<EventJournalInitialSubscriberState> |
subscribeToEventJournal(int partitionId)
Subscribe to the event journal for this reader and a specific partition ID.
|
String |
toString() |
boolean |
tryLock(K key)
Tries to acquire the lock for the specified key.
|
boolean |
tryLock(K key,
long time,
TimeUnit timeunit)
Tries to acquire the lock for the specified key.
|
boolean |
tryLock(K key,
long time,
TimeUnit timeunit,
long leaseTime,
TimeUnit leaseUnit)
Tries to acquire the lock for the specified key for the specified lease time.
|
boolean |
tryPut(K key,
V value,
long timeout,
TimeUnit timeunit)
Tries to put the given key and value into this map within a specified
timeout value.
|
protected boolean |
tryPutInternal(long timeout,
TimeUnit timeunit,
Object key,
Object 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.
|
protected boolean |
tryRemoveInternal(long timeout,
TimeUnit timeunit,
Object key) |
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.
|
deregisterListener, destroy, equals, getClient, getConnectedServerVersion, getContext, getDistributedObjectName, getId, getName, getPartitionKey, getSerializationService, getServiceName, hashCode, invoke, invoke, invokeOnAddress, invokeOnPartition, invokeOnPartitionInterruptibly, onShutdown, postDestroy, preDestroy, registerListener, setContext, toData, toObject
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, replaceAll
destroy, getName, getPartitionKey, getServiceName
protected static final String NULL_LISTENER_IS_NOT_ALLOWED
protected static final String NULL_KEY_IS_NOT_ALLOWED
protected static final String NULL_VALUE_IS_NOT_ALLOWED
protected static final String NULL_PREDICATE_IS_NOT_ALLOWED
protected static final String NULL_AGGREGATOR_IS_NOT_ALLOWED
protected static final String NULL_PROJECTION_IS_NOT_ALLOWED
public ClientMapProxy(String serviceName, String name, ClientContext context)
protected void onInitialize()
ClientProxy
onInitialize
in class ClientProxy
public boolean containsKey(Object key)
IMap
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.
containsKey
in interface BaseMap<K,V>
containsKey
in interface IMap<K,V>
containsKey
in interface Map<K,V>
key
- The specified key.true
if this map contains an entry for the specified key.protected boolean containsKeyInternal(Object key)
public boolean containsValue(Object value)
IMap
containsValue
in interface IMap<K,V>
containsValue
in interface Map<K,V>
public V get(Object key)
IMap
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.
public V put(K key, V value)
IMap
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.
public V remove(Object key)
IMap
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.
This method returns a clone of the previous value, not the original (identically equal) value previously put into the map.
protected com.hazelcast.client.impl.protocol.codec.MapRemoveCodec.ResponseParameters removeInternal(Object key)
public boolean remove(Object key, Object value)
IMap
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.
remove
in interface BaseMap<K,V>
remove
in interface IMap<K,V>
remove
in interface ConcurrentMap<K,V>
remove
in interface Map<K,V>
key
- The specified key.value
- Remove the key if it has this value.true
if the value was removed.public void removeAll(Predicate<K,V> predicate)
IMap
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.
protected void removeAllInternal(Predicate predicate)
public void delete(Object key)
IMap
Unlike IMap.remove(Object)
, this operation does not return
the removed value, which avoids the serialization cost of the returned value.
If the removed value will not be used, a delete operation is preferred over a remove operation for better performance.
The map will not contain a mapping for the specified key once the call returns.
Warning:
This method breaks the contract of EntryListener. When an entry is removed by delete(), it fires an EntryEvent with a null oldValue.
Also, a listener with predicates will have null values, so only keys can be queried via predicates.
protected void deleteInternal(Object key)
public void flush()
IMap
public ICompletableFuture<V> getAsync(K key)
IMap
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.
getAsync
in interface IMap<K,V>
getAsync
in interface LegacyAsyncMap<K,V>
key
- the key of the map entryICompletableFuture
protected ICompletableFuture<V> getAsyncInternal(Object key)
public ICompletableFuture<V> putAsync(K key, V value)
IMap
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.
putAsync
in interface IMap<K,V>
putAsync
in interface LegacyAsyncMap<K,V>
key
- the key of the map entryvalue
- the new value of the map entryICompletableFuture
public ICompletableFuture<V> putAsync(K key, V value, long ttl, TimeUnit timeunit)
IMap
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.
putAsync
in interface IMap<K,V>
putAsync
in interface LegacyAsyncMap<K,V>
key
- the key of the map entryvalue
- the new value of the map entryttl
- maximum time for this entry to stay in the map (0 means infinite, negative means map config default)timeunit
- time unit for the TTLICompletableFuture
protected ICompletableFuture<V> putAsyncInternal(long ttl, TimeUnit timeunit, Object key, Object value)
public ICompletableFuture<Void> setAsync(K key, V value)
IMap
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.
setAsync
in interface IMap<K,V>
setAsync
in interface LegacyAsyncMap<K,V>
key
- the key of the map entryvalue
- the new value of the map entryExecutionCallback
to be invoked upon completionICompletableFuture
public ICompletableFuture<Void> setAsync(K key, V value, long ttl, TimeUnit timeunit)
IMap
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 { ICompletableFutureYou can also schedule anfuture = map.setAsync(key, newValue, ttl, timeunit); future.get(40, TimeUnit.MILLISECOND); } catch (TimeoutException t) { // time wasn't enough }
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.
setAsync
in interface IMap<K,V>
setAsync
in interface LegacyAsyncMap<K,V>
key
- the key of the map entryvalue
- the new value of the map entryttl
- maximum time for this entry to stay in the map (0 means infinite, negative means map config default)timeunit
- time unit for the TTLExecutionCallback
to be invoked upon set operation completionICompletableFuture
protected ICompletableFuture<Void> setAsyncInternal(long ttl, TimeUnit timeunit, Object key, Object value)
public ICompletableFuture<V> removeAsync(K key)
IMap
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.
removeAsync
in interface IMap<K,V>
removeAsync
in interface LegacyAsyncMap<K,V>
key
- The key of the map entry to removeICompletableFuture
from which the value removed from the map can be retrievedICompletableFuture
protected ICompletableFuture<V> removeAsyncInternal(Object key)
public boolean tryRemove(K key, long timeout, TimeUnit timeunit)
IMap
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.
public boolean tryPut(K key, V value, long timeout, TimeUnit timeunit)
IMap
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.
protected boolean tryPutInternal(long timeout, TimeUnit timeunit, Object key, Object value)
public V put(K key, V value, long ttl, TimeUnit timeunit)
IMap
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.
put
in interface BaseMap<K,V>
put
in interface IMap<K,V>
key
- key of the entryvalue
- value of the entryttl
- maximum time for this entry to stay in the map (0 means infinite, negative means map config default)timeunit
- time unit for the TTLpublic void putTransient(K key, V value, long ttl, TimeUnit timeunit)
IMap
#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.
putTransient
in interface IMap<K,V>
key
- key of the entryvalue
- value of the entryttl
- maximum time for this entry to stay in the map (0 means infinite, negative means map config default)timeunit
- time unit for the TTLprotected void putTransientInternal(long ttl, TimeUnit timeunit, Object key, Object value)
public V putIfAbsent(K key, V value)
IMap
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.
putIfAbsent
in interface BaseMap<K,V>
putIfAbsent
in interface IMap<K,V>
putIfAbsent
in interface ConcurrentMap<K,V>
putIfAbsent
in interface Map<K,V>
key
- The specified key.value
- The value to associate with the key when there is no previous value.public V putIfAbsent(K key, V value, long ttl, TimeUnit timeunit)
IMap
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.
putIfAbsent
in interface IMap<K,V>
key
- key of the entryvalue
- value of the entryttl
- maximum time for this entry to stay in the map (0 means infinite, negative means map config default)timeunit
- time unit for the TTLprotected V putIfAbsentInternal(long ttl, TimeUnit timeunit, Object key, Object value)
public boolean replace(K key, V oldValue, V newValue)
IMap
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.
replace
in interface BaseMap<K,V>
replace
in interface IMap<K,V>
replace
in interface ConcurrentMap<K,V>
replace
in interface Map<K,V>
key
- The specified key.oldValue
- Replace the key value if it is the old value.newValue
- The new value to replace the old value.true
if the value was replaced.protected boolean replaceIfSameInternal(Object key, Object oldValue, Object newValue)
public V replace(K key, V value)
IMap
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.
replace
in interface BaseMap<K,V>
replace
in interface IMap<K,V>
replace
in interface ConcurrentMap<K,V>
replace
in interface Map<K,V>
key
- The specified key.value
- The value to replace the previous value.key
, or null
if there was no mapping for key
.public void set(K key, V value, long ttl, TimeUnit timeunit)
IMap
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.
public void lock(K key)
IMap
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.
public void lock(K key, long leaseTime, TimeUnit timeUnit)
IMap
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.
public boolean isLocked(K key)
IMap
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.
public boolean tryLock(K key)
IMap
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.
public boolean tryLock(K key, long time, TimeUnit timeunit) throws InterruptedException
IMap
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:
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.
tryLock
in interface IMap<K,V>
key
- key to lock in this maptime
- maximum time to wait for the locktimeunit
- time unit of the time
argumenttrue
if the lock was acquired, false
if the waiting time elapsed before the lock was acquiredInterruptedException
public boolean tryLock(K key, long time, TimeUnit timeunit, long leaseTime, TimeUnit leaseUnit) throws InterruptedException
IMap
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:
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.
tryLock
in interface IMap<K,V>
key
- key to lock in this maptime
- maximum time to wait for the locktimeunit
- time unit of the time
argumentleaseTime
- time to wait before releasing the lockleaseUnit
- unit of time to specify lease timetrue
if the lock was acquired, false
if the waiting time elapsed before the lock was acquiredInterruptedException
public void unlock(K key)
IMap
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.
public void forceUnlock(K key)
IMap
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.
forceUnlock
in interface IMap<K,V>
key
- the key to lockpublic String addLocalEntryListener(MapListener listener)
IMap
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.
addLocalEntryListener
in interface IMap<K,V>
listener
- MapListener
for this mapIMap.localKeySet()
,
MapListener
public String addLocalEntryListener(EntryListener listener)
IMap
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.
addLocalEntryListener
in interface IMap<K,V>
listener
- entry listenerIMap.localKeySet()
public String addLocalEntryListener(MapListener listener, Predicate<K,V> predicate, boolean includeValue)
IMap
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.
addLocalEntryListener
in interface IMap<K,V>
listener
- MapListener
for this mappredicate
- predicate for filtering entriesincludeValue
- true
if EntryEvent
should contain the valueMapListener
public String addLocalEntryListener(EntryListener listener, Predicate<K,V> predicate, boolean includeValue)
IMap
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.
addLocalEntryListener
in interface IMap<K,V>
listener
- entry listenerpredicate
- predicate for filtering entriesincludeValue
- true
if EntryEvent
should contain the valuepublic String addLocalEntryListener(MapListener listener, Predicate<K,V> predicate, K key, boolean includeValue)
IMap
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.
addLocalEntryListener
in interface IMap<K,V>
listener
- MapListener
for this mappredicate
- predicate for filtering entrieskey
- key to listen forincludeValue
- true
if EntryEvent
should contain the valueMapListener
public String addLocalEntryListener(EntryListener listener, Predicate<K,V> predicate, K key, boolean includeValue)
IMap
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.
addLocalEntryListener
in interface IMap<K,V>
listener
- entry listenerpredicate
- predicate for filtering entrieskey
- key to listen foincludeValue
- true
if EntryEvent
should contain the valuepublic String addInterceptor(MapInterceptor interceptor)
IMap
Added interceptor will intercept operations and execute user defined methods. They will cancel operations if the user defined method throws an exception.
addInterceptor
in interface IMap<K,V>
interceptor
- map interceptorpublic void removeInterceptor(String id)
IMap
removeInterceptor
in interface IMap<K,V>
id
- registration ID of the map interceptorpublic String addEntryListener(MapListener listener, boolean includeValue)
IMap
MapListener
for this map.
To receive an event, you should implement a corresponding MapListener
sub-interface for that event.
addEntryListener
in interface IMap<K,V>
listener
- MapListener
for this mapincludeValue
- true
if EntryEvent
should contain the valueMapListener
public String addEntryListener(EntryListener listener, boolean includeValue)
IMap
The listener will get notified for all map add/remove/update/evict events.
addEntryListener
in interface IMap<K,V>
listener
- the added entry listener for this mapincludeValue
- true
if EntryEvent
should contain the valuepublic boolean removeEntryListener(String registrationId)
IMap
Returns silently if there is no such listener added before.
removeEntryListener
in interface IMap<K,V>
registrationId
- ID of registered listenerpublic String addPartitionLostListener(MapPartitionLostListener listener)
IMap
The addPartitionLostListener returns a register ID. This ID is needed to remove the MapPartitionLostListener using the
IMap.removePartitionLostListener(String)
method.
There is no check for duplicate registrations, so if you register the listener twice, it will get events twice.
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.
addPartitionLostListener
in interface IMap<K,V>
listener
- the added MapPartitionLostListenerIMap.removePartitionLostListener(String)
,
PartitionLostListener
public boolean removePartitionLostListener(String registrationId)
IMap
Returns silently if there is no such listener was added before.
removePartitionLostListener
in interface IMap<K,V>
registrationId
- ID of registered listenerpublic String addEntryListener(MapListener listener, K key, boolean includeValue)
IMap
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.
addEntryListener
in interface IMap<K,V>
listener
- MapListener
for this mapkey
- key to listen forincludeValue
- true
if EntryEvent
should contain the valueMapListener
public String addEntryListener(EntryListener listener, K key, boolean includeValue)
IMap
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.
addEntryListener
in interface IMap<K,V>
listener
- specified entry listenerkey
- key to listen forincludeValue
- true
if EntryEvent
should contain the valuepublic String addEntryListener(MapListener listener, Predicate<K,V> predicate, K key, boolean includeValue)
IMap
MapListener
for this map.
To receive an event, you should implement a corresponding MapListener
sub-interface for that event.
addEntryListener
in interface IMap<K,V>
listener
- the continuous MapListener
for this mappredicate
- predicate for filtering entrieskey
- key to listen forincludeValue
- true
if EntryEvent
should contain the valueMapListener
public String addEntryListener(EntryListener listener, Predicate<K,V> predicate, K key, boolean includeValue)
IMap
The listener will get notified for map add/remove/update/evict events filtered by the given predicate.
addEntryListener
in interface IMap<K,V>
listener
- the continuous entry listener for this mappredicate
- predicate for filtering entrieskey
- key to listen forincludeValue
- true
if EntryEvent
should contain the valuepublic String addEntryListener(MapListener listener, Predicate<K,V> predicate, boolean includeValue)
IMap
MapListener
for this map.
To receive an event, you should implement a corresponding MapListener
sub-interface for that event.
addEntryListener
in interface IMap<K,V>
listener
- the added continuous MapListener
for this mappredicate
- predicate for filtering entriesincludeValue
- true
if EntryEvent
should contain the valueMapListener
public String addEntryListener(EntryListener listener, Predicate<K,V> predicate, boolean includeValue)
IMap
The listener will get notified for map add/remove/update/evict events filtered by the given predicate.
addEntryListener
in interface IMap<K,V>
listener
- the added continuous entry listener for this mappredicate
- predicate for filtering entriesincludeValue
- true
if EntryEvent
should contain the valuepublic EntryView<K,V> getEntryView(K key)
IMap
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.
getEntryView
in interface IMap<K,V>
key
- the key of the entryEntryView
of the specified keyEntryView
public boolean evict(K key)
IMap
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.
protected boolean evictInternal(Object key)
public void evictAll()
IMap
If a MapStore
is defined for this map, deleteAll is not called by this method.
If you do want to deleteAll to be called use the IMap.clear()
method.
The EVICT_ALL event is fired for any registered listeners.
See MapEvictedListener.mapEvicted(MapEvent)
.
evictAll
in interface IMap<K,V>
IMap.clear()
public void loadAll(boolean replaceExistingValues)
IMap
public void loadAll(Set<K> keys, boolean replaceExistingValues)
IMap
protected void loadAllInternal(boolean replaceExistingValues, Collection<?> keys)
public Set<K> keySet()
IMap
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.
public Map<K,V> getAll(Set<K> keys)
IMap
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.
protected void getAllInternal(Set<K> keys, Map<Integer,List<Data>> partitionToKeyData, List<Object> resultingKeyValuePairs)
protected void fillPartitionToKeyData(Set<K> keys, Map<Integer,List<Data>> partitionToKeyData, Map<Object,Data> keyMap, Map<Data,Object> reverseKeyMap)
public Collection<V> values()
IMap
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.
public Set<Map.Entry<K,V>> entrySet()
IMap
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.
public Set<K> keySet(Predicate predicate)
IMap
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.
public Set<Map.Entry<K,V>> entrySet(Predicate predicate)
IMap
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.
entrySet
in interface IMap<K,V>
predicate
- specified query criteriaGroupProperty.QUERY_RESULT_SIZE_LIMIT
public Collection<V> values(Predicate predicate)
IMap
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.
public Set<K> localKeySet()
IMap
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.
localKeySet
in interface IMap<K,V>
GroupProperty.QUERY_RESULT_SIZE_LIMIT
public Set<K> localKeySet(Predicate predicate)
IMap
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.
localKeySet
in interface IMap<K,V>
predicate
- specified query criteriaGroupProperty.QUERY_RESULT_SIZE_LIMIT
public void addIndex(String attribute, boolean ordered)
IMap
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 rangeIndex 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.
public LocalMapStats getLocalMapStats()
IMap
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.
getLocalMapStats
in interface IMap<K,V>
public Object executeOnKey(K key, EntryProcessor entryProcessor)
IMap
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:
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.
executeOnKey
in interface IMap<K,V>
Offloadable
,
ReadOnly
public Object executeOnKeyInternal(Object key, EntryProcessor entryProcessor)
public void submitToKey(K key, EntryProcessor entryProcessor, ExecutionCallback callback)
IMap
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:
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.
submitToKey
in interface IMap<K,V>
key
- key to be processedentryProcessor
- processor to process the keycallback
- to listen whether operation is finished or notOffloadable
,
ReadOnly
public void submitToKeyInternal(Object key, EntryProcessor entryProcessor, ExecutionCallback callback)
public ICompletableFuture submitToKey(K key, EntryProcessor entryProcessor)
IMap
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:
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.
submitToKey
in interface IMap<K,V>
submitToKey
in interface LegacyAsyncMap<K,V>
key
- key to be processedentryProcessor
- processor to process the keyOffloadable
,
ReadOnly
,
ICompletableFuture
public ICompletableFuture submitToKeyInternal(Object key, EntryProcessor entryProcessor)
public Map<K,Object> executeOnEntries(EntryProcessor entryProcessor)
IMap
executeOnEntries
in interface IMap<K,V>
public Map<K,Object> executeOnEntries(EntryProcessor entryProcessor, Predicate predicate)
IMap
executeOnEntries
in interface IMap<K,V>
public <R> R aggregate(Aggregator<Map.Entry<K,V>,R> aggregator)
IMap
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.
public <R> R aggregate(Aggregator<Map.Entry<K,V>,R> aggregator, Predicate<K,V> predicate)
IMap
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.
public <R> Collection<R> project(Projection<Map.Entry<K,V>,R> projection)
IMap
public <R> Collection<R> project(Projection<Map.Entry<K,V>,R> projection, Predicate<K,V> predicate)
IMap
public <SuppliedValue,Result> Result aggregate(Supplier<K,V,SuppliedValue> supplier, Aggregation<K,SuppliedValue,Result> aggregation)
IMap
Supplier
is used to either select or to select and extract a (sub-)value. A predefined set of aggregations can be found in
Aggregations
.aggregate
in interface IMap<K,V>
SuppliedValue
- the final type emitted from the supplierResult
- the resulting aggregation value typesupplier
- the supplier to select and / or extract a (sub-)value from the mapaggregation
- the aggregation that is being executed against the mappublic <SuppliedValue,Result> Result aggregate(Supplier<K,V,SuppliedValue> supplier, Aggregation<K,SuppliedValue,Result> aggregation, JobTracker jobTracker)
IMap
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
.
aggregate
in interface IMap<K,V>
SuppliedValue
- the final type emitted from the supplierResult
- the resulting aggregation value typesupplier
- the supplier to select and / or extract a (sub-)value from the mapaggregation
- the aggregation that is being executed against the mapjobTracker
- the JobTracker
instance to execute the aggregationpublic QueryCache<K,V> getQueryCache(String name)
IMap
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.
getQueryCache
in interface IMap<K,V>
name
- the name of QueryCache
QueryCache
instance or null if there is no corresponding QueryCacheConfig
QueryCache
public QueryCache<K,V> getQueryCache(String name, Predicate<K,V> predicate, boolean includeValue)
IMap
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
.
getQueryCache
in interface IMap<K,V>
name
- the name of QueryCache
predicate
- the predicate for filtering entriesincludeValue
- true
if this QueryCache
is allowed to cache values of entries, otherwise false
QueryCache
instance with the supplied name
QueryCache
public QueryCache<K,V> getQueryCache(String name, MapListener listener, Predicate<K,V> predicate, boolean includeValue)
IMap
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
.
getQueryCache
in interface IMap<K,V>
name
- the name of QueryCache
listener
- the MapListener
which will be used to listen this QueryCache
predicate
- the predicate for filtering entriesincludeValue
- true
if this QueryCache
is allowed to cache values of entries, otherwise false
QueryCache
instance with the supplied name
QueryCache
public Map<K,Object> executeOnKeys(Set<K> keys, EntryProcessor entryProcessor)
IMap
executeOnKeys
in interface IMap<K,V>
public void set(K key, V value)
IMap
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.
public int size()
BaseMap
public boolean isEmpty()
BaseMap
public void putAll(Map<? extends K,? extends V> map)
IMap
No atomicity guarantees are given. It could be that in case of failure some of the key/value-pairs get written, while others are not.
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.
protected void putAllInternal(Map<? extends K,? extends V> map, Map<Integer,List<Map.Entry<Data,Data>>> entryMap)
public void clear()
IMap
MapStore.deleteAll(java.util.Collection<K>)
deleteAll on MapStore which,
if connected to a database, will delete the records from that database.
The MAP_CLEARED event is fired for any registered listeners.
See MapClearedListener.mapCleared(MapEvent)
.
To clear a map without calling MapStore.deleteAll(java.util.Collection<K>)
, use IMap.evictAll()
.
public Iterator<Map.Entry<K,V>> iterator(int fetchSize, int partitionId, boolean prefetchValues)
partitionId
. If prefetchValues
is
true
, all values will be sent along with the keys and no additional data will be fetched when
iterating. If false
, the values will be fetched when iterating the entries.
The values are not fetched one-by-one but rather in batches.
You may control the size of the batch by changing the fetchSize
parameter.
A too small fetchSize
can affect performance since more data will have to be sent to and from the partition owner.
A too high fetchSize
means that more data will be sent which can block other operations from being sent,
including internal operations.
The underlying implementation may send more values in one batch than fetchSize
if it needs to get to
a "safepoint" to later resume iteration.
NOTE
Iterating the map should be done only when the IMap
is not being
mutated and the cluster is stable (there are no migrations or membership changes).
In other cases, the iterator may not return some entries or may return an entry twice.
fetchSize
- the size of the batches which will be sent when iterating the datapartitionId
- the partition ID which is being iteratedpublic <R> Iterator<R> iterator(int fetchSize, int partitionId, Projection<Map.Entry<K,V>,R> projection, Predicate<K,V> predicate)
partitionId
which
satisfy the predicate
. The Iterator.remove()
method is not supported and will throw an
UnsupportedOperationException
.
The values are not fetched one-by-one but rather in batches.
You may control the size of the batch by changing the fetchSize
parameter.
A too small fetchSize
can affect performance since more data will have to be sent to and from the partition owner.
A too high fetchSize
means that more data will be sent which can block other operations from being sent,
including internal operations.
The underlying implementation may send more values in one batch than fetchSize
if it needs to get to
a "safepoint" to later resume iteration.
Predicates of type PagingPredicate
are not supported.
NOTE
Iterating the map should be done only when the IMap
is not being
mutated and the cluster is stable (there are no migrations or membership changes).
In other cases, the iterator may not return some entries or may return an entry twice.
R
- the return typefetchSize
- the size of the batches which will be sent when iterating the datapartitionId
- the partition ID which is being iteratedprojection
- the projection to apply before returning the value. null
value is not allowedpredicate
- the predicate which the entries must match. null
value is not allowedUnsupportedOperationException
- if Iterator.remove()
is invokedIllegalArgumentException
- if the predicate is of type PagingPredicate
public ICompletableFuture<EventJournalInitialSubscriberState> subscribeToEventJournal(int partitionId)
EventJournalReader
subscribeToEventJournal
in interface EventJournalReader<EventJournalMapEvent<K,V>>
partitionId
- the partition ID of the entries to which we are subscribingpublic <T> ICompletableFuture<ReadResultSet<T>> readFromEventJournal(long startSequence, int minSize, int maxSize, int partitionId, Predicate<? super EventJournalMapEvent<K,V>> predicate, Projection<? super EventJournalMapEvent<K,V>,T> projection)
EventJournalReader
UnsupportedOperationException
if the cluster version is lower than 3.9 or there is no event journal configured for this data structure.
NOTE:
Configuring evictions may cause unexpected results when reading from the event journal and
there are cluster changes (a backup replica is promoted into a partition owner). See
MapEventJournal
or
CacheEventJournal
for more details.
readFromEventJournal
in interface EventJournalReader<EventJournalMapEvent<K,V>>
T
- the return type of the projection. It is equal to the journal event type
if the projection is null
or it is the identity projectionstartSequence
- the sequence of the first item to readmaxSize
- the maximum number of items to readpartitionId
- the partition ID of the entries in the journalpredicate
- the predicate which the events must pass to be included in the response.
May be null
in which case all events pass the predicateprojection
- the projection which is applied to the events before returning.
May be null
in which case the event is returned without being projectedpublic ClientQueryCacheContext getQueryCacheContext()
protected void onDestroy()
ClientProxy
onDestroy
in class ClientProxy
Copyright © 2017 Hazelcast, Inc.. All Rights Reserved.