Package hudson.plugins.jacoco

Class JacocoBuildAction

java.lang.Object

hudson.plugins.jacoco.model.CoverageObject<JacocoBuildAction>

hudson.plugins.jacoco.JacocoBuildAction

All Implemented Interfaces:

Action, HealthReportingAction, ModelObject, Serializable, RunAction2, SimpleBuildStep.LastBuildAction, org.kohsuke.stapler.StaplerProxy

public final class JacocoBuildAction
extends CoverageObject<JacocoBuildAction>
implements HealthReportingAction, org.kohsuke.stapler.StaplerProxy, Serializable, RunAction2, SimpleBuildStep.LastBuildAction

Build view extension by JaCoCo plugin. As CoverageObject, it retains the overall coverage report.

Author:

Kohsuke Kawaguchi, Jonathan Fuerth, Ognjen Bubalo

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
AbstractBuild<?,?>	build	Deprecated.

Fields inherited from class hudson.plugins.jacoco.model.CoverageObject

branch, clazz, complexity, instruction, line, maxBranch, maxClazz, maxComplexity, maxInstruction, maxLine, maxMethod, method

Constructor Summary

Constructors

Constructor	Description
JacocoBuildAction(Map<CoverageElement.Type,Coverage> ratios, JacocoHealthReportThresholds thresholds, TaskListener listener, String[] inclusions, String[] exclusions)

Method Summary

Modifier and Type	Method	Description
Run<?,?>	getBuild()	Gets the build object that owns the whole coverage report tree.
HealthReport	getBuildHealth()	Get the coverage HealthReport.
Map<Coverage,Boolean>	getCoverageRatios()
String	getDisplayName()
String	getIconFileName()
JacocoReportDir	getJacocoReport()
PrintStream	getLogger()
Run<?,?>	getOwner()
JacocoBuildAction	getPreviousResult()	Gets the corresponding coverage report object in the previous run that has the record.
Collection<? extends Action>	getProjectActions()
CoverageReport	getResult()	Obtains the detailed CoverageReport instance.
Object	getTarget()
JacocoHealthReportThresholds	getThresholds()
String	getUrlName()
static JacocoBuildAction	load(JacocoHealthReportThresholds thresholds, TaskListener listener, JacocoReportDir layout, String[] includes, String[] excludes)	Constructs the object from JaCoCo exec files.
void	onAttached(Run<?,?> run)
void	onLoad(Run<?,?> run)

Methods inherited from class hudson.plugins.jacoco.model.CoverageObject

doGraph, getApi, getBranchCoverage, getClassCoverage, getComplexityScore, getInstructionCoverage, getLineCoverage, getMaxBranch, getMaxClazz, getMaxComplexity, getMaxInstruction, getMaxLine, getMaxMethod, getMethodCoverage, getParent, hasClassCoverage, hasLineCoverage, isFailed, printFourCoverageColumns, printRatioCell, printRatioTable, setAllCovTypes, setCoverage, setFailed, setMaxBranch, setMaxClazz, setMaxComplexity, setMaxInstruction, setMaxLine, setMaxMethod, toString

Methods inherited from class java.lang.Object

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

Field Detail

build

@Deprecated
public transient AbstractBuild<?,?> build

Deprecated.

Constructor Detail

JacocoBuildAction

public JacocoBuildAction(Map<CoverageElement.Type,Coverage> ratios,
                         JacocoHealthReportThresholds thresholds,
                         TaskListener listener,
                         String[] inclusions,
                         String[] exclusions)

Parameters:

ratios - The available coverage ratios in the report. Null is treated the same as an empty map.

thresholds - The thresholds that applied when this build was built.

listener - The listener from which we get logger

inclusions - See JacocoReportDir.parse(String[], String...)

exclusions - See JacocoReportDir.parse(String[], String...)

Method Detail

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

getBuildHealth

public HealthReport getBuildHealth()

Get the coverage HealthReport.

Specified by:

getBuildHealth in interface HealthReportingAction

Returns:

The health report or null if health reporting is disabled.

Since:

1.7

getThresholds

public JacocoHealthReportThresholds getThresholds()

getTarget

public Object getTarget()

Specified by:

getTarget in interface org.kohsuke.stapler.StaplerProxy

getBuild

public Run<?,?> getBuild()

Description copied from class: CoverageObject

Gets the build object that owns the whole coverage report tree.

Specified by:

getBuild in class CoverageObject<JacocoBuildAction>

Returns:

the build object that owns the whole coverage report tree.

getJacocoReport

public JacocoReportDir getJacocoReport()

getResult

@Nullable
public CoverageReport getResult()

Obtains the detailed CoverageReport instance.

Returns:

the report, or null if these was a problem

getPreviousResult

public JacocoBuildAction getPreviousResult()

Description copied from class: CoverageObject

Gets the corresponding coverage report object in the previous run that has the record.

Specified by:

getPreviousResult in class CoverageObject<JacocoBuildAction>

Returns:

null if no earlier record was found.

getCoverageRatios

public Map<Coverage,Boolean> getCoverageRatios()

Returns:

A map which represents coverage objects and their status to show on build status page (summary.jelly).

load

public static JacocoBuildAction load(JacocoHealthReportThresholds thresholds,
                                     TaskListener listener,
                                     JacocoReportDir layout,
                                     String[] includes,
                                     String[] excludes)
                              throws IOException

Constructs the object from JaCoCo exec files.

Parameters:

thresholds - The thresholds that applied when this build was built.

listener - The listener from which we get logger

layout - The object parsing the saved "jacoco.exec" files

includes - See JacocoReportDir.parse(String[], String...)

excludes - See JacocoReportDir.parse(String[], String...)

Returns:

new JacocoBuildAction from JaCoCo exec files

Throws:

IOException - if failed to parse the file.

getLogger

public final PrintStream getLogger()

getOwner

public Run<?,?> getOwner()

onAttached

public void onAttached(Run<?,?> run)

Specified by:

onAttached in interface RunAction2

onLoad

public void onLoad(Run<?,?> run)

Specified by:

onLoad in interface RunAction2

getProjectActions

public Collection<? extends Action> getProjectActions()

Specified by:

getProjectActions in interface SimpleBuildStep.LastBuildAction