org.eclipse.team.core.diff
Interface IDiff

All Known Subinterfaces:

IResourceDiff, IThreeWayDiff, ITwoWayDiff

All Known Implementing Classes:

Diff, ResourceDiff, ThreeWayDiff, TwoWayDiff

public interface IDiff

A diff describes differences between two or more model objects.

This interface is not intended to be implemented by clients. Instead, clients can subclass Diff.

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:

ITwoWayDiff, IThreeWayDiff

Field Summary

static int	ADD Diff kind constant (bit mask) indicating that the resource has been added to its parent.
static int	CHANGE Diff kind constant (bit mask) indicating that the resource has been changed.
static int	NO_CHANGE Diff kind constant (bit mask) indicating that the resource has not been changed in any way.
static int	REMOVE Diff kind constant (bit mask) indicating that the resource has been removed from its parent.

Method Summary

int	getKind() Returns the kind of this diff.
IPath	getPath() Returns the full, absolute path of the object to which the diff applies with respect to the model root.
String	toDiffString() Return a string that describes the difference represented by this node.

Field Detail

NO_CHANGE

public static final int NO_CHANGE

Diff kind constant (bit mask) indicating that the resource has not been changed in any way.

See Also:

getKind(), Constant Field Values

ADD

public static final int ADD

Diff kind constant (bit mask) indicating that the resource has been added to its parent. That is, one that appears in the "after" state, not in the "before" one.

See Also:

getKind(), Constant Field Values

REMOVE

public static final int REMOVE

Diff kind constant (bit mask) indicating that the resource has been removed from its parent. That is, one that appears in the "before" state, not in the "after" one.

See Also:

getKind(), Constant Field Values

CHANGE

public static final int CHANGE

Diff kind constant (bit mask) indicating that the resource has been changed. That is, one that appears in both the "before" and "after" states.

See Also:

getKind(), Constant Field Values

Method Detail

getPath

public IPath getPath()

Returns the full, absolute path of the object to which the diff applies with respect to the model root.

Note: the returned path never has a trailing separator.

Returns:

the full, absolute path of this diff

getKind

public int getKind()

Returns the kind of this diff. Normally, one of ADDED, REMOVED, CHANGED.

Returns:

the kind of this diff

See Also:

ADD, REMOVE, CHANGE

toDiffString

public String toDiffString()

Return a string that describes the difference represented by this node.

Returns:

a string that describes the difference represented by this node