Interface ISyncInfoSetChangeEvent
- All Known Subinterfaces:
ISyncInfoTreeChangeEvent
- All Known Implementing Classes:
SyncInfoSetChangeEvent
public interface ISyncInfoSetChangeEvent
An event generated when a
SyncInfoSet
collection is changed. The event contains
a description of the changes which include added, changed and removed resources.
In some cases, (e.g. when the change is too complicated to be efficiently described
using the mechanisms provided by this interface) the event will be a reset. In these
cases, the client should ignore any other contents of the event and recalculate
from scratch any state that is derived from the SyncInfoSet
from
which the event originated.
The mix of return types, SyncInfo
and IResource
is required as a result of an optimization
included in SyncInfoSet
collections that doesn't maintain SyncInfo
objects
for in-sync resources.
-
Method Summary
Modifier and TypeMethodDescriptionSyncInfo[]
Returns newly added out-of-syncSyncInfo
elements.SyncInfo[]
Returns changedSyncInfo
elements.Returns the removedIResource
elements for which the set no longer contains on out-of-syncSyncInfo
.getSet()
Returns theSyncInfoSet
that generated these events.
-
Method Details
-
getAddedResources
SyncInfo[] getAddedResources()Returns newly added out-of-syncSyncInfo
elements.- Returns:
- newly added
SyncInfo
elements or an empty list if this event doesn't contain added resources.
-
getChangedResources
SyncInfo[] getChangedResources()Returns changedSyncInfo
elements. The returned elements are still out-of-sync.- Returns:
- changed
SyncInfo
elements or an empty list if this event doesn't contain changes resources.
-
getRemovedResources
IResource[] getRemovedResources()Returns the removedIResource
elements for which the set no longer contains on out-of-syncSyncInfo
. The returned elements are all in-sync resources.- Returns:
- removed
SyncInfo
elements or an empty list if this event doesn't contain removed resources.
-
getSet
SyncInfoSet getSet()Returns theSyncInfoSet
that generated these events.- Returns:
- the
SyncInfoSet
that generated these events.
-