Package com.github.koraktor.mavanagaiata.git

Class AbstractGitRepository

java.lang.Object

com.github.koraktor.mavanagaiata.git.AbstractGitRepository

All Implemented Interfaces:

GitRepository, AutoCloseable

Direct Known Subclasses:

JGitRepository

public abstract class AbstractGitRepository
extends Object
implements GitRepository

An abstract implementation of a Git repository that provides basic and common functionality

Author:

Sebastian Staudt

Field Summary

Fields

Modifier and Type	Field	Description
protected String	headRef

Constructor Summary

Constructors

Constructor	Description
AbstractGitRepository()

Method Summary

Modifier and Type	Method	Description
String	getAbbreviatedCommitId()	Returns the abbreviated commit SHA ID of the current Git commit
MailMap	getMailMap()	Returns a MailMap object that holds information from Git's .mailmap file
void	setHeadRef(String headRef)	Sets the Git ref to use as the HEAD commit of the repository

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.koraktor.mavanagaiata.git.GitRepository

check, close, describe, getAbbreviatedCommitId, getBranch, getHeadCommit, getHeadRef, getTags, getWorkTree, isChecked, isDirty, isOnUnbornBranch, loadTag, walkCommits

Field Details

headRef

protected String headRef

Constructor Details

AbstractGitRepository

public AbstractGitRepository()

Method Details

getAbbreviatedCommitId

public String getAbbreviatedCommitId()
                              throws GitRepositoryException

Description copied from interface: GitRepository

Returns the abbreviated commit SHA ID of the current Git commit

Specified by:

getAbbreviatedCommitId in interface GitRepository

Returns:

The abbreviated commit ID of the current HEAD commit

Throws:

GitRepositoryException - if the abbreviated commit ID cannot be determined

getMailMap

public MailMap getMailMap()
                   throws GitRepositoryException

Description copied from interface: GitRepository

Returns a MailMap object that holds information from Git's .mailmap file

Specified by:

getMailMap in interface GitRepository

Returns:

A .mailmap representation or null if none exits

Throws:

GitRepositoryException - if the .mailmap file cannot be read or parsed

setHeadRef

public void setHeadRef(String headRef)

Description copied from interface: GitRepository

Sets the Git ref to use as the HEAD commit of the repository

Specified by:

setHeadRef in interface GitRepository

Parameters:

headRef - The ref to use as HEAD