Eclipse Plug-in Developer Guide (Galileo) - IFileHistoryProvider (Eclipse Platform API Specification)

Field Summary

static int NONE
          Constant flag used with getFileHistoryFor(IResource, int, IProgressMonitor) to indicate no flags.

static int SINGLE_LINE_OF_DESCENT
          Constant flag used with getFileHistoryFor(IResource, int, IProgressMonitor) to indicate that the resulting history will be restricted to a single line-of-descent (e.g. a single branch).

static int SINGLE_REVISION
          Constant flag used with getFileHistoryFor(IResource, int, IProgressMonitor) to indicate that only a single revision is desired.

Method Summary

IFileHistory getFileHistoryFor ( IFileStore store, int flags, IProgressMonitor monitor)
          Returns an IFileHistory for the specified IFileStore.

IFileHistory getFileHistoryFor ( IResource resource, int flags, IProgressMonitor monitor)
          Returns the file history for the given in resource.

IFileRevision getWorkspaceFileRevision ( IResource resource)
          Returns the file revision of the passed in resource or null if that file revision cannot be determined

Field Detail

NONE

static final int NONE

Constant flag used with getFileHistoryFor(IResource, int, IProgressMonitor) to indicate no flags.

See Also:: Constant Field Values

SINGLE_REVISION

static final int SINGLE_REVISION

Constant flag used with getFileHistoryFor(IResource, int, IProgressMonitor) to indicate that only a single revision is desired.

See Also:: Constant Field Values

SINGLE_LINE_OF_DESCENT

static final int SINGLE_LINE_OF_DESCENT

Constant flag used with getFileHistoryFor(IResource, int, IProgressMonitor) to indicate that 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.

See Also:: Constant Field Values

Method Detail

getFileHistoryFor


IFileHistory getFileHistoryFor(
IResource resource,
                               int flags,
                               
IProgressMonitor monitor)

Returns the file history for the given in resource. If the flags contains SINGLE_REVISION then only the revision corresponding to the base corresponding to the local resource is fetched. If the flags contains SINGLE_LINE_OF_DESCENT 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. If both flags are present, SINGLE_REVISION should take precedence.

Parameters:: resource - the resource; flags - to indicate what revisions should be included in the history; monitor - a progress monitor
Returns:: the history of the file

getWorkspaceFileRevision


IFileRevision getWorkspaceFileRevision(
IResource resource)

Returns the file revision of the passed in resource 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

getFileHistoryFor


IFileHistory getFileHistoryFor(
IFileStore store,
                               int flags,
                               
IProgressMonitor monitor)

Returns an IFileHistory for the specified IFileStore.

Parameters:: store - an IFileStore; flags - SINGLE_REVISION or SINGLE_LINE_OF_DESCENT; monitor - a progress monitor
Returns:: the history for the IFileStore