com.starteam.events
Class ItemUpdateEvent

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

All Implemented Interfaces:

java.io.Serializable

public final class ItemUpdateEvent
extends java.util.EventObject

An event triggered whenever an Item 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 item update events

See Also:

ItemUpdateListener, View.addItemUpdateListener(com.starteam.events.ItemUpdateListener, com.starteam.Item.Type), Folder.addItemUpdateListener(com.starteam.events.ItemUpdateListener, com.starteam.Item.Type, int), ViewMemberListManager.addItemUpdateListener(com.starteam.events.ItemUpdateListener), Serialized Form

Constructor Summary

ItemUpdateEvent(Item oldItem, Item newItem)
Constructs a new ItemUpdateEvent.

Method Summary

Item	getNewItem() Gets the Item in its new state.
Item	getOldItem() Gets the Item in its old state.
java.lang.String	toString() Gets a short description of this ItemUpdateEvent.

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

ItemUpdateEvent

public ItemUpdateEvent(Item oldItem,
                       Item newItem)

Constructs a new ItemUpdateEvent.

Parameters:

oldItem - The item in its old state, or null.

newItem - The item in its new state, or null.

Method Detail

getNewItem

public Item getNewItem()

Gets the Item in its new state.

Used in itemAdded(), itemMoved() and itemChanged() events. In itemRemoved() events, getNewItem() returns null.

Item.getParentItem() will return a valid parent Folder object. For performance reasons, the same Folder object may be modified and re-used in subsequent events. If an application wants to modify the Folder, or save its state for later use, it should make its own private copy.

If an application wants to refresh the Items associated with the original Folder object, it must do so by explicitly calling Folder.refreshItems().

Returns:

The Item in its new state.

See Also:

ItemUpdateEvent.getOldItem(), Item, Folder.refreshItems(com.starteam.Item.Type, com.starteam.PropertyCollection, int)

getOldItem

public Item getOldItem()

Gets the Item in its old state.

Used in itemChanged(), itemMoved() and itemRemoved() events. In itemAdded() events, getOldItem() returns null.

Item.getParentItem() will return a valid parent Folder object. For performance reasons, the same Folder object may be modified and re-used in subsequent events. If an application wants to modify the Folder, or save its state for later use, it should make its own private copy.

Returns:

The Item in its old state.

See Also:

ItemUpdateEvent.getNewItem(), Item

toString

public java.lang.String toString()

Gets a short description of this ItemUpdateEvent.

Overrides:

toString in class java.util.EventObject

Returns:

A short description of this ItemEvent.