fr.brouillard.oss.jgitver.impl

Class VersionStrategy

java.lang.Object

fr.brouillard.oss.jgitver.impl.VersionStrategy

Direct Known Subclasses:

ConfigurableVersionStrategy, MavenVersionStrategy

public abstract class VersionStrategy
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VersionStrategy.StrategySearchMode

Constructor Summary

Constructors

Constructor and Description
VersionStrategy(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
abstract Version	build(Commit head, List<Commit> parents) Build a version using the given information extracted from the git repository.
protected TagType	computeTagType(org.eclipse.jgit.lib.Ref tagToUse, org.eclipse.jgit.lib.Ref annotatedTag)
boolean	considerTagAsAVersionOne(org.eclipse.jgit.lib.Ref tag)
protected Version	enhanceVersionWithBranch(Version baseVersion, String branch)
protected org.eclipse.jgit.api.Git	getGit()
protected MetadataRegistrar	getRegistrar()
protected org.eclipse.jgit.lib.Repository	getRepository()
protected VersionNamingConfiguration	getVersionNamingConfiguration()
protected boolean	isBaseCommitOnHead(Commit head, Commit base)
int	searchDepthLimit() Defines the history commit depth, starting from HEAD, until which parent commits will be parsed to find tags information.
VersionStrategy.StrategySearchMode	searchMode()

Methods inherited from class java.lang.Object

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

Constructor Detail

VersionStrategy

public VersionStrategy(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

getRegistrar

protected MetadataRegistrar getRegistrar()

build

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

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

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

searchDepthLimit

public int searchDepthLimit()

Defines the history commit depth, starting from HEAD, until which parent commits will be parsed to find tags information. This parameter is informative and will be respected only if at least one commit with version information is found between HEAD and the defined depth. If none is found then the search will go deeper until it find one commit with version information or until it reaches the first commit. Valid only when the searchMode() is VersionStrategy.StrategySearchMode.DEPTH.

Returns:

a strict positive integer representing the depth until which the search will stop.

considerTagAsAVersionOne

public boolean considerTagAsAVersionOne(org.eclipse.jgit.lib.Ref tag)

searchMode

public VersionStrategy.StrategySearchMode searchMode()

computeTagType

protected TagType computeTagType(org.eclipse.jgit.lib.Ref tagToUse,
                                 org.eclipse.jgit.lib.Ref annotatedTag)

getVersionNamingConfiguration

protected VersionNamingConfiguration getVersionNamingConfiguration()

getRepository

protected org.eclipse.jgit.lib.Repository getRepository()

getGit

protected org.eclipse.jgit.api.Git getGit()

isBaseCommitOnHead

protected boolean isBaseCommitOnHead(Commit head,
                                     Commit base)

enhanceVersionWithBranch

protected Version enhanceVersionWithBranch(Version baseVersion,
                                           String branch)