com.starbase.starteam
Class FolderTreeEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.starbase.starteam.FolderTreeEvent

All Implemented Interfaces:

java.io.Serializable

public class FolderTreeEvent

extends java.util.EventObject

An event triggered whenever the Folder hierarchy is changed in a View.

See Also:

FolderTreeListener, View.addFolderListener(com.starbase.starteam.IFolderListener), Folder.addFolderListener(com.starbase.starteam.IFolderListener, int), FolderListManager.addFolderListener(com.starbase.starteam.IFolderListener), Serialized Form

Method Summary

boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
Folder	getFolder() Gets the Folder at the root of the part of the hierarchy that has changed.
java.lang.Object	getSource() The object on which the Event initially occurred.
int	hashCode() returns a unique hash for all instances of this type
java.lang.String	toString() Gets a short description of this Event.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getFolder

public Folder getFolder()

Gets the Folder at the root of the part of the hierarchy that has changed. This is the deepest folder that fully encompasses the change to the folder hierarchy.

Returns a new Folder object that is not a member of any View's folder hierarchy. There may be a Folder in the hierarchy with the same ItemID, but it would be a physically different object that is likely to have different properties.

Folder.getParentFolder() and Folder.getSubFolders() will return values that are up-to-date as of the time the event was triggered. In fact, an application can rely on the entire Folder hierarchy being up-to-date. For performance reasons, these same Folder objects may be re-used in subsequent events. If an application wants to modify one of the Folder objects, or save its state for later use, it should first make a copy.

If an application wants to refresh the Folders associated with the original View object, it must do so by explicitly calling View.refreshFolders().

Returns:

The deepest folder that fully encompasses the change to the folder hierarchy.

See Also:

Folder, View.refreshFolders()

getSource

public java.lang.Object getSource()

The object on which the Event initially occurred.

Overrides:

getSource in class java.util.EventObject

Returns:

The object on which the Event initially occurred.

toString

public java.lang.String toString()

Gets a short description of this Event.

Overrides:

toString in class java.util.EventObject

Returns:

A short description of this Event.

equals

public boolean equals(java.lang.Object source)

returns true if this object instance is equal to the source

Overrides:

equals in class java.lang.Object

Parameters:

source - Object the source to comapre with

Returns:

boolean true if this object is equal to the source

hashCode

public int hashCode()

returns a unique hash for all instances of this type

Overrides:

hashCode in class java.lang.Object

Returns:

int a unique hash for all instances of this type