com.hazelcast.client.impl.protocol.template

Interface MultiMapCodecTemplate

public interface MultiMapCodecTemplate

Method Summary

Modifier and Type	Method and Description
Object	addEntryListener(String name, boolean includeValue, boolean localOnly) Adds an entry listener for this multimap.
Object	addEntryListenerToKey(String name, Data key, boolean includeValue, boolean localOnly) Adds the specified entry listener for the specified key.The listener will be notified for all add/remove/update/evict events for the specified key only.
void	clear(String name) Clears the multimap.
Object	containsEntry(String name, Data key, Data value, long threadId) Returns whether the multimap contains the given key-value pair.
Object	containsKey(String name, Data key, long threadId) Returns whether the multimap contains an entry with the key.
Object	containsValue(String name, Data value) Returns whether the multimap contains an entry with the value.
void	delete(String name, Data key, long threadId) Removes all the entries with the given key.
Object	entrySet(String name) Returns the set of key-value pairs in the multimap.The collection is NOT backed by the map, so changes to the map are NOT reflected in the collection, and vice-versa
void	forceUnlock(String name, Data key, long referenceId) Releases the lock for the specified key regardless of the lock owner.
Object	get(String name, Data key, long threadId) Returns the collection of values associated with the key.
Object	isLocked(String name, Data key) Checks the lock for the specified key.
Object	keySet(String name) Returns the set of keys in the multimap.The collection is NOT backed by the map, so changes to the map are NOT reflected in the collection, and vice-versa.
void	lock(String name, Data key, long threadId, long ttl, long referenceId) Acquires the lock for the specified key for the specified lease time.
Object	put(String name, Data key, Data value, long threadId) Stores a key-value pair in the multimap.
Object	remove(String name, Data key, long threadId) Removes the given key value pair from the multimap.
Object	removeEntry(String name, Data key, Data value, long threadId) Removes all the entries with the given key.
Object	removeEntryListener(String name, String registrationId) Removes the specified entry listener.
Object	size(String name) Returns the number of key-value pairs in the multimap.
Object	tryLock(String name, Data key, long threadId, long lease, long timeout, long referenceId) Tries to acquire the lock for the specified key for the specified lease time.
void	unlock(String name, Data key, long threadId, long referenceId) Releases the lock for the specified key regardless of the lock owner.
Object	valueCount(String name, Data key, long threadId) Returns the number of values that match the given key in the multimap.
Object	values(String name) Returns the collection of values in the multimap.The collection is NOT backed by the map, so changes to the map are NOT reflected in the collection, and vice-versa.

Method Detail

put

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

Stores a key-value pair in the multimap.

Parameters:

name - Name of the MultiMap

key - The key to be stored

value - The value to be stored

threadId - The id of the user thread performing the operation. It is used to guarantee that only the lock holder thread (if a lock exists on the entry) can perform the requested operation.

Returns:

True if size of the multimap is increased, false if the multimap already contains the key-value pair.

get

Object get(String name,
           Data key,
           long threadId)

Returns the collection of values associated with the key. The collection is NOT backed by the map, so changes to the map are NOT reflected in the collection, and vice-versa.

Parameters:

name - Name of the MultiMap

key - The key whose associated values are to be returned

threadId - The id of the user thread performing the operation. It is used to guarantee that only the lock holder thread (if a lock exists on the entry) can perform the requested operation.

Returns:

The collection of the values associated with the key.

remove

Object remove(String name,
              Data key,
              long threadId)

Removes the given key value pair from the multimap.

Parameters:

name - Name of the MultiMap

key - The key of the entry to remove

threadId - The id of the user thread performing the operation. It is used to guarantee that only the lock holder thread (if a lock exists on the entry) can perform the requested operation.

Returns:

True if the size of the multimap changed after the remove operation, false otherwise.

keySet

Object keySet(String name)

Returns the set of keys in the multimap.The collection is NOT backed by the map, so changes to the map are NOT reflected in the collection, and vice-versa.

Parameters:

name - Name of the MultiMap

Returns:

The set of keys in the multimap. The returned set might be modifiable but it has no effect on the multimap.

values

Object values(String name)

Returns the collection of values in the multimap.The collection is NOT backed by the map, so changes to the map are NOT reflected in the collection, and vice-versa.

Parameters:

name - Name of the MultiMap

Returns:

The collection of values in the multimap. the returned collection might be modifiable but it has no effect on the multimap.

entrySet

Object entrySet(String name)

Returns the set of key-value pairs in the multimap.The collection is NOT backed by the map, so changes to the map are NOT reflected in the collection, and vice-versa

Parameters:

name - Name of the MultiMap

Returns:

The set of key-value pairs in the multimap. The returned set might be modifiable but it has no effect on the multimap.

containsKey

Object containsKey(String name,
                   Data key,
                   long threadId)

Returns whether the multimap contains an entry with the key.

Parameters:

name - Name of the MultiMap

key - The key whose existence is checked.

threadId - The id of the user thread performing the operation. It is used to guarantee that only the lock holder thread (if a lock exists on the entry) can perform the requested operation.

Returns:

True if the multimap contains an entry with the key, false otherwise.

containsValue

Object containsValue(String name,
                     Data value)

Returns whether the multimap contains an entry with the value.

Parameters:

name - Name of the MultiMap

value - The value whose existence is checked.

Returns:

True if the multimap contains an entry with the value, false otherwise.

containsEntry

Object containsEntry(String name,
                     Data key,
                     Data value,
                     long threadId)

Returns whether the multimap contains the given key-value pair.

Parameters:

name - Name of the MultiMap

key - The key whose existence is checked.

value - The value whose existence is checked.

threadId - The id of the user thread performing the operation. It is used to guarantee that only the lock holder thread (if a lock exists on the entry) can perform the requested operation

Returns:

True if the multimap contains the key-value pair, false otherwise.

size

Object size(String name)

Returns the number of key-value pairs in the multimap.

Parameters:

name - Name of the MultiMap

Returns:

The number of key-value pairs in the multimap.

clear

void clear(String name)

Clears the multimap. Removes all key-value pairs.

Parameters:

name - Name of the MultiMap

valueCount

Object valueCount(String name,
                  Data key,
                  long threadId)

Returns the number of values that match the given key in the multimap.

Parameters:

name - Name of the MultiMap

key - The key whose values count is to be returned

threadId - The id of the user thread performing the operation. It is used to guarantee that only the lock holder thread (if a lock exists on the entry) can perform the requested operation

Returns:

The number of values that match the given key in the multimap

addEntryListenerToKey

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

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

Parameters:

name - Name of the MultiMap

key - The key to listen to

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:

Returns registration id for the entry listener

addEntryListener

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

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

Parameters:

name - Name of the MultiMap

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:

Returns registration id for the entry listener

removeEntryListener

Object removeEntryListener(String name,
                           String registrationId)

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

Parameters:

name - Name of the MultiMap

registrationId - Registration id of listener

Returns:

True if registration is removed, false otherwise

lock

void lock(String name,
          Data key,
          long threadId,
          long ttl,
          @Since(value="1.2")
          long referenceId)

Acquires the lock for the specified key for the specified lease time. After the 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 for this map only. The 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.

Parameters:

name - Name of the MultiMap

key - The key the Lock

threadId - The id of the user thread performing the operation. It is used to guarantee that only the lock holder thread (if a lock exists on the entry) can perform the requested operation

ttl - The duration in milliseconds after which this entry shall be deleted. O means infinite.

referenceId - The client-wide unique id for this request. It is used to make the request idempotent by sending the same reference id during retries.

tryLock

Object tryLock(String name,
               Data key,
               long threadId,
               long lease,
               long timeout,
               @Since(value="1.2")
               long referenceId)

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.

Parameters:

name - Name of the MultiMap

key - Key to lock in this map.

threadId - The id of the user thread performing the operation. It is used to guarantee that only the lock holder thread (if a lock exists on the entry) can perform the requested operation

lease - Time in milliseconds to wait before releasing the lock.

timeout - Maximum time to wait for the lock.

referenceId - The client-wide unique id for this request. It is used to make the request idempotent by sending the same reference id during retries.

Returns:

True if the lock was acquired and false if the waiting time elapsed before the lock acquired

isLocked

Object isLocked(String name,
                Data key)

Checks the lock for the specified key. If the lock is acquired, this method returns true, else it returns false.

Parameters:

name - Name of the MultiMap

key - Key to lock to be checked.

Returns:

True if the lock acquired,false otherwise

unlock

void unlock(String name,
            Data key,
            long threadId,
            @Since(value="1.2")
            long referenceId)

Releases the lock for the specified key regardless of the lock owner. It always successfully unlocks the key, never blocks and returns immediately.

Parameters:

name - Name of the MultiMap

key - The key to Lock

threadId - The id of the user thread performing the operation. It is used to guarantee that only the lock holder thread (if a lock exists on the entry) can perform the requested operation

referenceId - The client-wide unique id for this request. It is used to make the request idempotent by sending the same reference id during retries.

forceUnlock

void forceUnlock(String name,
                 Data key,
                 @Since(value="1.2")
                 long referenceId)

Releases the lock for the specified key regardless of the lock owner. It always successfully unlocks the key, never blocks and returns immediately.

Parameters:

name - Name of the MultiMap

key - The key to Lock

referenceId - The client-wide unique id for this request. It is used to make the request idempotent by sending the same reference id during retries.

removeEntry

Object removeEntry(String name,
                   Data key,
                   Data value,
                   long threadId)

Removes all the entries with the given key. The collection is NOT backed by the map, so changes to the map are NOT reflected in the collection, and vice-versa.

Parameters:

name - Name of the MultiMap

key - The key of the entry to remove

value - The value of the entry to remove

threadId - The id of the user thread performing the operation. It is used to guarantee that only the lock holder thread (if a lock exists on the entry) can perform the requested operation

Returns:

True if the size of the multimap changed after the remove operation, false otherwise.

delete

@Since(value="1.6")
void delete(String name,
                                Data key,
                                long threadId)

Removes all the entries with the given key.

Parameters:

name - Name of the MultiMap

key - The key of the entry to remove

threadId - The id of the user thread performing the operation. It is used to guarantee that only the lock holder thread (if a lock exists on the entry) can perform the requested operation