org.eclipse.jpt.common.utility.model.event
Class ListEvent

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ListAddEvent, ListChangeEvent, ListClearEvent, ListMoveEvent, ListRemoveEvent, ListReplaceEvent

public class ListEvent
extends ChangeEvent

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

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

ListEvent(Model source, java.lang.String listName)
Construct a new list event.

Method Summary

java.lang.String

getListName() Return the programmatic name of the list that was changed.

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

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ListEvent

public ListEvent(Model source,
                 java.lang.String listName)

Construct a new list event.

Parameters:

source - The object on which the event initially occurred.

listName - The programmatic name of the list that was changed.

Method Detail

getListName

public java.lang.String getListName()

Return the programmatic name of the list that was changed.