fr.brouillard.oss.jgitver.impl

Class MavenVersionStrategy

java.lang.Object

fr.brouillard.oss.jgitver.impl.VersionStrategy

fr.brouillard.oss.jgitver.impl.MavenVersionStrategy

public class MavenVersionStrategy
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
MavenVersionStrategy(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> parentsWithTags) Build a version using the given information extracted from the git repository.
void	setUseDirty(boolean useDirty)

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

MavenVersionStrategy

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

Method Detail

build

public Version build(Commit head,
                     List<Commit> parentsWithTags)
              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

parentsWithTags - 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

setUseDirty

public void setUseDirty(boolean useDirty)