Package com.norconex.commons.lang.map

Class MapChangeSupport<K,V>

java.lang.Object

com.norconex.commons.lang.map.MapChangeSupport<K,V>

Type Parameters:

K - the type of keys maintained by the map we are observing

V - the type of mapped values

All Implemented Interfaces:

Serializable

public class MapChangeSupport<K,V>
extends Object
implements Serializable

Here is an example of MapChangeSupport usage:

 public class MyMap extends Map {
     private final MapChangeSupport mcs = new MapChangeSupport(this);

     public void addMapChangeListener(IMapChangeListener listener) {
         this.mcs.addMapChangeListener(listener);
     }

     public void removeMapChangeListener(IMapChangeListener listener) {
         this.mcs.removeMapChangeListener(listener);
     }

     public Object put(Object key, Object value) {
         Object oldValue = map.put(key, value);
         mcs.fireMapChange(key, oldValue, value);
         return oldValue;
     }

     [...]
 }
 

Since:

1.4

Author:

Pascal Essiembre

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
MapChangeSupport(Map<K,V> source)

Method Summary

Modifier and Type	Method	Description
void	addMapChangeListener(IMapChangeListener<K,V> listener)	Add a IMapChangeListener to the listener list.
boolean	equals(Object other)
void	fireMapChange(K key, V oldValue, V newValue)	Fires a MapChangeEvent to all change listeners.
int	hashCode()
boolean	isEmpty()
void	removeMapChangeListener(IMapChangeListener<K,V> listener)	Removes a IMapChangeListener from the listener list.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MapChangeSupport

public MapChangeSupport(Map<K,V> source)

Method Detail

addMapChangeListener

public void addMapChangeListener(IMapChangeListener<K,V> listener)

Add a IMapChangeListener to the listener list. If listener is null, no exception is thrown and no action is taken.

Parameters:

listener - The IMapChangeListener to be added

removeMapChangeListener

public void removeMapChangeListener(IMapChangeListener<K,V> listener)

Removes a IMapChangeListener from the listener list. If listener is null, no exception is thrown and no action is taken.

Parameters:

listener - The IMapChangeListener to be removed

fireMapChange

public void fireMapChange(K key,
                          V oldValue,
                          V newValue)

Fires a MapChangeEvent to all change listeners.

Parameters:

key - the key for the value change

oldValue - the old value

newValue - the new value

isEmpty

public boolean isEmpty()

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object