Class VersionEvaluatorProvider

java.lang.Object

org.jdrupes.gitversioning.core.VersionEvaluatorProvider

All Implemented Interfaces:

VersionEvaluator, VersionEvaluatorProvider

public class VersionEvaluatorProvider
extends Object
implements VersionEvaluatorProvider

A simple version evaluator provider. It looks up the tags in the current branch, uses the tag filter to identify the version tags and selects the latest one. It then invokes the tag processor to produce a version string.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Logger	log	The logger.

Constructor Summary

Constructors

Constructor	Description
VersionEvaluatorProvider()	Initializes a new version evaluator provider.

Method Summary

Modifier and Type	Method	Description
VersionEvaluatorProvider	repository(org.eclipse.jgit.lib.Repository repository)	Sets the repository to use.
VersionEvaluator	subDirectory(Path subDirectory)	Sets the sub directory of the work tree that is relevant for evaluating the version.
VersionEvaluator	tagFilter(TagFilter tagFilter)	Sets the tag filter to use.
VersionEvaluator	tagProcessor(TagProcessor tagProcessor)	Sets the tag processor to use.
String	version()	Returns the evaluated version.

Methods inherited from class Object

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

Field Details

log

protected final Logger log

The logger.

Constructor Details

VersionEvaluatorProvider

public VersionEvaluatorProvider()

Initializes a new version evaluator provider.

Method Details

repository

public VersionEvaluatorProvider repository(org.eclipse.jgit.lib.Repository repository)

Description copied from interface: VersionEvaluatorProvider

Sets the repository to use.

Specified by:

repository in interface VersionEvaluatorProvider

Parameters:

repository - the repository

Returns:

the version evaluator provider

subDirectory

public VersionEvaluator subDirectory(Path subDirectory)

Description copied from interface: VersionEvaluator

Sets the sub directory of the work tree that is relevant for evaluating the version. Usually, only files in this directory are checked for changes, resulting in a "dirty" in the version.

Specified by:

subDirectory in interface VersionEvaluator

Parameters:

subDirectory - the sub directory

Returns:

the version evaluator

tagFilter

public VersionEvaluator tagFilter(TagFilter tagFilter)

Description copied from interface: VersionEvaluator

Sets the tag filter to use.

Specified by:

tagFilter in interface VersionEvaluator

Parameters:

tagFilter - the tag filter

Returns:

the version evaluator

tagProcessor

public VersionEvaluator tagProcessor(TagProcessor tagProcessor)

Description copied from interface: VersionEvaluator

Sets the tag processor to use.

Specified by:

tagProcessor in interface VersionEvaluator

Parameters:

tagProcessor - the tag processor

Returns:

the version evaluator

version

public String version()

Description copied from interface: VersionEvaluator

Returns the evaluated version.

Specified by:

version in interface VersionEvaluator

Returns:

the string