Package com.intellij.openapi.vcs.history

Interface VcsHistoryProvider

All Known Subinterfaces:

VcsHistoryProviderEx

All Known Implementing Classes:

CvsHistoryProvider, GitHistoryProvider, HgHistoryProvider, SvnHistoryProvider

public interface VcsHistoryProvider

Method Summary

Modifier and Type	Method and Description
boolean	canShowHistoryFor(VirtualFile file) Provide any additional restrictions for showing history for the given file.
VcsHistorySession	createSessionFor(FilePath filePath) Returns the history session for the specified file path.
AnAction[]	getAdditionalActions(java.lang.Runnable refresher)
java.lang.String	getHelpId()
DiffFromHistoryHandler	getHistoryDiffHandler() The returned DiffFromHistoryHandler will be called, when user calls "Show Diff" from the file history panel.
VcsDependentHistoryComponents	getUICustomization(VcsHistorySession session, javax.swing.JComponent forShortcutRegistration)
boolean	isDateOmittable() Returns whether the history provider submits the custom-formatted date and the standard "Date" column must be omitted to get rid of confusion.
void	reportAppendableHistory(FilePath path, VcsAppendableHistorySessionPartner partner)
boolean	supportsHistoryForDirectories()

Method Detail

getUICustomization

VcsDependentHistoryComponents getUICustomization(VcsHistorySession session,
                                                 javax.swing.JComponent forShortcutRegistration)

getAdditionalActions

AnAction[] getAdditionalActions(java.lang.Runnable refresher)

isDateOmittable

boolean isDateOmittable()

Returns whether the history provider submits the custom-formatted date and the standard "Date" column must be omitted to get rid of confusion.

Returns:

true if history provider submits the custom-formatted date.

getHelpId

java.lang.String getHelpId()

createSessionFor

VcsHistorySession createSessionFor(FilePath filePath)
                            throws VcsException

Returns the history session for the specified file path.

Parameters:

filePath - the file path for which the session is requested.

Returns:

the session, or null if the initial revisions loading process was cancelled.

Throws:

VcsException - if an error occurred when loading the revisions

reportAppendableHistory

void reportAppendableHistory(FilePath path,
                             VcsAppendableHistorySessionPartner partner)
                      throws VcsException

Throws:

VcsException

supportsHistoryForDirectories

boolean supportsHistoryForDirectories()

getHistoryDiffHandler

DiffFromHistoryHandler getHistoryDiffHandler()

The returned DiffFromHistoryHandler will be called, when user calls "Show Diff" from the file history panel. If null is returned, the standard handler will be used, which is suitable for most cases.

canShowHistoryFor

boolean canShowHistoryFor(VirtualFile file)

Provide any additional restrictions for showing history for the given file. Basic restrictions are checked in the TabbedShowHistoryAction.

Parameters:

file - File which history is requested or may be requested.

Returns:

true if the VCS can show history for this file.