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

java.lang.Object
  extended by java.util.EventObject
      extended by org.eclipse.jpt.common.utility.model.event.ChangeEvent
          extended by org.eclipse.jpt.common.utility.model.event.TreeEvent
              extended by org.eclipse.jpt.common.utility.model.event.TreeAddEvent
All Implemented Interfaces:
java.io.Serializable

public final class TreeAddEvent
extends TreeEvent

A "tree add" event gets delivered whenever a model adds a node to a "bound" or "constrained" tree. A TreeChangeEvent is sent as an argument to the TreeChangeListener.

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
TreeAddEvent(Model source, java.lang.String treeName, java.util.List<?> path)
          Construct a new tree add event.
 
Method Summary
 TreeAddEvent clone(Model newSource)
           
 TreeAddEvent clone(Model newSource, java.lang.String newTreeName)
          Return a copy of the event with the specified source and tree name replacing the current source and tree name.
 java.lang.Iterable<?> getPath()
          Return the path to the part of the tree that was added.
 
Methods inherited from class org.eclipse.jpt.common.utility.model.event.TreeEvent
getTreeName
 
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

TreeAddEvent

public TreeAddEvent(Model source,
                    java.lang.String treeName,
                    java.util.List<?> path)
Construct a new tree add event.

Parameters:
source - The object on which the event initially occurred.
treeName - The programmatic name of the tree that was changed.
path - The path to the part of the tree that was added.
Method Detail

getPath

public java.lang.Iterable<?> getPath()
Return the path to the part of the tree that was added.


clone

public TreeAddEvent clone(Model newSource)

clone

public TreeAddEvent clone(Model newSource,
                          java.lang.String newTreeName)
Return a copy of the event with the specified source and tree name replacing the current source and tree name.