Package io.jenkins.plugins.forensics.blame

Class BlamerFactory

java.lang.Object

io.jenkins.plugins.forensics.blame.BlamerFactory

All Implemented Interfaces:

ExtensionPoint

public abstract class BlamerFactory
extends Object
implements ExtensionPoint

Jenkins' extension point that allows plugins to create Blamer 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	Description
BlamerFactory()

Method Summary

Modifier and Type	Method	Description
abstract Optional<Blamer>	createBlamer(SCM scm, Run<?,?> run, FilePath workspace, TaskListener listener, edu.hm.hafner.util.FilteredLog logger)	Returns a blamer for the specified SCM.
static Blamer	findBlamer(Run<?,?> run, Collection<FilePath> scmDirectories, TaskListener listener, edu.hm.hafner.util.FilteredLog logger)	Returns a blamer for the specified build.
static Blamer	findBlamer(String scm, Run<?,?> run, FilePath workTree, TaskListener listener, edu.hm.hafner.util.FilteredLog logger)	Returns a blamer for the specified repository.

Methods inherited from class java.lang.Object

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

Constructor Details

BlamerFactory

public BlamerFactory()

Method Details

createBlamer

public abstract Optional<Blamer> createBlamer(SCM scm,
 Run<?,?> run,
 FilePath workspace,
 TaskListener listener,
 edu.hm.hafner.util.FilteredLog logger)

Returns a blamer for the specified SCM.

Parameters:

scm - the SCM to create the blamer 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 blamer instance that can blame authors for the specified SCM

findBlamer

public static Blamer findBlamer(Run<?,?> run,
 Collection<FilePath> scmDirectories,
 TaskListener listener,
 edu.hm.hafner.util.FilteredLog logger)

Returns a blamer for 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 blamer for the SCM of the specified build or a Blamer.NullBlamer if the SCM is not supported

findBlamer

public static Blamer findBlamer(String scm,
 Run<?,?> run,
 FilePath workTree,
 TaskListener listener,
 edu.hm.hafner.util.FilteredLog logger)

Returns a blamer for the specified repository.

Parameters:

scm - the key of the SCM repository (substring that must be part of the SCM key)

run - the current build

workTree - the working tree of the repository

listener - a task listener

logger - a logger to report error messages

Returns:

a blamer for the SCM of the specified build or a Blamer.NullBlamer if the SCM is not supported