com.pega.pegarules.pub.context

Interface PRDistributedMap<K extends java.io.Serializable,V extends java.io.Serializable>

Type Parameters:

K -

V -

All Superinterfaces:

java.util.Map<K,V>

public interface PRDistributedMap<K extends java.io.Serializable,V extends java.io.Serializable>
extends java.util.Map<K,V>

PRDistributedMap : Represents a distributed map.
Null Keys and Values are not supported. Behaves like java.util.Map.

Version:

$Revision: 123587 $ $Date: 2015-02-09 04:25:31 -0500 (Mon, 09 Feb 2015) $

Author:

jainh

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static java.lang.String	VERSION

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	addEntryListener(PRDistributedMapEntryListener<K,V> aListener) Adds an entry listener for this map. Listener will get notified for all map add/remove/update/evict events.
java.util.Set<java.util.Map.Entry<K,V>>	entrySet() Returns a Set view of the mappings contained in this map. Warn: The returned collection is not backed to the Map. So any changes to it is not reflected in the map and vice versa.
V	get(java.lang.Object aKey) Gets the value associated with given key from map.
java.lang.String	getCategory()
java.lang.String	getMapName()
int	getMaxObjectSize()
java.lang.Class	getObjectClass()
boolean	isLocked(K aKey) Checks the lock for the specified key.
java.util.Set<K>	keySet() Returns a set containing all keys in the Map. Warn: The returned set is not backed to the Map. So any changes to it is not reflected in the map and vice versa.
void	lock(K aKey) Acquires lock on specified key only if it exists in the map i.e., lock cannot be acquired on non-existent key. If the lock is held by some other thread (on same node or different node), then the current thread waits till lock is acquired.
V	put(K aKey, V aValue) Associates the given key with given value in this map.
void	putAll(java.util.Map<? extends K,? extends V> aMap) Copies all of the mappings from the specified map to this map.
boolean	removeEntryListener(java.lang.String aEventSubscriptionIdentifier) Removes the specified entry listener Returns silently if there is no such listener added before.
boolean	tryLock(K aKey) Tries to acquire the lock for the specified key. If the lock is not available then the current thread doesn't wait and returns false immediately.
void	unlock(K aKey) Releases the lock for the specified key.
java.util.Collection<V>	values() Returns a collection containing all values in the Map. Warn: The returned collection is not backed by the Map. So any changes to it is not reflected in the map and vice versa. Any modifications to the objects are also not reflected in the map. After modifications the object should be put into map again for changes to be visible.

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, equals, hashCode, isEmpty, remove, size

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

VERSION

static final java.lang.String VERSION

Method Detail

getMapName

java.lang.String getMapName()

Returns:

name of this map in cluster

getCategory

java.lang.String getCategory()

Returns:

the category

getObjectClass

java.lang.Class getObjectClass()

Returns:

the objectClass

getMaxObjectSize

int getMaxObjectSize()

Returns:

the maxObjectSize

get

V get(java.lang.Object aKey)

Gets the value associated with given key from map. Null key is not supported.

Warn: Any changes to the returned object will not be reflected in the map.
After modifications the object should be put into map again for changes to be visible.

Specified by:

get in interface java.util.Map<K extends java.io.Serializable,V extends java.io.Serializable>

Parameters:

aKey -

Returns:

value associated with key or null if key is not present.

put

V put(K aKey,
    V aValue)

Associates the given key with given value in this map. If key is already present it is associated with new value.
Null values are not allowed for both key and value.

Warn: Once a value object is put into map any changes to the object will not be reflected in the map.
After modifications the object should be put into map again for changes to be visible.

Specified by:

put in interface java.util.Map<K extends java.io.Serializable,V extends java.io.Serializable>

Parameters:

aKey -

aValue -

Returns:

Old value associated with key or null if key was not present before.

putAll

void putAll(java.util.Map<? extends K,? extends V> aMap)

Copies all of the mappings from the specified map to this map. If key is already present it is associated with new value.

Warn: Once a value object is put into map any changes to the object will not be reflected in the map.
After modifications the object should be put into map again for changes to be visible.

Specified by:

putAll in interface java.util.Map<K extends java.io.Serializable,V extends java.io.Serializable>

keySet

java.util.Set<K> keySet()

Returns a set containing all keys in the Map.

Warn: The returned set is not backed to the Map.
So any changes to it is not reflected in the map and vice versa.

Specified by:

keySet in interface java.util.Map<K extends java.io.Serializable,V extends java.io.Serializable>

Returns:

Set containing all keys in map.

values

java.util.Collection<V> values()

Returns a collection containing all values in the Map.

Warn: The returned collection is not backed by the Map.
So any changes to it is not reflected in the map and vice versa.
Any modifications to the objects are also not reflected in the map.
After modifications the object should be put into map again for changes to be visible.

Specified by:

values in interface java.util.Map<K extends java.io.Serializable,V extends java.io.Serializable>

Returns:

Set containing all keys in map.

entrySet

java.util.Set<java.util.Map.Entry<K,V>> entrySet()

Returns a Set view of the mappings contained in this map.

Warn: The returned collection is not backed to the Map.
So any changes to it is not reflected in the map and vice versa.

Specified by:

entrySet in interface java.util.Map<K extends java.io.Serializable,V extends java.io.Serializable>

Returns:

Set containing all keys in map.

lock

void lock(K aKey)

Acquires lock on specified key only if it exists in the map i.e., lock cannot be acquired on non-existent key.
If the lock is held by some other thread (on same node or different node), then the current thread waits till lock is acquired.

Parameters:

aKey -

tryLock

boolean tryLock(K aKey)

Tries to acquire the lock for the specified key.
If the lock is not available then the current thread doesn't wait and returns false immediately.

Parameters:

aKey -

Returns:

true if lock is acquired, false otherwise.

isLocked

boolean isLocked(K aKey)

Checks the lock for the specified key.
If the lock is acquired then returns true, else false.

Parameters:

aKey -

Returns:

true if lock is acquired, false otherwise.

unlock

void unlock(K aKey)

Releases the lock for the specified key. It never blocks and returns immediately.

Parameters:

aKey - key to lock.

Throws:

java.lang.IllegalMonitorStateException - if the current thread does not hold this lock

addEntryListener

java.lang.String addEntryListener(PRDistributedMapEntryListener<K,V> aListener)

Adds an entry listener for this map.
Listener will get notified for all map add/remove/update/evict events.

Parameters:

aListener - - a listener instance

Returns:

String - Event subscription identifier, this can later be used to unsubscribe

removeEntryListener

boolean removeEntryListener(java.lang.String aEventSubscriptionIdentifier)

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

Parameters:

aEventSubscriptionIdentifier - - a registered listener

Returns:

true if registration is removed, false otherwise