com.hazelcast.client.impl.protocol.template

Interface TransactionalMultiMapCodecTemplate

public interface TransactionalMultiMapCodecTemplate

Method Summary

Methods

Modifier and Type	Method and Description
Object	get(String name, String txnId, long threadId, Data key) Returns the collection of values associated with the key.
Object	put(String name, String txnId, long threadId, Data key, Data value) Stores a key-value pair in the multimap.
Object	remove(String name, String txnId, long threadId, Data key) Removes the given key value pair from the multimap.
Object	removeEntry(String name, String txnId, long threadId, Data key, Data value) Removes all the entries associated with the given key.
Object	size(String name, String txnId, long threadId) Returns the number of key-value pairs in the multimap.
Object	valueCount(String name, String txnId, long threadId, Data key) Returns the number of values matching the given key in the multimap.

Method Detail

put

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

Stores a key-value pair in the multimap.

Parameters:

name - Name of the Transactional Multi Map

txnId - ID of the transaction

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.

key - The key to be stored

value - The value to be stored

Returns:

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

get

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

Returns the collection of values associated with the key.

Parameters:

name - Name of the Transactional Multi Map

txnId - ID of the transaction

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.

key - The key whose associated values are returned

Returns:

The collection of the values associated with the key

remove

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

Removes the given key value pair from the multimap.

Parameters:

name - Name of the Transactional Multi Map

txnId - ID of the transaction

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.

key - The key whose associated values are returned

Returns:

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

removeEntry

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

Removes all the entries associated with the given key.

Parameters:

name - Name of the Transactional Multi Map

txnId - ID of the this transaction operation

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.

key - The key whose associated values are returned

value - The value to be stored

Returns:

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

valueCount

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

Returns the number of values matching the given key in the multimap.

Parameters:

name - Name of the Transactional Multi Map

txnId - ID of the this transaction operation

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.

key - The key whose number of values are returned

Returns:

The number of values matching the given key in the multimap

size

Object size(String name,
          String txnId,
          long threadId)

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

Parameters:

name - Name of the Transactional Multi Map

txnId - ID of the this transaction operation

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 key-value pairs in the multimap