com.starteam.events
Class FolderUpdateEvent

java.lang.Object
  java.util.EventObject
      com.starteam.events.FolderUpdateEvent

All Implemented Interfaces:

java.io.Serializable

public final class FolderUpdateEvent
extends java.util.EventObject

An event triggered whenever a Folder is added, moved, changed or deleted in a View. events are triggered by explicit operations performed by the client application MPX is not required to receive folder update events

See Also:

FolderUpdateListener, View.addFolderUpdateListener(com.starteam.events.FolderUpdateListener), Folder.addFolderUpdateListener(com.starteam.events.FolderUpdateListener, int), FolderListManager.addFolderUpdateListener(com.starteam.events.FolderUpdateListener), Serialized Form

Constructor Summary

FolderUpdateEvent(Folder oldFolder, Folder newFolder)
Constructs a new FolderUpdateEvent.

Method Summary

Folder	getNewFolder() Gets the Folder in its new state.
Folder	getOldFolder() Gets the Folder in its old state.
java.lang.String	toString() Gets a short description of this FolderUpdateEvent.

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderUpdateEvent

public FolderUpdateEvent(Folder oldFolder,
                         Folder newFolder)

Constructs a new FolderUpdateEvent.

Parameters:

oldFolder - The folder in its old state, or null.

newFolder - The folder in its new state, or null.

Method Detail

getNewFolder

public Folder getNewFolder()

Gets the Folder in its new state.

Used in folderAdded(), folderMoved() and folderChanged() events. In folderRemoved() events, getNewFolder() null.

Returns a 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 correct as of the time the event was triggered. In fact, the entire Folder hierarchy is valid. For performance reasons, these same Folder objects may be modified and 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 make its own private 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 Folder in its new state.

See Also:

FolderUpdateEvent.getOldFolder(), Folder, View.refreshFolders()

getOldFolder

public Folder getOldFolder()

Gets the Folder in its old state.

Used in folderChanged(), folderMoved() and folderRemoved() events. In folderAdded() events, getOldFolder() returns null.

Returns a 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 correctly represent the old state of the folder. In fact, the entire Folder hierarchy is valid. For performance reasons, these same Folder objects may be modified and 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 make its own private copy.

Returns:

The Folder in its old state.

See Also:

FolderUpdateEvent.getNewFolder(), Folder

toString

public java.lang.String toString()

Gets a short description of this FolderUpdateEvent.

Overrides:

toString in class java.util.EventObject

Returns:

A short description of this FolderUpdateEvent.