io.jenkins.plugins.metrics.extension

Class PMDMetricsProviderFactory

java.lang.Object

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

io.jenkins.plugins.metrics.extension.PMDMetricsProviderFactory

All Implemented Interfaces:

hudson.ExtensionPoint

@Extension
public class PMDMetricsProviderFactory
extends MetricsProviderFactory<MetricsAction>

MetricsProviderFactory for PMD metrics.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
PMDMetricsProviderFactory()

Method Summary

Modifier and Type	Method and Description
MetricsProvider	getFor(List<MetricsAction> actions) Get all MetricsMeasurements for the actions of a build.
static ArrayList<MetricDefinition>	getSupportedMetrics() Return all metrics supported by the metrics-aggregation plugin, i.e. by PMD.
ArrayList<MetricDefinition>	supportedMetricsFor(List<MetricsAction> actions) Returns all metrics this MetricsProviderFactory reports, for a list of certain builds.
Class<MetricsAction>	type() Get the type of action this MetricsProviderFactory is for.

Methods inherited from class io.jenkins.plugins.metrics.extension.MetricsProviderFactory

all, getAllFor, getAllSupportedMetricsFor

Methods inherited from class java.lang.Object

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

Constructor Detail

PMDMetricsProviderFactory

public PMDMetricsProviderFactory()

Method Detail

type

public Class<MetricsAction> type()

Description copied from class: MetricsProviderFactory

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.)

Specified by:

type in class MetricsProviderFactory<MetricsAction>

Returns:

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

getFor

public MetricsProvider getFor(List<MetricsAction> actions)

Description copied from class: MetricsProviderFactory

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.

Specified by:

getFor in class MetricsProviderFactory<MetricsAction>

Parameters:

actions - the actions of a build

Returns:

the MetricsProvider providing the actions

supportedMetricsFor

public ArrayList<MetricDefinition> supportedMetricsFor(List<MetricsAction> actions)

Description copied from class: MetricsProviderFactory

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

Specified by:

supportedMetricsFor in class MetricsProviderFactory<MetricsAction>

Parameters:

actions - the actions of a build

Returns:

a set containing all possibly reported metrics

getSupportedMetrics

public static ArrayList<MetricDefinition> getSupportedMetrics()

Return all metrics supported by the metrics-aggregation plugin, i.e. by PMD.

Returns:

a list of supported MetricDefinitions