Package io.jenkins.plugins.forensics.miner

Class RepositoryMiner

java.lang.Object

io.jenkins.plugins.forensics.miner.RepositoryMiner

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

RepositoryMiner.NullMiner

public abstract class RepositoryMiner
extends Object
implements Serializable

Obtains commit statistics for a source code repository. Computation of the commit statistics should be done incrementally, if supported by the underlying SCM (i.e., only commits new in the current build should be inspected).

Author:

Ullrich Hafner

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RepositoryMiner.NullMiner	A repository miner that does nothing.

Constructor Summary

Constructors

Constructor	Description
RepositoryMiner()

Method Summary

Modifier and Type	Method	Description
abstract RepositoryStatistics	mine(RepositoryStatistics previousStatistics, edu.hm.hafner.util.FilteredLog logger)	Obtains commit statistics for a source code repository.

Methods inherited from class java.lang.Object

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

Constructor Details

RepositoryMiner

public RepositoryMiner()

Method Details

mine

public abstract RepositoryStatistics mine(RepositoryStatistics previousStatistics,
 edu.hm.hafner.util.FilteredLog logger)
                                   throws InterruptedException

Obtains commit statistics for a source code repository.

Parameters:

previousStatistics - the repository statistics of the previous build - if there is no such build then an empty instance will be provided

logger - the logger to use

Returns:

the aggregated statistics containing the commit statistics for the current build and the previous builds

Throws:

InterruptedException - if the user canceled the processing