GitVersionCalculator (GIT versioning using jgit 0.10.2 API)

All Superinterfaces:

AutoCloseable, MetadataProvider

All Known Implementing Classes:

GitVersionCalculatorImpl
```
public interface GitVersionCalculator
extends AutoCloseable, MetadataProvider
```

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
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.
`static GitVersionCalculator`	`location(File gitRepositoryLocation)` Creates a `GitVersionCalculator` for the git repository pointing to the given path.
`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`	`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)` Deprecated. since 0.7.0, use `setStrategy(Strategies)` instead
`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`	`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`	`setVersionPattern(String pattern)` Defines the version pattern to use in `Strategies.PATTERN` mode for normal situation (i.e. not on a tag)

- Method Detail
  - location
```
static GitVersionCalculator location(File gitRepositoryLocation)
```
    Creates a GitVersionCalculator for the git repository pointing to the given path.
    
    Parameters:
    
    gitRepositoryLocation - the location of the git repository to find version for
    
    Returns:
    
    a non null GitVersionCalculator
  - getVersionObject
```
Version getVersionObject(boolean forceComputation)
```
    Calculates the version to use for the current git repository depending on the HEAD position.
    
    Parameters:
    
    forceComputation - true to discard any previous cached result, false allow to reuse already cached values
    
    Returns:
    
    the version object computed
  - getVersionObject
```
Version getVersionObject()
```
    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.
    
    Returns:
    
    the calculated version object
  - getVersion
```
String getVersion()
```
    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.
    
    Returns:
    
    a string representation of this version.
  - getVersion
```
String getVersion(boolean forceComputation)
```
    Calculates if necessary the version to use for the current git repository depending on the HEAD position.
    
    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
```
void close()
    throws Exception
```
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    Exception
  - setAutoIncrementPatch
```
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. 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.
    
    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
```
GitVersionCalculator setNonQualifierBranches(String nonQualifierBranches)
```
    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 setQualifierBranchingPolicies(List) & setQualifierBranchingPolicies(BranchingPolicy...).
    
    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
```
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. This method overrides the usage of setNonQualifierBranches(String) & setQualifierBranchingPolicies(List).
    
    Parameters:
    
    policies - an array of policies to apply can be empty
    
    Returns:
    
    itself to chain settings
  - setQualifierBranchingPolicies
```
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. This method overrides the usage of setNonQualifierBranches(String) & setQualifierBranchingPolicies(BranchingPolicy...).
    
    Parameters:
    
    policies - an array of policies to apply can be empty
    
    Returns:
    
    itself to chain settings
  - setUseDistance
```
GitVersionCalculator setUseDistance(boolean useDistance)
```
    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.
    
    Parameters:
    
    useDistance - if true, a qualifier with found distance will be used.
    
    Returns:
    
    itself to chain settings
  - setUseDirty
```
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)
    
    Parameters:
    
    useDirty - if true, a qualifier with "dirty" qualifier will be used if the repository is stall.
    
    Returns:
    
    itself to chain settings
  - setUseLongFormat
```
GitVersionCalculator setUseLongFormat(boolean useLongFormat)
```
    When true describes commits hash with long format pattern, ie preceded with the letter 'g'.
    
    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
```
GitVersionCalculator setUseGitCommitId(boolean useGitCommitId)
```
    When true, append the git commit id (SHA1) to the version. This qualifier is not used if the SNAPSHOT qualifier is used.
    
    Parameters:
    
    useGitCommitId - if true, a qualifier with SHA1 git commit will be used, default true
    
    Returns:
    
    itself to chain settings
  - setUseGitCommitTimestamp
```
GitVersionCalculator setUseGitCommitTimestamp(boolean useGitCommitTimestamp)
```
    When true, append the git commit timestamp to the version. This qualifier is not used if the SNAPSHOT qualifier is used.
    
    Parameters:
    
    useGitCommitTimestamp - if true, a qualifier with git commit timestamp will be used, default false
    
    Returns:
    
    itself to chain settings
  - setUseDefaultBranchingPolicy
```
GitVersionCalculator setUseDefaultBranchingPolicy(boolean useDefaultBranchingPolicy)
```
    When true, uses BranchingPolicy.DEFAULT_FALLBACK as last BranchingPolicy.
    
    Parameters:
    
    useDefaultBranchingPolicy - if true, appends BranchingPolicy.DEFAULT_FALLBACK as last branching policy
    
    Returns:
    
    itself to chain settings
  - setGitCommitIdLength
```
GitVersionCalculator setGitCommitIdLength(int gitCommitIdLength)
```
    Defines how long the qualifier from SHA1 git commit has to be.
    
    Parameters:
    
    gitCommitIdLength - the length of the SHA1 substring to use as qualifier, valid values [8, 40], default 8
    
    Returns:
    
    itself to chain settings
    
    Throws:
    
    IllegalArgumentException - in case the length is not in the range [8,40]
  - setMavenLike
```
GitVersionCalculator setMavenLike(boolean mavenLike)
```
    Deprecated. since 0.7.0, use setStrategy(Strategies) instead
    
    Activates the maven like mode.
    
    Parameters:
    
    mavenLike - true to activate maven like mode
    
    Returns:
    
    itself to chain settings
  - setFindTagVersionPattern
```
GitVersionCalculator setFindTagVersionPattern(String pattern)
```
    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.
    
    Parameters:
    
    pattern - a non null string representing a java regexp pattern able to match tag containing versions
    
    Returns:
    
    itself to chain settings
    
    Throws:
    
    PatternSyntaxException - if the given string cannot be parsed as a correct Pattern object
  - meta
```
Optional<String> meta(Metadatas meta)
```
    Specified by:
    
    meta in interface MetadataProvider
  - setStrategy
```
GitVersionCalculator setStrategy(Strategies s)
```
    Defines the strategy to use.
    
    Parameters:
    
    s - the non null strategy to use as a Strategies enum value
    
    Returns:
    
    itself to chain settings
    
    Since:
    
    0.7.0
  - setTagVersionPattern
```
GitVersionCalculator setTagVersionPattern(String pattern)
```
    Defines the version pattern to use in Strategies.PATTERN mode when HEAD is on an annotated tag
    
    Parameters:
    
    pattern - the pattern to use for annotated tags
    
    Returns:
    
    itself to chain settings
    
    Since:
    
    0.7.0
  - setVersionPattern
```
GitVersionCalculator setVersionPattern(String pattern)
```
    Defines the version pattern to use in Strategies.PATTERN mode for normal situation (i.e. not on a tag)
    
    Parameters:
    
    pattern - the pattern to use
    
    Returns:
    
    itself to chain settings
    
    Since:
    
    0.7.0
  - setMaxDepth
```
GitVersionCalculator setMaxDepth(int maxDepth)
```
    Defines max depth to look for version tags, defaults to Integer.MAX_VALUE.
    
    Parameters:
    
    maxDepth - the maximum depth to reach to lookup for version tags
    
    Returns:
    
    itself to chain settings
    
    Since:
    
    0.8.6
  - setLookupPolicy
```
GitVersionCalculator setLookupPolicy(LookupPolicy policy)
```
    Defines the LookupPolicy to be used for the next version resolution.
    
    Parameters:
    
    policy - the policy kind, cannot be null
    
    Returns:
    
    itself to chain settings
    
    Since:
    
    0.10.0

Interface GitVersionCalculator

Method Summary

Method Detail

location

getVersionObject

getVersionObject

getVersion

getVersion

close

setAutoIncrementPatch

setNonQualifierBranches

setQualifierBranchingPolicies

setQualifierBranchingPolicies

setUseDistance

setUseDirty

setUseLongFormat

setUseGitCommitId

setUseGitCommitTimestamp

setUseDefaultBranchingPolicy

setGitCommitIdLength

setMavenLike

setFindTagVersionPattern

meta

setStrategy

setTagVersionPattern

setVersionPattern

setMaxDepth

setLookupPolicy