io.jenkins.plugins.forensics.miner

Class MinerFactory

java.lang.Object

io.jenkins.plugins.forensics.miner.MinerFactory

All Implemented Interfaces:

ExtensionPoint

public abstract class MinerFactory
extends Object
implements ExtensionPoint

Jenkins extension point that allows plugins to create RepositoryMiner instances based on a supported SCM.

Author:

Ullrich Hafner

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
MinerFactory()

Method Summary

Modifier and Type	Method and Description
abstract Optional<RepositoryMiner>	createMiner(SCM scm, Run<?,?> run, FilePath workspace, TaskListener listener, FilteredLog logger) Returns a repository miner for the specified SCM.
static RepositoryMiner	findMiner(Run<?,?> run, Collection<FilePath> scmDirectories, TaskListener listener, FilteredLog logger) Returns a miner for the repository of the specified build.

Methods inherited from class java.lang.Object

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

Constructor Detail

MinerFactory

public MinerFactory()

Method Detail

createMiner

public abstract Optional<RepositoryMiner> createMiner(SCM scm,
                                                      Run<?,?> run,
                                                      FilePath workspace,
                                                      TaskListener listener,
                                                      FilteredLog logger)

Returns a repository miner for the specified SCM.

Parameters:

scm - the SCM to create the miner for

run - the current build

workspace - the workspace of the current build

listener - a task listener

logger - a logger to report error messages

Returns:

a repository miner instance that creates statistics for all available files in the specified SCM

findMiner

public static RepositoryMiner findMiner(Run<?,?> run,
                                        Collection<FilePath> scmDirectories,
                                        TaskListener listener,
                                        FilteredLog logger)

Returns a miner for the repository of the specified build.

Parameters:

run - the current build

scmDirectories - paths to search for the SCM repository

listener - a task listener

logger - a logger to report error messages

Returns:

a miner for the SCM of the specified build or a RepositoryMiner.NullMiner if the SCM is not supported