Interface ISyncInfoSetChangeListener
-
public interface ISyncInfoSetChangeListenerClasses which implement this interface provide methods that deal with the change events that are generated by aSyncInfoSet.Implementors of this interface it can be added to a sync info set using the
addSyncSetChangedListenermethod and removed using theremoveSyncSetChangedListenermethod.The originating sync set holds modification locks on the sync info set to ensure that no more changes occur until after the current change event is processed. The implementors of this interface must not modify the set within the scope of the listener's methods. If modifications are attempted a runtime exception will occur.
- Since:
- 3.0
- See Also:
ISyncInfoSetChangeEvent
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidsyncInfoChanged(ISyncInfoSetChangeEvent event, IProgressMonitor monitor)Sent when aSyncInfoSetchanges.voidsyncInfoSetErrors(SyncInfoSet set, ITeamStatus[] errors, IProgressMonitor monitor)This method is called when errors have occurred calculating theSyncInfofor a resource.voidsyncInfoSetReset(SyncInfoSet set, IProgressMonitor monitor)Sent when the contents of aSyncInfoSethave been reset or the listener has been connected to the set for the first time usingSyncInfoSet#connect(ISyncInfoSetChangeListener, IProgressMonitor).
-
-
-
Method Detail
-
syncInfoSetReset
void syncInfoSetReset(SyncInfoSet set, IProgressMonitor monitor)
Sent when the contents of aSyncInfoSethave been reset or the listener has been connected to the set for the first time usingSyncInfoSet#connect(ISyncInfoSetChangeListener, IProgressMonitor). Listeners should discard any state they have accumulated from the originating sync info set and re-obtain their state from the set. The originating sync set will be locked for modification when this method is called.Clients should not modify the set within this method and other threads that try to modify the set will be blocked until the reset is processed.
- Parameters:
set- the originatingSyncInfoSet
-
syncInfoChanged
void syncInfoChanged(ISyncInfoSetChangeEvent event, IProgressMonitor monitor)
Sent when aSyncInfoSetchanges. For example, when a resource's synchronization state changes. The originating sync set will be locked for modification when this method is called. Clients should not modify the set within this method and other threads that try to modify the set will be blocked until the change is processed.If the originating set is an instance of
SyncInfoTreethen the event will be an instance ofISyncInfoTreeChangeEvent. Clients can determine this using aninstancofcheck.- Parameters:
event- an event containing information about the change.
-
syncInfoSetErrors
void syncInfoSetErrors(SyncInfoSet set, ITeamStatus[] errors, IProgressMonitor monitor)
This method is called when errors have occurred calculating theSyncInfofor a resource. The resource associated with the error is available from theITeamStatus. This event only provides the latest errors that occurred. An array of all errors can be retrieved directly from the set.- Parameters:
set- the originatingSyncInfoSeterrors- the errors that occurred during the latest set modificationsmonitor- a progress monitor
-
-