com.hazelcast.client.impl.protocol.template

Interface TransactionalMapCodecTemplate

public interface TransactionalMapCodecTemplate

Method Summary

Methods

Modifier and Type	Method and Description
Object	containsKey(String name, String txnId, long threadId, Data key) Returns true if this map contains an entry for the specified key.
void	delete(String name, String txnId, long threadId, Data key) Removes the mapping for a key from this map if it is present.
Object	get(String name, String txnId, long threadId, Data key) Returns the value for the specified key, or null if this map does not contain this key.
Object	getForUpdate(String name, String txnId, long threadId, Data key) Locks the key and then gets and returns the value to which the specified key is mapped.
Object	isEmpty(String name, String txnId, long threadId) Returns true if this map contains no entries.
Object	keySet(String name, String txnId, long threadId) Returns a set clone of the keys contained in this map.
Object	keySetWithPredicate(String name, String txnId, long threadId, Data predicate) Queries the map based on the specified predicate and returns the keys of matching entries.
Object	put(String name, String txnId, long threadId, Data key, Data value, long ttl) Associates the specified value with the specified key in this map.
Object	putIfAbsent(String name, String txnId, long threadId, Data key, Data value) If the specified key is not already associated with a value, associate it with the given value.
Object	remove(String name, String txnId, long threadId, Data key) Removes the mapping for a key from this map if it is present.
Object	removeIfSame(String name, String txnId, long threadId, Data key, Data value) Removes the entry for a key only if currently mapped to a given value.
Object	replace(String name, String txnId, long threadId, Data key, Data value) Replaces the entry for a key only if it is currently mapped to some value.
Object	replaceIfSame(String name, String txnId, long threadId, Data key, Data oldValue, Data newValue) Replaces the entry for a key only if currently mapped to a given value.
void	set(String name, String txnId, long threadId, Data key, Data value) Associates the specified value with the specified key in this map.
Object	size(String name, String txnId, long threadId) Returns the number of entries in this map.
Object	values(String name, String txnId, long threadId) Returns a collection clone of the values contained in this map.
Object	valuesWithPredicate(String name, String txnId, long threadId, Data predicate) Queries the map based on the specified predicate and returns the values of matching entries.Specified predicate runs on all members in parallel.

Method Detail

containsKey

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

Returns true if this map contains an entry for the specified key.

Parameters:

name - Name of the Transactional 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 specified key.

Returns:

True if this map contains an entry for the specified key.

get

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

Returns the value for the specified key, or null if this map does not contain this key.

Parameters:

name - Name of the Transactional 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 specified key

Returns:

The value for the specified key

getForUpdate

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

Locks the key and then gets and returns the value to which the specified key is mapped. Lock will be released at the end of the transaction (either commit or rollback).

Parameters:

name - Name of the Transactional 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 value to which the specified key is mapped

Returns:

The value for the specified key

size

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

Returns the number of entries in this map.

Parameters:

name - Name of the Transactional 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 entries in this map.

isEmpty

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

Returns true if this map contains no entries.

Parameters:

name - Name of the Transactional 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:

true if this map contains no entries.

put

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

Associates the specified value with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced by the specified value. The object to be put will be accessible only in the current transaction context till transaction is committed.

Parameters:

name - Name of the Transactional 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 specified key

value - The value to associate with the key.

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

Returns:

Previous value associated with key or null if there was no mapping for key

set

void set(String name,
       String txnId,
       long threadId,
       Data key,
       Data value)

Associates the specified value with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced by the specified value. This method is preferred to #put(Object, Object) if the old value is not needed. The object to be set will be accessible only in the current transaction context until the transaction is committed.

Parameters:

name - Name of the Transactional 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 specified key

value - The value to associate with key

putIfAbsent

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

If the specified key is not already associated with a value, associate it with the given value. The object to be put will be accessible only in the current transaction context until the transaction is committed.

Parameters:

name - Name of the Transactional 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 specified key

value - The value to associate with the key when there is no previous value.

Returns:

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

replace

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

Replaces the entry for a key only if it is currently mapped to some value. The object to be replaced will be accessible only in the current transaction context until the transaction is committed.

Parameters:

name - Name of the Transactional 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 specified key

value - The value replaced the previous value

Returns:

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

replaceIfSame

Object replaceIfSame(String name,
                   String txnId,
                   long threadId,
                   Data key,
                   Data oldValue,
                   Data newValue)

Replaces the entry for a key only if currently mapped to a given value. The object to be replaced will be accessible only in the current transaction context until the transaction is committed.

Parameters:

name - Name of the Transactional 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 specified key.

oldValue - Replace the key value if it is the old value.

newValue - The new value to replace the old value.

Returns:

true if the value was replaced.

remove

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

Removes the mapping for a key from this map if it is present. The map will not contain a mapping for the specified key once the call returns. The object to be removed will be accessible only in the current transaction context until the transaction is committed.

Parameters:

name - Name of the Transactional 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 - Remove the mapping for this key.

Returns:

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

delete

void delete(String name,
          String txnId,
          long threadId,
          Data key)

Removes the mapping for a key from this map if it is present. The map will not contain a mapping for the specified key once the call returns. This method is preferred to #remove(Object) if the old value is not needed. The object to be deleted will be removed from only the current transaction context until the transaction is committed.

Parameters:

name - Name of the Transactional 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 - Remove the mapping for this key.

removeIfSame

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

Removes the entry for a key only if currently mapped to a given value. The object to be removed will be removed from only the current transaction context until the transaction is committed.

Parameters:

name - Name of the Transactional 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 specified key

value - Remove the key if it has this value.

Returns:

True if the value was removed

keySet

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

Returns a set clone of the keys contained in this map. 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 query result size limit is configured.

Parameters:

name - Name of the Transactional 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:

A set clone of the keys contained in this map.

See Also:

GroupProperty.QUERY_RESULT_SIZE_LIMIT

keySetWithPredicate

Object keySetWithPredicate(String name,
                         String txnId,
                         long threadId,
                         Data predicate)

Queries the map based on the specified predicate and returns the keys of matching entries. Specified predicate runs on all members in parallel.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 query result size limit is configured.

Parameters:

name - Name of the Transactional 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.

predicate - Specified query criteria.

Returns:

Result key set for the query.

See Also:

GroupProperty.QUERY_RESULT_SIZE_LIMIT

values

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

Returns a collection clone of the values contained in this map. 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 query result size limit is configured.

Parameters:

name - Name of the Transactional 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:

All values in the map

See Also:

GroupProperty.QUERY_RESULT_SIZE_LIMIT

valuesWithPredicate

Object valuesWithPredicate(String name,
                         String txnId,
                         long threadId,
                         Data predicate)

Queries the map based on the specified predicate and returns the values of matching entries.Specified predicate runs on all members in parallel. 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 query result size limit is configured.

Parameters:

name - Name of the Transactional 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.

predicate - Specified query criteria.

Returns:

Result value collection of the query.

See Also:

GroupProperty.QUERY_RESULT_SIZE_LIMIT