org.eclipse.jpt.utility.model.event
Class CollectionEvent

java.lang.Object
  java.util.EventObject
      org.eclipse.jpt.utility.model.event.ChangeEvent
          org.eclipse.jpt.utility.model.event.CollectionEvent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CollectionAddEvent, CollectionChangeEvent, CollectionClearEvent, CollectionRemoveEvent

public abstract class CollectionEvent
extends ChangeEvent

A "collection" event gets delivered whenever a model changes a "bound" or "constrained" collection. A CollectionEvent is sent as an argument to the CollectionChangeListener. The intent is that any listener can keep itself synchronized with the model's collection via the collection events it receives and need not maintain a reference to the original collection.

Provisional API: This class is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

See Also:

Serialized Form

Constructor Summary

CollectionEvent(Model source, java.lang.String collectionName)
Construct a new collection event.

Method Summary

java.lang.String

getCollectionName() Return the programmatic name of the collection that was changed.

Methods inherited from class org.eclipse.jpt.utility.model.event.ChangeEvent

getSource, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CollectionEvent

public CollectionEvent(Model source,
                       java.lang.String collectionName)

Construct a new collection event.

Parameters:

source - The object on which the event initially occurred.

collectionName - The programmatic name of the collection that was changed.

Method Detail

getCollectionName

public java.lang.String getCollectionName()

Return the programmatic name of the collection that was changed.