com.hazelcast.client.impl.protocol.template

Interface ReplicatedMapCodecTemplate

public interface ReplicatedMapCodecTemplate

Method Summary

Methods

Modifier and Type	Method and Description
Object	addEntryListener(String name, boolean localOnly) Adds an entry listener for this map.
Object	addEntryListenerToKey(String name, Data key, boolean localOnly) Adds the specified entry listener for the specified key.
Object	addEntryListenerToKeyWithPredicate(String name, Data key, Data predicate, boolean localOnly) Adds an continuous entry listener for this map.
Object	addEntryListenerWithPredicate(String name, Data predicate, boolean localOnly) Adds an continuous entry listener for this map.
Object	addNearCacheEntryListener(String name, boolean includeValue, boolean localOnly)
void	clear(String name) The clear operation wipes data out of the replicated maps.It is the only synchronous remote operation in this implementation, so be aware that this might be a slow operation.
Object	containsKey(String name, Data key) Returns true if this map contains a mapping for the specified key.
Object	containsValue(String name, Data value) Returns true if this map maps one or more keys to the specified value.
Object	entrySet(String name)
Object	get(String name, Data key) Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
Object	isEmpty(String name) Return true if this map contains no key-value mappings
Object	keySet(String name) Returns a lazy Set view of the key contained in this map.
Object	put(String name, Data key, Data value, long ttl) Associates a given value to the specified key and replicates it to the cluster.
void	putAll(String name, List<Map.Entry<Data,Data>> entries) Copies all of the mappings from the specified map to this map (optional operation).
Object	remove(String name, Data key) Removes the mapping for a key from this map if it is present (optional operation).
Object	removeEntryListener(String name, String registrationId) Removes the specified entry listener.
Object	size(String name) Returns the number of key-value mappings in this map.
Object	values(String name)

Method Detail

put

Object put(String name,
         Data key,
         Data value,
         long ttl)

Associates a given value to the specified key and replicates it to the cluster. If there is an old value, it will be replaced by the specified one and returned from the call. In addition, you have to specify a ttl and its TimeUnit to define when the value is outdated and thus should be removed from the replicated map.

Parameters:

name - Name of the ReplicatedMap

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

value - Value to be associated with the specified key

ttl - ttl in milliseconds to be associated with the specified key-value pair

Returns:

The old value if existed for the key.

size

Object size(String name)

Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Parameters:

name - Name of the ReplicatedMap

Returns:

the number of key-value mappings in this map.

isEmpty

Object isEmpty(String name)

Return true if this map contains no key-value mappings

Parameters:

name - Name of the ReplicatedMap

Returns:

True if this map contains no key-value mappings

containsKey

Object containsKey(String name,
                 Data key)

Returns true if this map contains a mapping for the specified key.

Parameters:

name - Name of the ReplicatedMap

key - The key whose associated value is to be returned.

Returns:

True if this map contains a mapping for the specified key

containsValue

Object containsValue(String name,
                   Data value)

Returns true if this map maps one or more keys to the specified value. This operation will probably require time linear in the map size for most implementations of the Map interface.

Parameters:

name - Name of the ReplicatedMap

value - value whose presence in this map is to be tested

Returns:

true if this map maps one or more keys to the specified value

get

Object get(String name,
         Data key)

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key. If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The #containsKey operation may be used to distinguish these two cases.

Parameters:

name - Name of the ReplicatedMap

key - The key whose associated value is to be returned

Returns:

The value to which the specified key is mapped, or null if this map contains no mapping for the key

remove

Object remove(String name,
            Data key)

Removes the mapping for a key from this map if it is present (optional operation). Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key. If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null. The map will not contain a mapping for the specified key once the call returns.

Parameters:

name - Name of the ReplicatedMap

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

Returns:

the previous value associated with key, or null if there was no mapping for key.

putAll

void putAll(String name,
          List<Map.Entry<Data,Data>> entries)

Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling put(Object,Object) put(k, v) on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress.

Parameters:

name - Name of the ReplicatedMap

entries - entries to be stored in this map

clear

void clear(String name)

The clear operation wipes data out of the replicated maps.It is the only synchronous remote operation in this implementation, so be aware that this might be a slow operation. If some node fails on executing the operation, it is retried for at most 3 times (on the failing nodes only). If it does not work after the third time, this method throws a OPERATION_TIMEOUT back to the caller.

Parameters:

name - Name of the Replicated Map

addEntryListenerToKeyWithPredicate

Object addEntryListenerToKeyWithPredicate(String name,
                                        Data key,
                                        Data predicate,
                                        boolean localOnly)

Adds an continuous entry listener for this map. The listener will be notified for map add/remove/update/evict events filtered by the given predicate.

Parameters:

name - Name of the Replicated Map

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

predicate - The predicate for filtering entries

localOnly - if true fires events that originated from this node only, otherwise fires all events

Returns:

A unique string which is used as a key to remove the listener.

addEntryListenerWithPredicate

Object addEntryListenerWithPredicate(String name,
                                   Data predicate,
                                   boolean localOnly)

Adds an continuous entry listener for this map. The listener will be notified for map add/remove/update/evict events filtered by the given predicate.

Parameters:

name - Name of the Replicated Map

predicate - The predicate for filtering entries

localOnly - if true fires events that originated from this node only, otherwise fires all events

Returns:

A unique string which is used as a key to remove the listener.

addEntryListenerToKey

Object addEntryListenerToKey(String name,
                           Data key,
                           boolean localOnly)

Adds the specified entry listener for the specified key. The listener will be notified for all add/remove/update/evict events of the specified key only.

Parameters:

name - Name of the Replicated Map

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

localOnly - if true fires events that originated from this node only, otherwise fires all events

Returns:

A unique string which is used as a key to remove the listener.

addEntryListener

Object addEntryListener(String name,
                      boolean localOnly)

Adds an entry listener for this map. The listener will be notified for all map add/remove/update/evict events.

Parameters:

name - Name of the ReplicatedMap

localOnly - if true fires events that originated from this node only, otherwise fires all events

Returns:

A unique string which is used as a key to remove the listener.

removeEntryListener

Object removeEntryListener(String name,
                         String registrationId)

Removes the specified entry listener. Returns silently if there was no such listener added before.

Parameters:

name - Name of the ReplicatedMap

registrationId - ID of the registered entry listener.

Returns:

True if registration is removed, false otherwise.

keySet

Object keySet(String name)

Returns a lazy Set view of the key contained in this map. A LazySet is optimized for querying speed (preventing eager deserialization and hashing on HashSet insertion) and does NOT provide all operations. Any kind of mutating function will throw an UNSUPPORTED_OPERATION. Same is true for operations like java.util.Set#contains(Object) and java.util.Set#containsAll(java.util.Collection) which would result in very poor performance if called repeatedly (for example, in a loop). If the use case is different from querying the data, please copy the resulting set into a new java.util.HashSet.

Parameters:

name - Name of the ReplicatedMap

Returns:

A lazy set view of the keys contained in this map.

values

Object values(String name)

Parameters:

name - Name of the ReplicatedMap

Returns:

A collection view of the values contained in this map.

entrySet

Object entrySet(String name)

Parameters:

name - Name of the ReplicatedMap

Returns:

A lazy set view of the mappings contained in this map.

addNearCacheEntryListener

Object addNearCacheEntryListener(String name,
                               boolean includeValue,
                               boolean localOnly)

Parameters:

name - Name of the ReplicatedMap

includeValue - True if EntryEvent should contain the value,false otherwise

localOnly - if true fires events that originated from this node only, otherwise fires all events

Returns:

A unique string which is used as a key to remove the listener.