com.hazelcast.core
Interface BaseMap<K,V>

Type Parameters:

K - Key

V - Value

All Superinterfaces:

DistributedObject

All Known Subinterfaces:

IMap<K,V>, TransactionalMap<K,V>

public interface BaseMap<K,V>
extends DistributedObject

Base interface for Hazelcast distributed maps.

See Also:

IMap, TransactionalMap

Method Summary

boolean	containsKey(Object key) Returns true if this map contains an entry for the specified key.
void	delete(Object key) Removes the mapping for a key from this map if it is present.
V	get(Object key) Returns the value for the specified key, or null if this map does not contain this key.
boolean	isEmpty() Returns true if this map contains no entries.
V	put(K key, V 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.
V	putIfAbsent(K key, V value) If the specified key is not already associated with a value, associate it with the given value.
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.
V	replace(K key, V value) Replaces the entry for a key only if 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.
void	set(K key, V 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.
int	size() Returns the number of entries in this map.

Methods inherited from interface com.hazelcast.core.DistributedObject

destroy, getId, getName, getPartitionKey, getServiceName

Method Detail

containsKey

boolean containsKey(Object key)

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

Parameters:

key - key

Returns:

true if this map contains an entry for the specified key

get

V get(Object key)

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

Parameters:

key - key

Returns:

value

put

V put(K key,
      V 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.

Parameters:

key - key

value - value

Returns:

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

set

void set(K key,
         V 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.

Parameters:

key - key

value - value

putIfAbsent

V putIfAbsent(K key,
              V value)

If the specified key is not already associated with a value, associate it with the given value. This is equivalent to

   if (!map.containsKey(key))
       return map.put(key, value);
   else
       return map.get(key);

except that the action is performed atomically.

Parameters:

key - key

value - value

Returns:

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

replace

V replace(K key,
          V value)

Replaces the entry for a key only if currently mapped to some value. This is equivalent to

   if (map.containsKey(key)) {
       return map.put(key, value);
   } else return null;

except that the action is performed atomically.

Parameters:

key - key

value - value

Returns:

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

replace

boolean replace(K key,
                V oldValue,
                V newValue)

Replaces the entry for a key only if currently mapped to a given value. This is equivalent to

   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.

Parameters:

key - key

oldValue - old value

newValue - new value

Returns:

true if the value was replaced

remove

V remove(Object 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.

Parameters:

key - key

Returns:

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

delete

void delete(Object 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.

Parameters:

key - key

remove

boolean remove(Object key,
               Object value)

Removes the entry for a key only if currently mapped to a given value. This is equivalent to

   if (map.containsKey(key) && map.get(key).equals(value)) {
       map.remove(key);
       return true;
   } else return false;

except that the action is performed atomically.

Parameters:

key - key

value - value

Returns:

true if the value was removed

isEmpty

boolean isEmpty()

Returns true if this map contains no entries.

Returns:

true if this map contains no entries

size

int size()

Returns the number of entries in this map.

Returns:

the number of entries in this map