hydra.blackboard

Interface SharedMap

All Known Implementing Classes:

AnySharedMapImpl

public interface SharedMap

Variant of the Map interface, suitable for using as a facade over RMI and GemFire versions of Map. All operations will modify the underlying shared map, with the exception of getMap(), which returns a copy that is not backed by the shared map, but is useful for iterating over a snapshot of its contents.

Method Summary

Modifier and Type	Method and Description
void	clear() Equivalent of Map.clear().
boolean	containsKey(Object key) Equivalent of Map.containsKey(Object).
boolean	containsValue(Object value) Equivalent of Map.containsValue(Object).
Object	get(Object key) Equivalent of Map.get(Object).
Map	getMap() Returns a copy of the underlying map.
Object	getRandomKey() Returns a random key from this map.
boolean	isEmpty() Equivalent of Map.isEmpty().
Object	put(Object key, Object value) Equivalent of Map.put(Object, Object).
void	putAll(Map t) Equivalent of Map.putAll(Map).
long	putIfLarger(Object key, long value) Replaces the current value with the specified one if the specified one is larger than the current one.
long	putIfSmaller(Object key, long value) Replaces the current value with the specified one if the specified one is smaller than the current one.
Object	remove(Object key) Equivalent of Map.remove(Object).
boolean	replace(Object key, Object expectedValue, Object newValue) Performs an atomic "test and replace" on this map.
int	size() Equivalent of Map.size().

Method Detail

size

int size()

Equivalent of Map.size().

isEmpty

boolean isEmpty()

Equivalent of Map.isEmpty().

containsKey

boolean containsKey(Object key)

Equivalent of Map.containsKey(Object).

containsValue

boolean containsValue(Object value)

Equivalent of Map.containsValue(Object).

get

Object get(Object key)

Equivalent of Map.get(Object).

put

Object put(Object key,
           Object value)

Equivalent of Map.put(Object, Object).

putIfLarger

long putIfLarger(Object key,
                 long value)

Replaces the current value with the specified one if the specified one is larger than the current one.

putIfSmaller

long putIfSmaller(Object key,
                  long value)

Replaces the current value with the specified one if the specified one is smaller than the current one.

remove

Object remove(Object key)

Equivalent of Map.remove(Object).

putAll

void putAll(Map t)

Equivalent of Map.putAll(Map).

clear

void clear()

Equivalent of Map.clear().

getMap

Map getMap()

Returns a copy of the underlying map. Useful for getting all keys, values, or entries and iterating over them without getting ConcurrentModificationException. Note, however, that an iterator on this map is not backed by the shared map. For example, the add and remove operations on iterators will modify only the copy, not the shared map.

getRandomKey

Object getRandomKey()

Returns a random key from this map. If the map is empty, null is returned. author David Whitlock

Since:

2.0.3

replace

boolean replace(Object key,
                Object expectedValue,
                Object newValue)

Performs an atomic "test and replace" on this map. The newValue will only be placed into this map only if the current value of the mapping matches (is equals to) expectedValue. This method is similar to the replace method on the JSR-166 ConcurrentHashMap.

Parameters:

key - The key of the mapping

expectedValue - The value that we expect the mapping to have

newValue - The new value put into the mapping if the current value equals expectedValue.

Returns:

true if newValue was placed into the map. author David Whitlock

Since:

2.0.3