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

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

TreeAddEvent, TreeChangeEvent, TreeClearEvent, TreeRemoveEvent

public abstract class TreeEvent
extends ChangeEvent

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

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

TreeEvent(Model source, java.lang.String treeName)
Construct a new tree event.

Method Summary

java.lang.String

getTreeName() Return the programmatic name of the tree 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

TreeEvent

public TreeEvent(Model source,
                 java.lang.String treeName)

Construct a new tree event.

Parameters:

source - The object on which the event initially occurred.

treeName - The programmatic name of the tree that was changed.

Method Detail

getTreeName

public java.lang.String getTreeName()

Return the programmatic name of the tree that was changed.