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

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

All Implemented Interfaces:

java.io.Serializable

public final class TreeClearEvent
extends TreeEvent

A "tree clear" event gets delivered whenever a model clears a "bound" or "constrained" tree. A TreeClearEvent 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

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

Method Summary

TreeClearEvent	clone(Model newSource) Return a copy of the event with the specified source replacing the current source.
TreeClearEvent	clone(Model newSource, java.lang.String newCollectionName) Return a copy of the event with the specified source and collection name replacing the current source and collection name.

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

TreeClearEvent

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

Construct a new tree clear event.

Parameters:

source - The object on which the event initially occurred.

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

Method Detail

clone

public TreeClearEvent clone(Model newSource)

Return a copy of the event with the specified source replacing the current source.

clone

public TreeClearEvent clone(Model newSource,
                            java.lang.String newCollectionName)

Return a copy of the event with the specified source and collection name replacing the current source and collection name.