Class VersionEvaluatorProvider

java.lang.Object

org.jdrupes.gitversioning.core.VersionEvaluatorProvider

All Implemented Interfaces:

VersionEvaluator, VersionEvaluatorProvider

public class VersionEvaluatorProvider
extends Object
implements VersionEvaluatorProvider

Reference implementation of VersionEvaluatorProvider.

Finds the latest semantically versioned tag reachable from HEAD using the configured TagFilter, then delegates to the configured TagProcessor to produce the final version string.

Uses a ConcurrentHashMap to cache the set of commits reachable from HEAD, avoiding redundant graph walks.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Logger	log	Logger for this instance.

Constructor Summary

Constructors

Constructor	Description
VersionEvaluatorProvider()	Creates a new evaluator provider with default tag filter and processor.

Method Summary

Modifier and Type	Method	Description
Stream<Path>	dirtyFiles()	Returns a stream of "dirty" (uncommitted or untracked) files in the work tree that match the configured file selection.
VersionEvaluator	matchingAntPattern(String pattern)	Include all files matching the given Ant pattern when evaluating the version.
VersionEvaluator	matchingGlob(String glob)	Include all files matching the given glob expression when evaluating the version.
VersionEvaluator	matchingRegex(String regex)	Include all files matching the given regular expression when evaluating the version.
Stream<Path>	modifiedFiles()	Returns a stream of files modified since the latest version tag that match the configured file selection.
org.eclipse.jgit.lib.Repository	repository()	Returns the evaluator's repository.
VersionEvaluatorProvider	repository(org.eclipse.jgit.lib.Repository repository)	Sets the repository to use.
VersionEvaluator	subDirectory(Path subDirectory)	Include all files under the given sub-directory when 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()	Evaluates and returns the version string for the current repository state.

Methods inherited from class Object

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

Field Details

log

protected final Logger log

Logger for this instance.

Constructor Details

VersionEvaluatorProvider

public VersionEvaluatorProvider()

Creates a new evaluator provider with default tag filter and processor.

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 Git repository

Returns:

this provider for chaining

repository

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

Description copied from interface: VersionEvaluator

Returns the evaluator's repository.

Specified by:

repository in interface VersionEvaluator

Returns:

the repository

tagFilter

public VersionEvaluator tagFilter(TagFilter tagFilter)

Description copied from interface: VersionEvaluator

Sets the tag filter to use. The filter determines which tags are recognized as version tags and extracts the version string from them.

Specified by:

tagFilter in interface VersionEvaluator

Parameters:

tagFilter - the tag filter

Returns:

this evaluator for chaining

tagProcessor

public VersionEvaluator tagProcessor(TagProcessor tagProcessor)

Description copied from interface: VersionEvaluator

Sets the tag processor to use. The processor generates the final version string from the tag name and parsed version.

Specified by:

tagProcessor in interface VersionEvaluator

Parameters:

tagProcessor - the tag processor

Returns:

this evaluator for chaining

matchingGlob

public VersionEvaluator matchingGlob(String glob)

Description copied from interface: VersionEvaluator

Include all files matching the given glob expression when evaluating the version.

Specified by:

matchingGlob in interface VersionEvaluator

Parameters:

glob - the glob expression

Returns:

this evaluator for chaining

matchingRegex

public VersionEvaluator matchingRegex(String regex)

Description copied from interface: VersionEvaluator

Include all files matching the given regular expression when evaluating the version.

Specified by:

matchingRegex in interface VersionEvaluator

Parameters:

regex - the regular expression

Returns:

this evaluator for chaining

matchingAntPattern

public VersionEvaluator matchingAntPattern(String pattern)

Description copied from interface: VersionEvaluator

Include all files matching the given Ant pattern when evaluating the version.

Specified by:

matchingAntPattern in interface VersionEvaluator

Parameters:

pattern - the Ant pattern

Returns:

this evaluator for chaining

subDirectory

public VersionEvaluator subDirectory(Path subDirectory)

Description copied from interface: VersionEvaluator

Include all files under the given sub-directory when evaluating the version.

Specified by:

subDirectory in interface VersionEvaluator

Parameters:

subDirectory - the sub-directory, relative to the repository work tree or absolute

Returns:

this evaluator for chaining

dirtyFiles

public Stream<Path> dirtyFiles()

Description copied from interface: VersionEvaluator

Returns a stream of "dirty" (uncommitted or untracked) files in the work tree that match the configured file selection.

Specified by:

dirtyFiles in interface VersionEvaluator

Returns:

a stream of paths

modifiedFiles

public Stream<Path> modifiedFiles()

Description copied from interface: VersionEvaluator

Returns a stream of files modified since the latest version tag that match the configured file selection.

Specified by:

modifiedFiles in interface VersionEvaluator

Returns:

a stream of paths

version

public String version()

Description copied from interface: VersionEvaluator

Evaluates and returns the version string for the current repository state.

Specified by:

version in interface VersionEvaluator

Returns:

the version string