Package com.splunk.splunkjenkins.model

Class CoverageMetricsAdapter<M extends HealthReportingAction>

java.lang.Object

com.splunk.splunkjenkins.model.CoverageMetricsAdapter<M>

Type Parameters:

M - Coverage Action

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

CloverCoverageMetrics, CoberturaCoverageMetrics, JacocoCoverageMetrics

public abstract class CoverageMetricsAdapter<M extends HealthReportingAction>
extends Object
implements ExtensionPoint

Extracts Coverage metric

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CoverageMetricsAdapter.CoverageDetail
static enum	CoverageMetricsAdapter.CoverageLevel	used to trace which level coverage generated
static enum	CoverageMetricsAdapter.Metric

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
final Class<M>	targetType

Constructor Summary

Constructors

Constructor	Description
CoverageMetricsAdapter()

Method Summary

Modifier and Type	Method	Description
M	getAction(Run run)
static Map<CoverageMetricsAdapter.Metric,Integer>	getMetrics(Run build)
abstract Map<CoverageMetricsAdapter.Metric,Integer>	getMetrics(M coverageAction)
static List<List<CoverageMetricsAdapter.CoverageDetail>>	getReport(Run build, int pageSize)
abstract List<CoverageMetricsAdapter.CoverageDetail>	getReport(M coverageAction)
boolean	isApplicable(Run build)

Methods inherited from class java.lang.Object

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

Field Details

targetType

public final Class<M extends HealthReportingAction> targetType

Constructor Details

CoverageMetricsAdapter

public CoverageMetricsAdapter()

Method Details

getAction

public M getAction(Run run)

isApplicable

public boolean isApplicable(Run build)

getMetrics

@NonNull
public static Map<CoverageMetricsAdapter.Metric,Integer> getMetrics(Run build)

getMetrics

public abstract Map<CoverageMetricsAdapter.Metric,Integer> getMetrics(M coverageAction)

Parameters:

coverageAction - coverage action

Returns:

coverage metrics, key is metric, value is percentage

getReport

public abstract List<CoverageMetricsAdapter.CoverageDetail> getReport(M coverageAction)

Parameters:

coverageAction - coverage action

Returns:

coverage report, key is filename, value is percentage

getReport

public static List<List<CoverageMetricsAdapter.CoverageDetail>> getReport(Run build,
 int pageSize)

Parameters:

build - Jenkins build

pageSize - page size, 0 will disable pagination

Returns:

coverage report with no more than pageSize