com.tangosol.util

Class MapEvent<K,V>

java.lang.Object

java.util.EventObject

com.tangosol.util.MapEvent<K,V>

Type Parameters:

K - the type of the Map entry key

V - the type of the Map entry value

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CacheEvent

public class MapEvent<K,V>
extends EventObject

An event which indicates that the content of a map has changed:

• an entry has been added
• an entry has been removed
• an entry has been changed

A MapEvent object is sent as an argument to the MapListener interface methods. Null values may be provided for the old and the new values.

Author:

gg 2002.02.11

Field Summary

Fields

Modifier and Type	Field and Description
static int	ENTRY_DELETED This event indicates that an entry has been removed from the map.
static int	ENTRY_INSERTED This event indicates that an entry has been added to the map.
static int	ENTRY_UPDATED This event indicates that an entry has been updated in the map.
protected int	m_nId The event's id.
protected K	m_oKey A key.
protected V	m_oValueNew A new value.
protected V	m_oValueOld A previous value.

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
MapEvent(ObservableMap<K,V> map, int nId, K oKey, V oValueOld, V oValueNew) Constructs a new MapEvent.

Method Summary

Modifier and Type	Method and Description
void	dispatch(Listeners listeners) Dispatch this event to the specified listeners collection.
void	dispatch(Listeners listeners, boolean fStrict) Dispatch this event to the specified listeners collection.
void	dispatch(MapListener<? super K,? super V> listener) Dispatch this event to the specified MapListener.
protected String	getDescription() Get the event's description.
static String	getDescription(int nId) Convert an event ID into a human-readable string.
int	getId() Return this event's id.
K	getKey() Return a key associated with this event.
ObservableMap	getMap() Return an ObservableMap object on which this event has actually occurred.
Map.Entry<K,V>	getNewEntry() Return a Map Entry that represents the state of the Entry after the change occurred that generated this event.
V	getNewValue() Return a new value associated with this event.
Map.Entry<K,V>	getOldEntry() Return a Map Entry that represents the state of the Entry before the change occurred that generated this event.
V	getOldValue() Return an old value associated with this event.
String	toString() Return a String representation of this MapEvent object.

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ENTRY_INSERTED

public static final int ENTRY_INSERTED

This event indicates that an entry has been added to the map.

See Also:

Constant Field Values

ENTRY_UPDATED

public static final int ENTRY_UPDATED

This event indicates that an entry has been updated in the map.

See Also:

Constant Field Values

ENTRY_DELETED

public static final int ENTRY_DELETED

This event indicates that an entry has been removed from the map.

See Also:

Constant Field Values

m_nId

protected int m_nId

The event's id.

m_oKey

protected K m_oKey

A key.

m_oValueOld

protected V m_oValueOld

A previous value. May be null if not known.

m_oValueNew

protected V m_oValueNew

A new value. May be null if not known.

Constructor Detail

MapEvent

public MapEvent(ObservableMap<K,V> map,
                int nId,
                K oKey,
                V oValueOld,
                V oValueNew)

Constructs a new MapEvent.

Parameters:

map - the ObservableMap object that fired the event

nId - this event's id, one of ENTRY_INSERTED, ENTRY_UPDATED or ENTRY_DELETED

oKey - the key into the map

oValueOld - the old value (for update and delete events)

oValueNew - the new value (for insert and update events)

Method Detail

getMap

public ObservableMap getMap()

Return an ObservableMap object on which this event has actually occurred.

Returns:

an ObservableMap object

getId

public int getId()

Return this event's id. The event id is one of the ENTRY_* enumerated constants.

Returns:

an id

getKey

public K getKey()

Return a key associated with this event.

Returns:

a key

getOldValue

public V getOldValue()

Return an old value associated with this event.

The old value represents a value deleted from or updated in a map. It is always null for "insert" notifications.

Returns:

an old value

getNewValue

public V getNewValue()

Return a new value associated with this event.

The new value represents a new value inserted into or updated in a map. It is always null for "delete" notifications.

Returns:

a new value

getOldEntry

public Map.Entry<K,V> getOldEntry()

Return a Map Entry that represents the state of the Entry before the change occurred that generated this event.

Returns:

a Map Entry representing the pre-event state of the Entry

Since:

Coherence 3.6

getNewEntry

public Map.Entry<K,V> getNewEntry()

Return a Map Entry that represents the state of the Entry after the change occurred that generated this event.

Returns:

a Map Entry representing the post-event state of the Entry

Since:

Coherence 3.6

toString

public String toString()

Return a String representation of this MapEvent object.

Overrides:

toString in class EventObject

Returns:

a String representation of this MapEvent object

dispatch

public void dispatch(Listeners listeners)

Dispatch this event to the specified listeners collection.

This call is equivalent to

   dispatch(listeners, true);
 

Parameters:

listeners - the listeners collection

Throws:

ClassCastException - if any of the targets is not an instance of MapListener interface

dispatch

public void dispatch(Listeners listeners,
                     boolean fStrict)

Dispatch this event to the specified listeners collection.

Parameters:

listeners - the listeners collection

fStrict - if true then any RuntimeException thrown by event handlers stops all further event processing and the exception is re-thrown; if false then all exceptions are logged and the process continues

Throws:

ClassCastException - if any of the targets is not an instance of MapListener interface

dispatch

public void dispatch(MapListener<? super K,? super V> listener)

Dispatch this event to the specified MapListener.

Parameters:

listener - the listener

getDescription

protected String getDescription()

Get the event's description.

Returns:

this event's description

getDescription

public static String getDescription(int nId)

Convert an event ID into a human-readable string.

Parameters:

nId - an event ID, one of the ENTRY_* enumerated values

Returns:

a corresponding human-readable string, for example "inserted"