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 given collection of files.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
RepositoryMiner()

Method Summary

Modifier and Type	Method and Description
abstract RepositoryStatistics	mine(Collection<String> relativeFileNames) Obtains statistical information for the specified files.

Methods inherited from class java.lang.Object

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

Constructor Detail

RepositoryMiner

public RepositoryMiner()

Method Detail

mine

public abstract RepositoryStatistics mine(Collection<String> relativeFileNames)
                                   throws InterruptedException

Obtains statistical information for the specified files. If the collection of files is empty, then the statistics for the whole repository will be returned.

Parameters:

relativeFileNames - the files (relative file names with respect to the workspace root) to gather statistics for

Returns:

the statistics

Throws:

InterruptedException - if the user canceled the processing