org.eclipse.team.core.history
Interface IFileHistoryProvider

All Known Implementing Classes:

FileHistoryProvider

public interface IFileHistoryProvider

This is API to access individual file histories.

This interface is not intended to be implemented by clients. Clients can instead subclass FileHistoryProvider

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

Method Summary

IFileHistory	getFileHistoryFor(IResource resource, boolean singleLine, IProgressMonitor monitor) Returns the file history for the given in resource.
IFileRevision	getWorkspaceFileRevision(IResource resource) Returns the file revision of the passed in resourrce or null if that file revision cannot be determined

Method Detail

getFileHistoryFor

public IFileHistory getFileHistoryFor(IResource resource,
                                      boolean singleLine,
                                      IProgressMonitor monitor)

Returns the file history for the given in resource. If singleLine is true then the resulting history will be restricted to a single line-of-descent (e.g. a single branch). In this mode, the IFileHistory.getContributors(IFileRevision) and IFileHistory.getTargets(IFileRevision) should either return zero or one revision.

Parameters:

resource - the resource

singleLine - whether the returned history should be restricted to a single line of descent

monitor - a progress monitor

Returns:

the history of the file

getWorkspaceFileRevision

public IFileRevision getWorkspaceFileRevision(IResource resource)

Returns the file revision of the passed in resourrce or null if that file revision cannot be determined

Parameters:

resource - the resource

Returns:

the file revision belonging to the passed in resource or null