Package com.intellij.vcs.log

Interface VcsLogDiffHandler

All Known Implementing Classes:

GitLogDiffHandler

public interface VcsLogDiffHandler

Enables showing diff between revisions and comparing file or directory state between a revision and a local version in log-based file history. Methods of this class could be called from EDT, so it should deal with it appropriately by starting a background task for long operations, eg for loading revisions content.

Method Summary

Modifier and Type	Method and Description
ContentRevision	createContentRevision(FilePath filePath, Hash hash) Create a ContentRevision for specified path and commit.
void	showDiff(VirtualFile root, FilePath leftPath, Hash leftHash, FilePath rightPath, Hash rightHash) Show diff between (the after-state of) two revisions in the specified files or directories.
void	showDiffForPaths(VirtualFile root, java.util.Collection<FilePath> affectedPaths, Hash leftRevision, Hash rightRevision) Show diff between two revisions or between a revision and a local version for the specified set of paths.
void	showDiffWithLocal(VirtualFile root, FilePath revisionPath, Hash hash, FilePath localPath) Show diff between (the after-state of) specified revision and local version for the specified file or directory.

Method Detail

showDiff

void showDiff(VirtualFile root,
              FilePath leftPath,
              Hash leftHash,
              FilePath rightPath,
              Hash rightHash)

Show diff between (the after-state of) two revisions in the specified files or directories.

Parameters:

root - repository root.

leftPath - path to the file on the left, null means file is missing in this revision.

leftHash - hash of the revision on the left.

rightPath - path to the file on the right, null means file is missing in this revision.

rightHash - hash of the revision on the right.

showDiffWithLocal

void showDiffWithLocal(VirtualFile root,
                       FilePath revisionPath,
                       Hash hash,
                       FilePath localPath)

Show diff between (the after-state of) specified revision and local version for the specified file or directory.

Parameters:

root - repository root.

revisionPath - path to the file in the specified revision, null means file is not present in the revision.

hash - hash of the revision.

localPath - local path to the file.

showDiffForPaths

void showDiffForPaths(VirtualFile root,
                      java.util.Collection<FilePath> affectedPaths,
                      Hash leftRevision,
                      Hash rightRevision)

Show diff between two revisions or between a revision and a local version for the specified set of paths.

Parameters:

root - repository root.

affectedPaths - paths for which to show diff, null means to show all changes between revisions.

leftRevision - hash of the revision on the left.

rightRevision - hash of the revision on the right or null if local revision is required.

createContentRevision

ContentRevision createContentRevision(FilePath filePath,
                                      Hash hash)

Create a ContentRevision for specified path and commit.

Parameters:

filePath - file path to create content revision for.

hash - hash of the revision.

Returns:

content revision.