org.eclipse.team.core.synchronize
Interface ISyncInfoTree

All Superinterfaces:

ISyncInfoSet

All Known Implementing Classes:

SyncInfoTree

public interface ISyncInfoTree

extends ISyncInfoSet

Provides addition API for accessing the SyncInfo in the set through their resource's hierarchical relationships.

Events fired from a ISyncInfoTree will be instances of ISyncInfoTreeChangeEvent.

This interface is not intended to be implemented by clients. Clients that need an instance of a set can use SyncInfoTree

EXPERIMENTAL. This class or interface has been added as part of a work in progress. There is a guarantee neither that this API will work nor that it will remain the same. Please do not use this API without consulting with the Platform/Team team.

Since:

3.2

See Also:

SyncInfoTree

Method Summary

SyncInfo[]	getSyncInfos(IResource resource, int depth) Return the SyncInfo for each out-of-sync resource in the subtree rooted at the given resource to the depth specified.
SyncInfo[]	getSyncInfos(org.eclipse.core.resources.mapping.ResourceTraversal[] traversals) Return the sync info contained in this set that are contained in the given traversals.
boolean	hasMembers(IResource resource) Return whether the given resource has any children in the sync set.
IResource[]	members(IResource resource) Return the immediate children of the given resource who are either out-of-sync or contain out-of-sync resources.

Methods inherited from interface org.eclipse.team.core.synchronize.ISyncInfoSet

addSyncSetChangedListener, getResources, getSyncInfo, getSyncInfos, isEmpty, iterator, removeSyncSetChangedListener, size

Method Detail

hasMembers

public boolean hasMembers(IResource resource)

Return whether the given resource has any children in the sync set. The children could be either out-of-sync resources that are contained by the set or containers that are ancestors of out-of-sync resources contained by the set.

Parameters:

resource - the resource to check for children.

Returns:

true if the resource has children in the set.

getSyncInfos

public SyncInfo[] getSyncInfos(IResource resource,
                               int depth)

Return the SyncInfo for each out-of-sync resource in the subtree rooted at the given resource to the depth specified. The depth is one of:

• IResource.DEPTH_ZERO: the resource only,
• IResource.DEPTH_ONE: the resource or its direct children,
• IResource.DEPTH_INFINITE: the resource and all of it's descendants.
  If the given resource is out of sync, it will be included in the result.

  The default implementation makes use of getSyncInfo(IResource), members(IResource) and getSyncInfos() to provide the varying depths. Subclasses may override to optimize.

  Parameters:

  resource - the root of the resource subtree

  depth - the depth of the subtree

  Returns:

  the SyncInfo for any out-of-sync resources

members

public IResource[] members(IResource resource)

Return the immediate children of the given resource who are either out-of-sync or contain out-of-sync resources.

Parameters:

resource - the parent resource

Returns:

the children of the resource that are either out-of-sync or are ancestors of out-of-sync resources contained in the set

getSyncInfos

public SyncInfo[] getSyncInfos(org.eclipse.core.resources.mapping.ResourceTraversal[] traversals)

Return the sync info contained in this set that are contained in the given traversals.

Parameters:

traversals - the traversals

Returns:

the sync info contained in this set that are contained in the given traversals