Package com.github.koraktor.mavanagaiata.git

Klasse AbstractGitRepository

java.lang.Object

com.github.koraktor.mavanagaiata.git.AbstractGitRepository

Alle implementierten Schnittstellen:

GitRepository, AutoCloseable

Bekannte direkte Unterklassen:

JGitRepository

public abstract class AbstractGitRepository
extends Object
implements GitRepository

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

Autor:

Sebastian Staudt

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected String	headRef
(Package privat) MailMap	mailMap

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
AbstractGitRepository()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
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

Von Klasse geerbte Methoden java.lang.Object

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

Von Schnittstelle geerbte Methoden com.github.koraktor.mavanagaiata.git.GitRepository

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

Felddetails

headRef

protected String headRef

mailMap

MailMap mailMap

Konstruktordetails

AbstractGitRepository

public AbstractGitRepository()

Methodendetails

getAbbreviatedCommitId

public String getAbbreviatedCommitId()
                              throws GitRepositoryException

Beschreibung aus Schnittstelle kopiert: GitRepository

Returns the abbreviated commit SHA ID of the current Git commit

Angegeben von:

getAbbreviatedCommitId in Schnittstelle GitRepository

Gibt zurück:

The abbreviated commit ID of the current HEAD commit

Löst aus:

GitRepositoryException - if the abbreviated commit ID cannot be determined

getMailMap

public MailMap getMailMap()
                   throws GitRepositoryException

Beschreibung aus Schnittstelle kopiert: GitRepository

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

Angegeben von:

getMailMap in Schnittstelle GitRepository

Gibt zurück:

A .mailmap representation or null if none exits

Löst aus:

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

setHeadRef

public void setHeadRef(String headRef)

Beschreibung aus Schnittstelle kopiert: GitRepository

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

Angegeben von:

setHeadRef in Schnittstelle GitRepository

Parameter:

headRef - The ref to use as HEAD