org.eclipse.team.core.mapping
Interface IResourceDiffTree

All Superinterfaces:

IDiffTree

All Known Implementing Classes:

ResourceDiffTree

public interface IResourceDiffTree

extends IDiffTree

A resource diff tree provides access to a tree of IDiff instances that either contain IResourceDiff nodes or IThreeWayDiff nodes that contain IResourceDiff nodes as the local and remote changes. For efficiency reasons, the tree only provides diffs for resources that have changes. Resources that do not contain a change but are returned from the tree will contain children in the set.

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

Field Summary

Fields inherited from interface org.eclipse.team.core.diff.IDiffTree

P_BUSY_HINT, P_HAS_DESCENDANT_CONFLICTS

Method Summary

void	accept(IDiffVisitor visitor, org.eclipse.core.resources.mapping.ResourceTraversal[] traversals) Visit all diffs in this tree that are covered by the given traversals.
IResource[]	getAffectedResources() Return all resources that contain diffs in this diff tree.
IDiff	getDiff(IResource resource) Return the diff for the given resource.
IDiff[]	getDiffs(IResource resource, int depth) Return all the diffs in the tree that are found for the given resource when traversed to the given depth.
IDiff[]	getDiffs(org.eclipse.core.resources.mapping.ResourceTraversal[] traversals) Return all the diffs in the tree that are contained in the given traversals.
IResource	getResource(IDiff diff) Return the resource associated with the given diff.
IResource[]	members(IResource resource) Return the members of the given resource that either have diffs in this tree of contain descendants that have diffs in this tree.

Methods inherited from interface org.eclipse.team.core.diff.IDiffTree

accept, addDiffChangeListener, clearBusy, countFor, getChildren, getDiff, getProperty, isEmpty, removeDiffChangeListener, setBusy, size

Method Detail

getDiff

public IDiff getDiff(IResource resource)

Return the diff for the given resource. This method is a convenience method that uses the path of the resource to access the diff.

Parameters:

resource - a resource

Returns:

the diff associated with the resource or null if the resource does not have any changes.

getResource

public IResource getResource(IDiff diff)

Return the resource associated with the given diff. This method will only return meaningful results for diffs which were obtained from this tree.

Parameters:

diff - a diff

Returns:

the resource associated with the given diff

accept

public void accept(IDiffVisitor visitor,
                   org.eclipse.core.resources.mapping.ResourceTraversal[] traversals)
            throws CoreException

Visit all diffs in this tree that are covered by the given traversals.

Parameters:

visitor - a diff visitor

traversals - the set of traversals whose diffs are to be visited

Throws:

CoreException

getDiffs

public IDiff[] getDiffs(org.eclipse.core.resources.mapping.ResourceTraversal[] traversals)

Return all the diffs in the tree that are contained in the given traversals.

Parameters:

traversals - the traversals

Returns:

all the diffs in the tree that are contained in the given traversals

getDiffs

public IDiff[] getDiffs(IResource resource,
                        int depth)

Return all the diffs in the tree that are found for the given resource when traversed to the given depth.

Parameters:

resource - the resource

depth - the depth

Returns:

all the diffs in the tree that are found for the given resource when traversed to the given depth

members

public IResource[] members(IResource resource)

Return the members of the given resource that either have diffs in this tree of contain descendants that have diffs in this tree.

Parameters:

resource - a resource

Returns:

the members of the given resource that either have diffs in this tree of contain descendants that have diffs in this tree

getAffectedResources

public IResource[] getAffectedResources()

Return all resources that contain diffs in this diff tree.

Returns:

all resources that contain diffs in this diff tree