Package com.github.koraktor.mavanagaiata.git.jgit

Class JGitRepository

java.lang.Object

com.github.koraktor.mavanagaiata.git.AbstractGitRepository

com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

All Implemented Interfaces:

GitRepository, AutoCloseable

public class JGitRepository
extends AbstractGitRepository

Wrapper around JGit's Repository object to represent a Git repository

Author:

Sebastian Staudt

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	checked
(package private) static String	COMMONDIR_FILE
(package private) static String	GITDIR_FILE
(package private) RevCommit	headCommit
(package private) ObjectId	headObject
private static String	INDEX_FILE
private static int	MAX_DESCRIBE_CANDIDATES
(package private) static String	REF_LINK_PREFIX
(package private) Repository	repository

Fields inherited from class com.github.koraktor.mavanagaiata.git.AbstractGitRepository

headRef

Constructor Summary

Constructors

Constructor	Description
JGitRepository()	Creates a new empty instance
JGitRepository(File workTree, File gitDir, String headRef)	Creates a new instance for the given worktree and or Git directory

Method Summary

Modifier and Type	Method	Description
(package private) void	buildRepository(File workTree, File gitDir)
void	check()	Checks whether the Git repository is accessible.
void	close()	Closes any resources that are needed to access this repository
private void	correctDistance(RevWalk revWalk, JGitTagCandidate candidate, RevFlagSet allFlags)	Correct the distance for all tag candidates.
(package private) IndexDiff	createIndexDiff()	Creates a new JGit IndexDiff instance for this repository and worktree
GitTagDescription	describe()	Describes the current Git commit like git describe does
private Collection<JGitTagCandidate>	findTagCandidates(RevWalk revWalk, Map<String,GitTag> tagCommits, RevFlagSet allFlags)	Find up to 10 tag candidates in the current branch.
String	getAbbreviatedCommitId(GitCommit commit)	Returns the abbreviated commit SHA ID of the given Git commit
String	getBranch()	Returns the currently checked out branch of the Git repository
JGitCommit	getHeadCommit()	Returns the current HEAD commit of the Git repository
(package private) ObjectId	getHeadObject()	Returns the object for the Git ref currently set as HEAD
String	getHeadRef()	Returns the Git ref used as the HEAD commit of the repository
(package private) RevCommit	getHeadRevCommit()	Returns a commit object for HEAD
(package private) FileRepositoryBuilder	getRepositoryBuilder()	Creates a new JGit FileRepositoryBuilder instance
(package private) RevWalk	getRevWalk()
Map<String,GitTag>	getTags()	Returns a map of tags available in this repository
File	getWorkTree()	Returns the worktree of the repository
boolean	isChecked()	Returns whether this repository instance has been checked
boolean	isDirty(boolean ignoreUntracked)	Returns whether the worktree of the repository is in a clean state
boolean	isOnUnbornBranch()	Returns whether this repository is currently on an “unborn” branch An “unborn” branch is a branch without any actual commits.
void	loadTag(GitTag tag)	Load tag meta data
<T extends CommitWalkAction> T	walkCommits(T action)	Runs the given action for all commits reachable from the current HEAD commit

Methods inherited from class com.github.koraktor.mavanagaiata.git.AbstractGitRepository

getAbbreviatedCommitId, getMailMap, setHeadRef

Methods inherited from class java.lang.Object

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

Field Detail

MAX_DESCRIBE_CANDIDATES

private static final int MAX_DESCRIBE_CANDIDATES

See Also:

Constant Field Values

COMMONDIR_FILE

static final String COMMONDIR_FILE

See Also:

Constant Field Values

GITDIR_FILE

static final String GITDIR_FILE

See Also:

Constant Field Values

INDEX_FILE

private static final String INDEX_FILE

See Also:

Constant Field Values

REF_LINK_PREFIX

static final String REF_LINK_PREFIX

See Also:

Constant Field Values

checked

private boolean checked

repository

Repository repository

headCommit

RevCommit headCommit

headObject

ObjectId headObject

Constructor Detail

JGitRepository

JGitRepository()

Creates a new empty instance

JGitRepository

public JGitRepository(File workTree,
                      File gitDir,
                      String headRef)
               throws GitRepositoryException

Creates a new instance for the given worktree and or Git directory

Parameters:

workTree - The worktree of the repository or null

gitDir - The GIT_DIR of the repository or null

headRef - The ref to use as HEAD

Throws:

GitRepositoryException - if the parameters do not match a Git repository

Method Detail

buildRepository

final void buildRepository(File workTree,
                           File gitDir)
                    throws GitRepositoryException

Throws:

GitRepositoryException

check

public void check()
           throws GitRepositoryException

Description copied from interface: GitRepository

Checks whether the Git repository is accessible.

Throws:

GitRepositoryException - if the repository is not accessible.

close

public void close()

Closes any resources that are needed to access this repository

Closes JGit's repository instance.

See Also:

Repository.close()

describe

public GitTagDescription describe()
                           throws GitRepositoryException

Description copied from interface: GitRepository

Describes the current Git commit like git describe does

Returns:

The description of the current HEAD commit

Throws:

GitRepositoryException - if the description cannot be created

getHeadRef

public String getHeadRef()

Description copied from interface: GitRepository

Returns the Git ref used as the HEAD commit of the repository

Returns:

The ref used as HEAD

findTagCandidates

private Collection<JGitTagCandidate> findTagCandidates(RevWalk revWalk,
                                                       Map<String,GitTag> tagCommits,
                                                       RevFlagSet allFlags)
                                                throws RevWalkException

Find up to 10 tag candidates in the current branch. One of these should be the latest tag.

Parameters:

revWalk - Repository information

tagCommits - Map of commits that are associated with a tag

allFlags - All flags that have been set so far

Returns:

A collection of tag candidates

Throws:

RevWalkException - if there’s an error during the rev walk

correctDistance

private void correctDistance(RevWalk revWalk,
                             JGitTagCandidate candidate,
                             RevFlagSet allFlags)
                      throws RevWalkException

Correct the distance for all tag candidates. We have to check all branches to get the correct distance at the end.

Parameters:

revWalk - Repository information

candidate - Collection of tag candidates

allFlags - All flags that have been set so far

Throws:

RevWalkException - if there’s an error during the rev walk

getAbbreviatedCommitId

public String getAbbreviatedCommitId(GitCommit commit)
                              throws GitRepositoryException

Description copied from interface: GitRepository

Returns the abbreviated commit SHA ID of the given Git commit

Parameters:

commit - The Git commit to get the abbreviated ID for

Returns:

The abbreviated commit ID of the given commit

Throws:

GitRepositoryException - if the abbreviated commit ID cannot be determined

getBranch

public String getBranch()
                 throws GitRepositoryException

Description copied from interface: GitRepository

Returns the currently checked out branch of the Git repository

Returns:

The current branch of the Git repository

Throws:

GitRepositoryException - if the current branch cannot be determined

getHeadCommit

public JGitCommit getHeadCommit()
                         throws GitRepositoryException

Description copied from interface: GitRepository

Returns the current HEAD commit of the Git repository

Returns:

The current commit of the Git Repository

Throws:

GitRepositoryException - if the current commit cannot be determined

createIndexDiff

IndexDiff createIndexDiff()
                   throws GitRepositoryException,
                          IOException

Creates a new JGit IndexDiff instance for this repository and worktree

Returns:

A new index diff

Throws:

GitRepositoryException - if the HEAD object cannot be resolved

IOException - if the index diff cannot be created

getRepositoryBuilder

FileRepositoryBuilder getRepositoryBuilder()

Creates a new JGit FileRepositoryBuilder instance

Returns:

A new repository builder

getTags

public Map<String,GitTag> getTags()
                                 throws GitRepositoryException

Description copied from interface: GitRepository

Returns a map of tags available in this repository

The keys of the map are the SHA IDs of the objects referenced by the tags. The map's values are the tags themselves.

Note: Only annotated tags referencing commit objects will be returned.

Returns:

A map of tags in this repository

Throws:

GitRepositoryException - if an error occurs while determining the tags in this repository

getWorkTree

public File getWorkTree()

Description copied from interface: GitRepository

Returns the worktree of the repository

Returns:

The worktree of the repository

isChecked

public boolean isChecked()

Description copied from interface: GitRepository

Returns whether this repository instance has been checked

Returns:

true if this repository has already been checked

See Also:

GitRepository.check()

isDirty

public boolean isDirty(boolean ignoreUntracked)
                throws GitRepositoryException

Description copied from interface: GitRepository

Returns whether the worktree of the repository is in a clean state

Parameters:

ignoreUntracked - If true, untracked files in the repository will be ignored

Returns:

true if there are modified files in the repository's worktree

Throws:

GitRepositoryException - if an error occurs while checking the worktree state

isOnUnbornBranch

public boolean isOnUnbornBranch()
                         throws GitRepositoryException

Description copied from interface: GitRepository

Returns whether this repository is currently on an “unborn” branch An “unborn” branch is a branch without any actual commits. This only applies when the configured head ref is actually HEAD. Otherwise a configuration error is assumed.

Returns:

true if the current branch is

Throws:

GitRepositoryException - if an error occurs while retrieving the current HEAD commit

loadTag

public void loadTag(GitTag tag)
             throws GitRepositoryException

Description copied from interface: GitRepository

Load tag meta data

Parameters:

tag - The tag to load information for

Throws:

GitRepositoryException - if tag metadata cannot be loaded

walkCommits

public <T extends CommitWalkAction> T walkCommits(T action)
                                           throws GitRepositoryException

Description copied from interface: GitRepository

Runs the given action for all commits reachable from the current HEAD commit

Type Parameters:

T - The action’s type

Parameters:

action - The action to execute for each commit found

Returns:

The action itself

Throws:

GitRepositoryException - if an error occurs during walking through the commits

getHeadRevCommit

RevCommit getHeadRevCommit()
                    throws GitRepositoryException

Returns a commit object for HEAD

Returns:

The commit object for HEAD

Throws:

GitRepositoryException - if the commit object cannot be retrieved

See Also:

RevCommit

getHeadObject

ObjectId getHeadObject()
                throws GitRepositoryException

Returns the object for the Git ref currently set as HEAD

Returns:

The currently selected HEAD object

Throws:

GitRepositoryException - if the ref cannot be resolved

getRevWalk

RevWalk getRevWalk()

Returns:

A new JGit RevWalk instance for this repository