fr.brouillard.oss.jgitver.impl

Class ConfigurableVersionStrategy

java.lang.Object

fr.brouillard.oss.jgitver.impl.VersionStrategy

fr.brouillard.oss.jgitver.impl.ConfigurableVersionStrategy

public class ConfigurableVersionStrategy
extends VersionStrategy

Nested Class Summary

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

VersionStrategy.StrategySearchMode

Constructor Summary

Constructors

Constructor and Description
ConfigurableVersionStrategy(VersionNamingConfiguration vnc, org.eclipse.jgit.lib.Repository repository, org.eclipse.jgit.api.Git git, MetadataRegistrar metadatas)

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.
ConfigurableVersionStrategy	setAutoIncrementPatch(boolean autoIncrementPatch)
ConfigurableVersionStrategy	setGitCommitIdLength(int gitCommitIdLength)
ConfigurableVersionStrategy	setUseCommitTimestamp(boolean useCommitTimestamp)
ConfigurableVersionStrategy	setUseDirty(boolean useDirty)
ConfigurableVersionStrategy	setUseDistance(boolean useDistance)
ConfigurableVersionStrategy	setUseGitCommitId(boolean useGitCommitId)
ConfigurableVersionStrategy	setUseLongFormat(boolean useLongFormat)

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

computeTagType, considerTagAsAVersionOne, enhanceVersionWithBranch, getGit, getRegistrar, getRepository, getVersionNamingConfiguration, isBaseCommitOnHead, searchDepthLimit, searchMode

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurableVersionStrategy

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

Method Detail

setAutoIncrementPatch

public ConfigurableVersionStrategy setAutoIncrementPatch(boolean autoIncrementPatch)

setUseDistance

public ConfigurableVersionStrategy setUseDistance(boolean useDistance)

setUseCommitTimestamp

public ConfigurableVersionStrategy setUseCommitTimestamp(boolean useCommitTimestamp)

setUseGitCommitId

public ConfigurableVersionStrategy setUseGitCommitId(boolean useGitCommitId)

setGitCommitIdLength

public ConfigurableVersionStrategy setGitCommitIdLength(int gitCommitIdLength)

setUseDirty

public ConfigurableVersionStrategy setUseDirty(boolean useDirty)

setUseLongFormat

public ConfigurableVersionStrategy setUseLongFormat(boolean useLongFormat)

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

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