io.jenkins.plugins.metrics.extension

Class MetricsProviderFactory<T extends hudson.model.Action>

java.lang.Object

io.jenkins.plugins.metrics.extension.MetricsProviderFactory<T>

Type Parameters:

T - the type of the action this class supports

All Implemented Interfaces:

hudson.ExtensionPoint

Direct Known Subclasses:

CoverageMetricsProviderFactory, PMDMetricsProviderFactory, WarningsMetricsProviderFactory

public abstract class MetricsProviderFactory<T extends hudson.model.Action>
extends Object
implements hudson.ExtensionPoint

Extension point to support custom metrics.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
MetricsProviderFactory()

Method Summary

Modifier and Type	Method and Description
static hudson.ExtensionList<MetricsProviderFactory>	all() Get all registered MetricsProviderFactorys.
static List<MetricsProvider>	getAllFor(List<? extends hudson.model.Action> actions) Get all MetricsProviders for this actions, using all registered MetricsProviderFactorys.
static ArrayList<MetricDefinition>	getAllSupportedMetricsFor(List<? extends hudson.model.Action> actions) Get all MetricsProviders for this actions, using all registered MetricsProviderFactorys.
abstract MetricsProvider	getFor(List<T> actions) Get all MetricsMeasurements for the actions of a build.
abstract ArrayList<MetricDefinition>	supportedMetricsFor(List<T> actions) Returns all metrics this MetricsProviderFactory reports, for a list of certain builds.
abstract Class<T>	type() Get the type of action this MetricsProviderFactory is for.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricsProviderFactory

public MetricsProviderFactory()

Method Detail

all

public static hudson.ExtensionList<MetricsProviderFactory> all()

Get all registered MetricsProviderFactorys.

Returns:

an ExtensionList containing all registered MetricsProviderFactorys

getAllFor

public static List<MetricsProvider> getAllFor(List<? extends hudson.model.Action> actions)

Get all MetricsProviders for this actions, using all registered MetricsProviderFactorys.

Parameters:

actions - the actions of a run to use for getting the metrics

Returns:

a list of MetricsProviders

getAllSupportedMetricsFor

public static ArrayList<MetricDefinition> getAllSupportedMetricsFor(List<? extends hudson.model.Action> actions)

Get all MetricsProviders for this actions, using all registered MetricsProviderFactorys.

Parameters:

actions - the actions of a run to use for getting the metrics

Returns:

a list of MetricsProviders, ordered by their priorities

type

public abstract Class<T> type()

Get the type of action this MetricsProviderFactory is for. (This is necessary to be able to provide the correct classes for the getFor(List) method.)

Returns:

the class of the action (same as the generic type)

getFor

public abstract MetricsProvider getFor(List<T> actions)

Get all MetricsMeasurements for the actions of a build. An implementing extension is supposed to filter the relevant actions from the list and calculate their metrics from them.

Parameters:

actions - the actions of a build

Returns:

the MetricsProvider providing the actions

supportedMetricsFor

public abstract ArrayList<MetricDefinition> supportedMetricsFor(List<T> actions)

Returns all metrics this MetricsProviderFactory reports, for a list of certain builds.

Parameters:

actions - the actions of a build

Returns:

a set containing all possibly reported metrics