refdiff.core

Class RefDiff

java.lang.Object

refdiff.core.RefDiff

public class RefDiff
extends java.lang.Object

High level API of RefDiff, providing methods to compute CST diffs between revisions (commits) of a git repository.

Constructor Summary

Constructors

Constructor and Description
RefDiff(LanguagePlugin parser) Build a RefDiff instance with the specified language plugin.

Method Summary

Modifier and Type	Method and Description
java.io.File	cloneGitRepository(java.io.File destinationFolder, java.lang.String cloneUrl) Clone a git repository in a local folder.
CstDiff	computeDiffBetweenRevisions(org.eclipse.jgit.lib.Repository repo, org.eclipse.jgit.revwalk.RevCommit revBefore, org.eclipse.jgit.revwalk.RevCommit revAfter) Low level method that computes the CST diff between two arbitrary revisions.
CstDiff	computeDiffForCommit(java.io.File gitRepository, java.lang.String commitSha1) Compute a CST diff between a commit and its parent commit (previous revision).
void	computeDiffForCommitHistory(java.io.File gitRepository, int maxDepth, java.util.function.BiConsumer<org.eclipse.jgit.revwalk.RevCommit,CstDiff> diffConsumer) Compute the CST diff for each commit in the git repository, starting from HEAD.
void	computeDiffForCommitHistory(java.io.File gitRepository, java.lang.String startAt, int maxDepth, java.util.function.BiConsumer<org.eclipse.jgit.revwalk.RevCommit,CstDiff> diffConsumer) Compute the CST diff for each commit in the git repository, starting from the specified commit.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RefDiff

public RefDiff(LanguagePlugin parser)

Build a RefDiff instance with the specified language plugin. E.g.: new RefDiff(new JsParser()).

Parameters:

parser - A language parser

Method Detail

cloneGitRepository

public java.io.File cloneGitRepository(java.io.File destinationFolder,
                                       java.lang.String cloneUrl)

Clone a git repository in a local folder. Note that the repository will be clone in bare mode (see git clone documentation).

Parameters:

destinationFolder - Folder in which the repository will be cloned.

cloneUrl - The URL of the repository.

Returns:

The destination folder.

computeDiffForCommit

public CstDiff computeDiffForCommit(java.io.File gitRepository,
                                    java.lang.String commitSha1)

Compute a CST diff between a commit and its parent commit (previous revision). This method will throw an exception if the given commit has more than one parent (e.g., merge commits).

Parameters:

gitRepository - The folder of the git repository (you should pass the .git folder if the repository is not on bare mode).

commitSha1 - SHA1 (or git object reference) that identifies the commit.

Returns:

The computed CST diff.

computeDiffForCommitHistory

public void computeDiffForCommitHistory(java.io.File gitRepository,
                                        int maxDepth,
                                        java.util.function.BiConsumer<org.eclipse.jgit.revwalk.RevCommit,CstDiff> diffConsumer)

Compute the CST diff for each commit in the git repository, starting from HEAD.

Parameters:

gitRepository - The folder of the git repository (you should pass the .git folder if the repository is not on bare mode).

maxDepth - Number of commits that will be navigated backwards at maximum.

diffConsumer - Consumer function that will be called for each computed CST diff.

computeDiffForCommitHistory

public void computeDiffForCommitHistory(java.io.File gitRepository,
                                        java.lang.String startAt,
                                        int maxDepth,
                                        java.util.function.BiConsumer<org.eclipse.jgit.revwalk.RevCommit,CstDiff> diffConsumer)

Compute the CST diff for each commit in the git repository, starting from the specified commit. Merge comits are skipped.

Parameters:

gitRepository - The folder of the git repository (you should pass the .git folder if the repository is not on bare mode).

startAt - git object reference of the starting commit.

maxDepth - Number of commits that will be navigated backwards at maximum.

diffConsumer - Consumer function that will be called for each computed CST diff.

computeDiffBetweenRevisions

public CstDiff computeDiffBetweenRevisions(org.eclipse.jgit.lib.Repository repo,
                                           org.eclipse.jgit.revwalk.RevCommit revBefore,
                                           org.eclipse.jgit.revwalk.RevCommit revAfter)

Low level method that computes the CST diff between two arbitrary revisions. This method operates directly with jgit objects such as Repository and RevCommit. For more details on jgit library, please refer to JGit documentation.

Parameters:

repo - The jgit repository object.

revBefore - The jgit commit object before the change.

revAfter - The jgit commit object after the change.

Returns:

The computed CST diff between revisions.