public abstract class ResourceVariantTreeSubscriber extends Subscriber
IResourceVariantTreeobjects to manage the base (for three-way) and remote trees. Refreshing and obtaining the subscriber members and resource variants is delegated to the resource variant trees.
|Constructor and Description|
|Modifier and Type||Method and Description|
Return the base resource variant tree.
Return the remote resource variant tree.
Returns synchronization info for the given resource, or
Method that creates an instance of SyncInfo for the provided local, base and remote resource variants.
Returns all non-transient member resources of the given resource.
Refreshes the resource hierarchy from the given resources and their children (to the specified depth) from the corresponding resources in the remote location.
accept, accept, addListener, collectOutOfSync, fireTeamResourceChange, getDiff, getName, getResourceComparator, getState, isSupervised, refresh, removeListener, roots
public SyncInfo getSyncInfo(IResource resource) throws TeamException
nullif there is no synchronization info because the subscriber does not apply to this resource.
Note that sync info may be returned for non-existing or for resources which have no corresponding remote resource.
This method will be quick. If synchronization calculation requires content from the server it must be cached when the subscriber is refreshed. A client should call refresh before calling this method to ensure that the latest information is available for computing the sync state.
The sync-info node returned by this method does not fully describe
all types of changes. A more descriptive change can be obtained from
protected SyncInfo getSyncInfo(IResource local, IResourceVariant base, IResourceVariant remote) throws TeamException
local- the local resource
base- the base resource variant or
remote- the remote resource variant or
SyncInfocontaining the provided resources
public IResource members(IResource resource) throws TeamException
This is a fast operation; the repository is not contacted.
public void refresh(IResource resources, int depth, IProgressMonitor monitor) throws TeamException
Typical synchronization operations use the statuses computed by this method as the basis for determining what to do. It is possible for the actual sync status of the resource to have changed since the current local sync status was refreshed. Operations typically skip resources with stale sync information. The chances of stale information being used can be reduced by running this method (where feasible) before doing other operations. Note that this will of course affect performance.
The depth parameter controls whether refreshing is performed on just the
given resource (depth=
DEPTH_ZERO), the resource and its
DEPTH_ONE), or recursively to the
resource and all its descendents (depth=
DEPTH_ONE, rather than depth
DEPTH_ZERO, to ensure that new members of a project or
folder are detected.
This method might change resources; any changes will be reported in a subsequent subscriber resource change event indicating changes to server sync status.
This method contacts the server and is therefore long-running; progress and cancellation are provided by the given progress monitor.
resources- the resources
depth- valid values are
monitor- progress monitor, or
nullif progress reporting and cancellation are not desired
TeamException- if this method fails. Reasons include:
protected abstract IResourceVariantTree getBaseTree()
protected abstract IResourceVariantTree getRemoteTree()
Copyright (c) 2000, 2017 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.