pl.project13.maven.git

Class GitDataProvider

java.lang.Object

pl.project13.maven.git.GitDataProvider

Direct Known Subclasses:

JGitProvider, NativeGitProvider

public abstract class GitDataProvider
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected int	abbrevLength
protected String	dateFormat
protected String	dateFormatTimeZone
protected GitDescribeConfig	gitDescribe
protected LoggerBridge	loggerBridge
protected String	prefixDot
protected boolean	verbose

Constructor Summary

Constructors

Constructor and Description
GitDataProvider(LoggerBridge loggerBridge)

Method Summary

Methods

Modifier and Type	Method and Description
protected String	determineBranchName(Map<String,String> env) If running within Jenkins/Hudosn, honor the branch name passed via GIT_BRANCH env var.
protected String	determineBranchNameOnBuildServer(Map<String,String> env) Is "Jenkins aware", and prefers GIT_BRANCH to getting the branch via git if that enviroment variable is set.
protected abstract void	finalCleanUp()
protected abstract String	getAbbrevCommitId()
protected abstract String	getBranchName()
protected abstract String	getBuildAuthorEmail()
protected abstract String	getBuildAuthorName()
protected abstract String	getClosestTagCommitCount()
protected abstract String	getClosestTagName()
protected abstract String	getCommitAuthorEmail()
protected abstract String	getCommitAuthorName()
protected abstract String	getCommitId()
protected abstract String	getCommitMessageFull()
protected abstract String	getCommitMessageShort()
protected abstract String	getCommitTime()
protected abstract String	getGitDescribe()
protected abstract String	getRemoteOriginUrl()
protected SimpleDateFormat	getSimpleDateFormatWithTimeZone()
protected abstract String	getTags()
protected abstract void	init()
protected abstract boolean	isDirty()
void	loadGitData(Properties properties)
protected abstract void	prepareGitToExtractMoreDetailedReproInformation()
protected void	put(Properties properties, String key, String value)
GitDataProvider	setAbbrevLength(int abbrevLength)
GitDataProvider	setDateFormat(String dateFormat)
GitDataProvider	setDateFormatTimeZone(String dateFormatTimeZone)
GitDataProvider	setGitDescribe(GitDescribeConfig gitDescribe)
GitDataProvider	setPrefixDot(String prefixDot)

Methods inherited from class java.lang.Object

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

Field Detail

loggerBridge

@NotNull
protected LoggerBridge loggerBridge

verbose

protected boolean verbose

prefixDot

protected String prefixDot

abbrevLength

protected int abbrevLength

dateFormat

protected String dateFormat

dateFormatTimeZone

protected String dateFormatTimeZone

gitDescribe

protected GitDescribeConfig gitDescribe

Constructor Detail

GitDataProvider

public GitDataProvider(@NotNull
               LoggerBridge loggerBridge)

Method Detail

setGitDescribe

public GitDataProvider setGitDescribe(GitDescribeConfig gitDescribe)

setPrefixDot

public GitDataProvider setPrefixDot(String prefixDot)

setAbbrevLength

public GitDataProvider setAbbrevLength(int abbrevLength)

setDateFormat

public GitDataProvider setDateFormat(String dateFormat)

setDateFormatTimeZone

public GitDataProvider setDateFormatTimeZone(String dateFormatTimeZone)

init

protected abstract void init()
                      throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getBuildAuthorName

protected abstract String getBuildAuthorName()

getBuildAuthorEmail

protected abstract String getBuildAuthorEmail()

prepareGitToExtractMoreDetailedReproInformation

protected abstract void prepareGitToExtractMoreDetailedReproInformation()
                                                                 throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getBranchName

protected abstract String getBranchName()
                                 throws IOException

Throws:

IOException

getGitDescribe

protected abstract String getGitDescribe()
                                  throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getCommitId

protected abstract String getCommitId()

getAbbrevCommitId

protected abstract String getAbbrevCommitId()
                                     throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

isDirty

protected abstract boolean isDirty()
                            throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getCommitAuthorName

protected abstract String getCommitAuthorName()

getCommitAuthorEmail

protected abstract String getCommitAuthorEmail()

getCommitMessageFull

protected abstract String getCommitMessageFull()

getCommitMessageShort

protected abstract String getCommitMessageShort()

getCommitTime

protected abstract String getCommitTime()

getRemoteOriginUrl

protected abstract String getRemoteOriginUrl()
                                      throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getTags

protected abstract String getTags()
                           throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getClosestTagName

protected abstract String getClosestTagName()
                                     throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getClosestTagCommitCount

protected abstract String getClosestTagCommitCount()
                                            throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

finalCleanUp

protected abstract void finalCleanUp()

loadGitData

public void loadGitData(@NotNull
               Properties properties)
                 throws IOException,
                        org.apache.maven.plugin.MojoExecutionException

Throws:

IOException

org.apache.maven.plugin.MojoExecutionException

determineBranchName

protected String determineBranchName(Map<String,String> env)
                              throws IOException

If running within Jenkins/Hudosn, honor the branch name passed via GIT_BRANCH env var. This is necessary because Jenkins/Hudson alwways invoke build in a detached head state.

Parameters:

env - environment settings

Returns:

results of getBranchName() or, if in Jenkins/Hudson, value of GIT_BRANCH

Throws:

IOException

determineBranchNameOnBuildServer

protected String determineBranchNameOnBuildServer(Map<String,String> env)
                                           throws IOException

Is "Jenkins aware", and prefers GIT_BRANCH to getting the branch via git if that enviroment variable is set. The GIT_BRANCH variable is set by Jenkins/Hudson when put in detached HEAD state, but it still knows which branch was cloned.

Throws:

IOException

getSimpleDateFormatWithTimeZone

protected SimpleDateFormat getSimpleDateFormatWithTimeZone()

put

protected void put(@NotNull
       Properties properties,
       String key,
       String value)