fr.brouillard.oss.jgitver.impl

Class PatternVersionStrategy

java.lang.Object

fr.brouillard.oss.jgitver.impl.VersionStrategy<PatternVersionStrategy>

fr.brouillard.oss.jgitver.impl.PatternVersionStrategy

public class PatternVersionStrategy
extends VersionStrategy<PatternVersionStrategy>

Nested Class Summary

Nested classes/interfaces inherited from class fr.brouillard.oss.jgitver.impl.VersionStrategy

VersionStrategy.StrategySearchMode

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_TAG_VERSION_PATTERN
static String	DEFAULT_VERSION_PATTERN

Constructor Summary

Constructors

Constructor and Description
PatternVersionStrategy(VersionNamingConfiguration vnc, org.eclipse.jgit.lib.Repository repository, org.eclipse.jgit.api.Git git, MetadataRegistrar registrar) Default constructor.

Method Summary

Modifier and Type	Method and Description
Version	build(Commit head, List<Commit> parents) Build a version using the given information extracted from the git repository.
PatternVersionStrategy	setAutoIncrementPatch(boolean autoIncrementPatch) Set the parameter to increment automatically patch number for standard versions coming from annotated tag.
PatternVersionStrategy	setTagVersionPattern(String tagVersionPattern) Set the version pattern to use to compute the final version when HEAD is on a commit with an annotated tag.
PatternVersionStrategy	setVersionPattern(String versionPattern) Set the version pattern to use to compute the final version.

Methods inherited from class fr.brouillard.oss.jgitver.impl.VersionStrategy

computeTagType, enhanceVersionWithBranch, findMaxVersionCommit, findTagToUse, findVersionCommit, getBaseVersionAndRegisterMetadata, getGit, getRegistrar, getRepository, getVersionNamingConfiguration, isBaseCommitOnHead, isGitDirty, isVersionTag, maxVersionTag, maxVersionTag, runAndGetSelf, searchDepthLimit, searchMode, self, setSearchDepthLimit, tagToVersion, toVersionTarget, toVersionTarget, versionFromTag

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VERSION_PATTERN

public static final String DEFAULT_VERSION_PATTERN

See Also:

Constant Field Values

DEFAULT_TAG_VERSION_PATTERN

public static final String DEFAULT_TAG_VERSION_PATTERN

See Also:

Constant Field Values

Constructor Detail

PatternVersionStrategy

public PatternVersionStrategy(VersionNamingConfiguration vnc,
                              org.eclipse.jgit.lib.Repository repository,
                              org.eclipse.jgit.api.Git git,
                              MetadataRegistrar registrar)

Default constructor.

Parameters:

vnc - the configuration to use

repository - the git repository

git - a git helper object built from the repository

registrar - a storage for found/calculated metadata

Method Detail

build

public Version build(Commit head,
                     List<Commit> parents)
              throws VersionCalculationException

Description copied from class: VersionStrategy

Build a version using the given information extracted from the git repository.

Specified by:

build in class VersionStrategy<PatternVersionStrategy>

Parameters:

head - cannot be null the current head commit

parents - a non null list of commits that will be involved in version naming. The list cannot be null and contains the first commit of the repository if no commit with version tag can be found.

Returns:

a non null Version object

Throws:

VersionCalculationException - in case an error occurred while computing the version

setVersionPattern

public PatternVersionStrategy setVersionPattern(String versionPattern)

Set the version pattern to use to compute the final version.

Parameters:

versionPattern - a non null string describing the pattern

setTagVersionPattern

public PatternVersionStrategy setTagVersionPattern(String tagVersionPattern)

Set the version pattern to use to compute the final version when HEAD is on a commit with an annotated tag.

Parameters:

tagVersionPattern - a non null string describing the pattern

setAutoIncrementPatch

public PatternVersionStrategy setAutoIncrementPatch(boolean autoIncrementPatch)

Set the parameter to increment automatically patch number for standard versions coming from annotated tag.

Parameters:

autoIncrementPatch - true to increment the patch number, false otherwise

Returns:

itself for chaining