fr.brouillard.oss.jgitver.impl

Interface DistanceCalculator

All Known Implementing Classes:

DistanceCalculator.DepthWalkDistanceCalculator

public interface DistanceCalculator

Allow to compute git depth, in term of commit distance between several commits.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DistanceCalculator.DepthWalkDistanceCalculator

Method Summary

Modifier and Type	Method and Description
static DistanceCalculator	create(org.eclipse.jgit.lib.ObjectId start, org.eclipse.jgit.lib.Repository repository) Creates a reusable DistanceCalculator on the given repository for the given start commit, uses Integer.MAX_VALUE as the maximum depth distance.
static DistanceCalculator	create(org.eclipse.jgit.lib.ObjectId start, org.eclipse.jgit.lib.Repository repository, int maxDepth) Creates a reusable DistanceCalculator on the given repository for the given start commit.
Optional<Integer>	distanceTo(org.eclipse.jgit.lib.ObjectId target) Computes an eventual distance between the start commit given at build time and the provided target commit.

Method Detail

create

static DistanceCalculator create(org.eclipse.jgit.lib.ObjectId start,
                                 org.eclipse.jgit.lib.Repository repository,
                                 int maxDepth)

Creates a reusable DistanceCalculator on the given repository for the given start commit.

Parameters:

start - the commit where the computation will start

repository - the repository on which to operate

maxDepth - the maximum depth to which we accept to look at. If <= 0 then Integer.MAX_VALUE will be used.

Returns:

a reusable DistanceCalculator object

create

static DistanceCalculator create(org.eclipse.jgit.lib.ObjectId start,
                                 org.eclipse.jgit.lib.Repository repository)

Creates a reusable DistanceCalculator on the given repository for the given start commit, uses Integer.MAX_VALUE as the maximum depth distance.

See Also:

create(ObjectId, Repository, int)

distanceTo

Optional<Integer> distanceTo(org.eclipse.jgit.lib.ObjectId target)

Computes an eventual distance between the start commit given at build time and the provided target commit. Returns the computed distance inside an Optional which can be empty if the given target is not reachable or is too far regarding the given distance.

Parameters:

target - the commit to compute distance for

Returns:

a distance as an Optional