fr.brouillard.oss.jgitver.impl

Class GitVersionCalculatorImpl

java.lang.Object

fr.brouillard.oss.jgitver.impl.GitVersionCalculatorImpl

All Implemented Interfaces:

GitVersionCalculator, MetadataProvider, AutoCloseable

public class GitVersionCalculatorImpl
extends Object
implements GitVersionCalculator

Method Summary

Modifier and Type	Method and Description
void	close()
String	getVersion() Return the version to use for the current git repository depending on the HEAD position.
String	getVersion(boolean forceComputation) Calculates if necessary the version to use for the current git repository depending on the HEAD position.
Version	getVersionObject() Return the version to use for the current git repository depending on the HEAD position.
Version	getVersionObject(boolean forceComputation) Calculates the version to use for the current git repository depending on the HEAD position.
Optional<String>	meta(Metadatas meta)
GitVersionCalculator	setAutoIncrementPatch(boolean value) When true, when the found tag to calculate a version for HEAD is a normal/annotated one, the semver patch version of the tag is increased by one ; except when the tag is on the HEAD itself.
GitVersionCalculator	setFindTagVersionPattern(String pattern) Defines a regexp search pattern that will match tags identifying a version.
GitVersionCalculator	setForceComputation(boolean forceComputation) When true, force the computation of the version even if HEAD is on a version tag.
GitVersionCalculator	setGitCommitIdLength(int gitCommitIdLength) Defines how long the qualifier from SHA1 git commit has to be.
GitVersionCalculator	setLookupPolicy(LookupPolicy policy) Defines the LookupPolicy to be used for the next version resolution.
GitVersionCalculator	setMavenLike(boolean mavenLike) Activates the maven like mode.
GitVersionCalculator	setMaxDepth(int maxDepth) Defines max depth to look for version tags, defaults to Integer.MAX_VALUE.
GitVersionCalculator	setNonQualifierBranches(String nonQualifierBranches) Defines a comma separated list of branches for which no branch name qualifier will be used. default "master".
GitVersionCalculator	setQualifierBranchingPolicies(BranchingPolicy... policies) Sets as an array the policies that will be applied to try to build a qualifier from the branch of the HEAD.
GitVersionCalculator	setQualifierBranchingPolicies(List<BranchingPolicy> policies) Sets as a list the policies that will be applied to try to build a qualifier from the branch of the HEAD.
GitVersionCalculator	setScript(String script) Set the script to be interpreted.
GitVersionCalculator	setScriptType(ScriptType scriptType) Set the type of the script (default: ScriptType.GROOVY).
GitVersionCalculator	setStrategy(Strategies s) Defines the strategy to use.
GitVersionCalculator	setTagVersionPattern(String pattern) Defines the version pattern to use in Strategies.PATTERN mode when HEAD is on an annotated tag
GitVersionCalculator	setUseDefaultBranchingPolicy(boolean useDefaultBranchingPolicy) When true, uses BranchingPolicy.DEFAULT_FALLBACK as last BranchingPolicy.
GitVersionCalculator	setUseDirty(boolean useDirty) When true, append a qualifier with the "dirty" qualifier if the repository is in a dirty state (ie with uncommited changes or new files)
GitVersionCalculator	setUseDistance(boolean useDistance) When true, append a qualifier with the distance between the HEAD commit and the found commit with a version tag.
GitVersionCalculator	setUseGitCommitId(boolean useGitCommitId) When true, append the git commit id (SHA1) to the version.
GitVersionCalculator	setUseGitCommitTimestamp(boolean useGitCommitTimestamp) When true, append the git commit timestamp to the version.
GitVersionCalculator	setUseLongFormat(boolean useLongFormat) When true describes commits hash with long format pattern, ie preceded with the letter 'g'.
GitVersionCalculator	setUseSnapshot(boolean useSnapshot) When true, append a qualifier with the "SNAPSHOT" qualifier if no version tags found.
GitVersionCalculator	setVersionPattern(String pattern) Defines the version pattern to use in Strategies.PATTERN mode for normal situation (i.e. not on a tag)

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.brouillard.oss.jgitver.GitVersionCalculator

location

Method Detail

getVersionObject

public Version getVersionObject(boolean forceComputation)

Description copied from interface: GitVersionCalculator

Calculates the version to use for the current git repository depending on the HEAD position.

Specified by:

getVersionObject in interface GitVersionCalculator

Parameters:

forceComputation - true to discard any previous cached result, false allow to reuse already cached values

Returns:

the version object computed

getVersionObject

public Version getVersionObject()

Description copied from interface: GitVersionCalculator

Return the version to use for the current git repository depending on the HEAD position. Can return cached values if no parameters have changed since last computation.

Specified by:

getVersionObject in interface GitVersionCalculator

Returns:

the calculated version object

getVersion

public String getVersion()

Description copied from interface: GitVersionCalculator

Return the version to use for the current git repository depending on the HEAD position. If the computation was already performed, ust return the last computed value.

Specified by:

getVersion in interface GitVersionCalculator

Returns:

a string representation of this version.

getVersion

public String getVersion(boolean forceComputation)

Description copied from interface: GitVersionCalculator

Calculates if necessary the version to use for the current git repository depending on the HEAD position.

Specified by:

getVersion in interface GitVersionCalculator

Parameters:

forceComputation - true to force computation even if no computation parameters have changed, false to allow to retrieve the value from the last computed version.

Returns:

a string representation of this version.

close

public void close()
           throws Exception

Specified by:

close in interface GitVersionCalculator

Specified by:

close in interface AutoCloseable

Throws:

Exception

setAutoIncrementPatch

public GitVersionCalculator setAutoIncrementPatch(boolean value)

Description copied from interface: GitVersionCalculator

When true, when the found tag to calculate a version for HEAD is a normal/annotated one, the semver patch version of the tag is increased by one ; except when the tag is on the HEAD itself. This action is not in use if the SNAPSHOT qualifier is present on the found version or if the found tag is a lightweight one.

Specified by:

setAutoIncrementPatch in interface GitVersionCalculator

Parameters:

value - if true and when found tag is not on HEAD, then version returned will be the found version with patch number increased by one. default false.

Returns:

itself to chain settings

setNonQualifierBranches

public GitVersionCalculator setNonQualifierBranches(String nonQualifierBranches)

Description copied from interface: GitVersionCalculator

Defines a comma separated list of branches for which no branch name qualifier will be used. default "master". Example: "master, integration" This method overrides the usage of GitVersionCalculator.setQualifierBranchingPolicies(List) & GitVersionCalculator.setQualifierBranchingPolicies(BranchingPolicy...).

Specified by:

setNonQualifierBranches in interface GitVersionCalculator

Parameters:

nonQualifierBranches - a comma separated list of branch name for which no branch name qualifier should be used, can be null and/or empty

Returns:

itself to chain settings

setQualifierBranchingPolicies

public GitVersionCalculator setQualifierBranchingPolicies(BranchingPolicy... policies)

Description copied from interface: GitVersionCalculator

Sets as an array the policies that will be applied to try to build a qualifier from the branch of the HEAD. This method overrides the usage of GitVersionCalculator.setNonQualifierBranches(String) & GitVersionCalculator.setQualifierBranchingPolicies(List).

Specified by:

setQualifierBranchingPolicies in interface GitVersionCalculator

Parameters:

policies - an array of policies to apply can be empty

Returns:

itself to chain settings

setQualifierBranchingPolicies

public GitVersionCalculator setQualifierBranchingPolicies(List<BranchingPolicy> policies)

Description copied from interface: GitVersionCalculator

Sets as a list the policies that will be applied to try to build a qualifier from the branch of the HEAD. This method overrides the usage of GitVersionCalculator.setNonQualifierBranches(String) & GitVersionCalculator.setQualifierBranchingPolicies(BranchingPolicy...).

Specified by:

setQualifierBranchingPolicies in interface GitVersionCalculator

Parameters:

policies - an array of policies to apply can be empty

Returns:

itself to chain settings

setUseDistance

public GitVersionCalculator setUseDistance(boolean useDistance)

Description copied from interface: GitVersionCalculator

When true, append a qualifier with the distance between the HEAD commit and the found commit with a version tag. This qualifier is not used if the SNAPSHOT qualifier is used.

Specified by:

setUseDistance in interface GitVersionCalculator

Parameters:

useDistance - if true, a qualifier with found distance will be used.

Returns:

itself to chain settings

setUseDirty

public GitVersionCalculator setUseDirty(boolean useDirty)

Description copied from interface: GitVersionCalculator

When true, append a qualifier with the "dirty" qualifier if the repository is in a dirty state (ie with uncommited changes or new files)

Specified by:

setUseDirty in interface GitVersionCalculator

Parameters:

useDirty - if true, a qualifier with "dirty" qualifier will be used if the repository is stall.

Returns:

itself to chain settings

setUseLongFormat

public GitVersionCalculator setUseLongFormat(boolean useLongFormat)

Description copied from interface: GitVersionCalculator

When true describes commits hash with long format pattern, ie preceded with the letter 'g'.

Specified by:

setUseLongFormat in interface GitVersionCalculator

Parameters:

useLongFormat - if true and useGitCommitId, then commitId will be prepended with a 'g' to be compliant with `git describe --long` format

Returns:

itself to chain settings

setUseGitCommitId

public GitVersionCalculator setUseGitCommitId(boolean useGitCommitId)

Description copied from interface: GitVersionCalculator

When true, append the git commit id (SHA1) to the version. This qualifier is not used if the SNAPSHOT qualifier is used.

Specified by:

setUseGitCommitId in interface GitVersionCalculator

Parameters:

useGitCommitId - if true, a qualifier with SHA1 git commit will be used, default true

Returns:

itself to chain settings

setUseGitCommitTimestamp

public GitVersionCalculator setUseGitCommitTimestamp(boolean useGitCommitTimestamp)

Description copied from interface: GitVersionCalculator

When true, append the git commit timestamp to the version. This qualifier is not used if the SNAPSHOT qualifier is used.

Specified by:

setUseGitCommitTimestamp in interface GitVersionCalculator

Parameters:

useGitCommitTimestamp - if true, a qualifier with git commit timestamp will be used, default false

Returns:

itself to chain settings

setUseDefaultBranchingPolicy

public GitVersionCalculator setUseDefaultBranchingPolicy(boolean useDefaultBranchingPolicy)

Description copied from interface: GitVersionCalculator

When true, uses BranchingPolicy.DEFAULT_FALLBACK as last BranchingPolicy.

Specified by:

setUseDefaultBranchingPolicy in interface GitVersionCalculator

Parameters:

useDefaultBranchingPolicy - if true, appends BranchingPolicy.DEFAULT_FALLBACK as last branching policy

Returns:

itself to chain settings

setGitCommitIdLength

public GitVersionCalculator setGitCommitIdLength(int gitCommitIdLength)

Description copied from interface: GitVersionCalculator

Defines how long the qualifier from SHA1 git commit has to be.

Specified by:

setGitCommitIdLength in interface GitVersionCalculator

Parameters:

gitCommitIdLength - the length of the SHA1 substring to use as qualifier, valid values [8, 40], default 8

Returns:

itself to chain settings

setMavenLike

public GitVersionCalculator setMavenLike(boolean mavenLike)

Description copied from interface: GitVersionCalculator

Activates the maven like mode.

Specified by:

setMavenLike in interface GitVersionCalculator

Parameters:

mavenLike - true to activate maven like mode

Returns:

itself to chain settings

setFindTagVersionPattern

public GitVersionCalculator setFindTagVersionPattern(String pattern)

Description copied from interface: GitVersionCalculator

Defines a regexp search pattern that will match tags identifying a version. The provided regexp MUST contains at least one selector group that will represent the version extracted from the tag.

Specified by:

setFindTagVersionPattern in interface GitVersionCalculator

Parameters:

pattern - a non null string representing a java regexp pattern able to match tag containing versions

Returns:

itself to chain settings

meta

public Optional<String> meta(Metadatas meta)

Specified by:

meta in interface GitVersionCalculator

Specified by:

meta in interface MetadataProvider

setStrategy

public GitVersionCalculator setStrategy(Strategies s)

Description copied from interface: GitVersionCalculator

Defines the strategy to use.

Specified by:

setStrategy in interface GitVersionCalculator

Parameters:

s - the non null strategy to use as a Strategies enum value

Returns:

itself to chain settings

setTagVersionPattern

public GitVersionCalculator setTagVersionPattern(String pattern)

Description copied from interface: GitVersionCalculator

Defines the version pattern to use in Strategies.PATTERN mode when HEAD is on an annotated tag

Specified by:

setTagVersionPattern in interface GitVersionCalculator

Parameters:

pattern - the pattern to use for annotated tags

Returns:

itself to chain settings

setVersionPattern

public GitVersionCalculator setVersionPattern(String pattern)

Description copied from interface: GitVersionCalculator

Defines the version pattern to use in Strategies.PATTERN mode for normal situation (i.e. not on a tag)

Specified by:

setVersionPattern in interface GitVersionCalculator

Parameters:

pattern - the pattern to use

Returns:

itself to chain settings

setMaxDepth

public GitVersionCalculator setMaxDepth(int maxDepth)

Description copied from interface: GitVersionCalculator

Defines max depth to look for version tags, defaults to Integer.MAX_VALUE.

Specified by:

setMaxDepth in interface GitVersionCalculator

Parameters:

maxDepth - the maximum depth to reach to lookup for version tags

Returns:

itself to chain settings

setLookupPolicy

public GitVersionCalculator setLookupPolicy(LookupPolicy policy)

Description copied from interface: GitVersionCalculator

Defines the LookupPolicy to be used for the next version resolution.

Specified by:

setLookupPolicy in interface GitVersionCalculator

Parameters:

policy - the policy kind, cannot be null

Returns:

itself to chain settings

setUseSnapshot

public GitVersionCalculator setUseSnapshot(boolean useSnapshot)

Description copied from interface: GitVersionCalculator

When true, append a qualifier with the "SNAPSHOT" qualifier if no version tags found.

Specified by:

setUseSnapshot in interface GitVersionCalculator

Parameters:

useSnapshot - if true, a qualifier with "SNAPSHOT" qualifier if no version tags found.

Returns:

itself to chain settings

setForceComputation

public GitVersionCalculator setForceComputation(boolean forceComputation)

Description copied from interface: GitVersionCalculator

When true, force the computation of the version even if HEAD is on a version tag.

Specified by:

setForceComputation in interface GitVersionCalculator

Parameters:

forceComputation - if true, forces the computation of version using other defined parameters

Returns:

itself to chain settings

setScriptType

public GitVersionCalculator setScriptType(ScriptType scriptType)

Description copied from interface: GitVersionCalculator

Set the type of the script (default: ScriptType.GROOVY).

Specified by:

setScriptType in interface GitVersionCalculator

Parameters:

scriptType - the script type

Returns:

itself for chaining

setScript

public GitVersionCalculator setScript(String script)

Description copied from interface: GitVersionCalculator

Set the script to be interpreted.

Specified by:

setScript in interface GitVersionCalculator

Parameters:

script - the script content

Returns:

itself for chaining