org.eclipse.persistence.descriptors.changetracking
Class MapChangeEvent

java.lang.Object
  java.util.EventObject
      java.beans.PropertyChangeEvent
          org.eclipse.persistence.descriptors.changetracking.CollectionChangeEvent
              org.eclipse.persistence.descriptors.changetracking.MapChangeEvent

All Implemented Interfaces:

java.io.Serializable

public class MapChangeEvent
extends CollectionChangeEvent

Purpose: Define a change event for Map types.

Description: For any object that wishes to use either object change tracking or attribute change tracking, its map attributes need to fire MapChangeEvent in the put or remove methods. In the case of a replace (ie key already exists) both a remove for that key and a put using the new value and old key must be fired.

Responsibilities: Create a MapChangeEvent for an object

See Also:

Serialized Form

Field Summary

protected java.lang.Object

key INTERNAL: The value of the key that was updated.

Fields inherited from class org.eclipse.persistence.descriptors.changetracking.CollectionChangeEvent

ADD, changeType, index, isSet, REMOVE

Fields inherited from class java.util.EventObject

source

Constructor Summary

MapChangeEvent(java.lang.Object collectionOwner, java.lang.String propertyName, java.lang.Object collectionChanged, java.lang.Object elementKey, java.lang.Object elementValue, int changeType)
PUBLIC: Create a MapChangeEvent for an object based on the property name, the updated Map, the new Key and the new Value and change type (add or remove)

Method Summary

java.lang.Object	getKey() INTERNAL: Return the change type
void	setKey(java.lang.Object key) INTERNAL: Set the change type

Methods inherited from class org.eclipse.persistence.descriptors.changetracking.CollectionChangeEvent

getChangeType, getIndex, isSet, setIndex

Methods inherited from class java.beans.PropertyChangeEvent

getNewValue, getOldValue, getPropagationId, getPropertyName, setPropagationId

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

key

protected java.lang.Object key

INTERNAL: The value of the key that was updated.

Constructor Detail

MapChangeEvent

public MapChangeEvent(java.lang.Object collectionOwner,
                      java.lang.String propertyName,
                      java.lang.Object collectionChanged,
                      java.lang.Object elementKey,
                      java.lang.Object elementValue,
                      int changeType)

PUBLIC: Create a MapChangeEvent for an object based on the property name, the updated Map, the new Key and the new Value and change type (add or remove)

Method Detail

getKey

public java.lang.Object getKey()

INTERNAL: Return the change type

setKey

public void setKey(java.lang.Object key)

INTERNAL: Set the change type