hudson.plugins.findbugs

Class FindBugsReporter

java.lang.Object

hudson.maven.MavenReporter

hudson.plugins.analysis.core.HealthAwareReporter<FindBugsResult>

hudson.plugins.findbugs.FindBugsReporter

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.maven.MavenProjectActionBuilder, hudson.model.Describable<hudson.maven.MavenReporter>, hudson.plugins.analysis.core.HealthDescriptor, Serializable

public class FindBugsReporter
extends hudson.plugins.analysis.core.HealthAwareReporter<FindBugsResult>

Publishes the results of the FindBugs analysis (maven 2 project type).

Author:

Ulli Hafner

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description

FindBugsReporter(String healthy, String unHealthy, String thresholdLimit, boolean useDeltaValues, String unstableTotalAll, String unstableTotalHigh, String unstableTotalNormal, String unstableTotalLow, String unstableNewAll, String unstableNewHigh, String unstableNewNormal, String unstableNewLow, String failedTotalAll, String failedTotalHigh, String failedTotalNormal, String failedTotalLow, String failedNewAll, String failedNewHigh, String failedNewNormal, String failedNewLow, boolean canRunOnFailed, boolean usePreviousBuildAsReference, boolean useStableBuildAsReference, boolean isRankActivated, boolean canComputeNew, String excludePattern, String includePattern) Creates a new instance of FindBugsReporter.

Method Summary

Modifier and Type	Method and Description
protected boolean	acceptGoal(String goal)
protected hudson.maven.MavenAggregatedReport	createMavenAggregatedReport(hudson.maven.MavenBuild build, FindBugsResult result)
protected FindBugsResult	createResult(hudson.maven.MavenBuild build, hudson.plugins.analysis.core.ParserResult project)
String	getExcludePattern() RegEx patterns of files to exclude from the report.
String	getIncludePattern() Returns the RegEx patterns to include in the report.
List<FindBugsProjectAction>	getProjectActions(hudson.maven.MavenModule module)
protected Class<FindBugsMavenResultAction>	getResultActionClass()
boolean	isRankActivated() Returns whether to use the rank when evaluation the priority.
hudson.plugins.analysis.core.ParserResult	perform(hudson.maven.MavenBuildProxy build, org.apache.maven.project.MavenProject pom, hudson.maven.MojoInfo mojo, hudson.plugins.analysis.util.PluginLogger logger)
boolean	preExecute(hudson.maven.MavenBuildProxy build, org.apache.maven.project.MavenProject pom, hudson.maven.MojoInfo mojo, hudson.model.BuildListener listener)

Methods inherited from class hudson.plugins.analysis.core.HealthAwareReporter

canComputeNew, canContinue, end, getCanComputeNew, getCanRunOnFailed, getDefaultEncoding, getDescriptor, getHealthy, getMinimumPriority, getModuleName, getTargetPath, getThresholdLimit, getThresholds, getUnHealthy, getUseDeltaValues, getUsePreviousBuildAsReference, getUsePreviousBuildAsStable, getUseStableBuildAsReference, postExecute, useOnlyStableBuildsAsReference, usePreviousBuildAsReference, usePreviousBuildAsStable

Methods inherited from class hudson.maven.MavenReporter

enterModule, getAggregatedProjectAction, getProjectAction, leaveModule, postBuild, preBuild, reportGenerated

Methods inherited from class java.lang.Object

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

Constructor Detail

FindBugsReporter

@DataBoundConstructor
public FindBugsReporter(String healthy,
                                              String unHealthy,
                                              String thresholdLimit,
                                              boolean useDeltaValues,
                                              String unstableTotalAll,
                                              String unstableTotalHigh,
                                              String unstableTotalNormal,
                                              String unstableTotalLow,
                                              String unstableNewAll,
                                              String unstableNewHigh,
                                              String unstableNewNormal,
                                              String unstableNewLow,
                                              String failedTotalAll,
                                              String failedTotalHigh,
                                              String failedTotalNormal,
                                              String failedTotalLow,
                                              String failedNewAll,
                                              String failedNewHigh,
                                              String failedNewNormal,
                                              String failedNewLow,
                                              boolean canRunOnFailed,
                                              boolean usePreviousBuildAsReference,
                                              boolean useStableBuildAsReference,
                                              boolean isRankActivated,
                                              boolean canComputeNew,
                                              String excludePattern,
                                              String includePattern)

Creates a new instance of FindBugsReporter.

Parameters:

healthy - Report health as 100% when the number of warnings is less than this value

unHealthy - Report health as 0% when the number of warnings is greater than this value

thresholdLimit - determines which warning priorities should be considered when evaluating the build stability and health

useDeltaValues - determines whether the absolute annotations delta or the actual annotations set difference should be used to evaluate the build stability

unstableTotalAll - annotation threshold

unstableTotalHigh - annotation threshold

unstableTotalNormal - annotation threshold

unstableTotalLow - annotation threshold

unstableNewAll - annotation threshold

unstableNewHigh - annotation threshold

unstableNewNormal - annotation threshold

unstableNewLow - annotation threshold

failedTotalAll - annotation threshold

failedTotalHigh - annotation threshold

failedTotalNormal - annotation threshold

failedTotalLow - annotation threshold

failedNewAll - annotation threshold

failedNewHigh - annotation threshold

failedNewNormal - annotation threshold

failedNewLow - annotation threshold

canRunOnFailed - determines whether the plug-in can run for failed builds, too

usePreviousBuildAsReference - determines whether to always use the previous build as the reference build

useStableBuildAsReference - determines whether only stable builds should be used as reference builds or not

isRankActivated - determines whether to use the rank when evaluation the priority

canComputeNew - determines whether new warnings should be computed (with respect to baseline)

excludePattern - RegEx patterns of files to exclude from the report

includePattern - RegEx patterns of files to include in the report

Method Detail

isRankActivated

public boolean isRankActivated()

Returns whether to use the rank when evaluation the priority.

Returns:

true if the rank should uses when evaluation the priority, false if the FindBugs priority should be used

getExcludePattern

public String getExcludePattern()

RegEx patterns of files to exclude from the report.

Returns:

String of concatenated exclude patterns separated by a comma

getIncludePattern

public String getIncludePattern()

Returns the RegEx patterns to include in the report.

Returns:

String of concatenated include patterns separated by a comma

preExecute

public boolean preExecute(hudson.maven.MavenBuildProxy build,
                          org.apache.maven.project.MavenProject pom,
                          hudson.maven.MojoInfo mojo,
                          hudson.model.BuildListener listener)
                   throws InterruptedException,
                          IOException

Overrides:

preExecute in class hudson.maven.MavenReporter

Throws:

InterruptedException

IOException

acceptGoal

protected boolean acceptGoal(String goal)

Specified by:

acceptGoal in class hudson.plugins.analysis.core.HealthAwareReporter<FindBugsResult>

perform

public hudson.plugins.analysis.core.ParserResult perform(hudson.maven.MavenBuildProxy build,
                                                         org.apache.maven.project.MavenProject pom,
                                                         hudson.maven.MojoInfo mojo,
                                                         hudson.plugins.analysis.util.PluginLogger logger)
                                                  throws InterruptedException,
                                                         IOException

Specified by:

perform in class hudson.plugins.analysis.core.HealthAwareReporter<FindBugsResult>

Throws:

InterruptedException

IOException

createResult

protected FindBugsResult createResult(hudson.maven.MavenBuild build,
                                      hudson.plugins.analysis.core.ParserResult project)

Specified by:

createResult in class hudson.plugins.analysis.core.HealthAwareReporter<FindBugsResult>

createMavenAggregatedReport

protected hudson.maven.MavenAggregatedReport createMavenAggregatedReport(hudson.maven.MavenBuild build,
                                                                         FindBugsResult result)

Specified by:

createMavenAggregatedReport in class hudson.plugins.analysis.core.HealthAwareReporter<FindBugsResult>

getProjectActions

public List<FindBugsProjectAction> getProjectActions(hudson.maven.MavenModule module)

Specified by:

getProjectActions in interface hudson.maven.MavenProjectActionBuilder

Overrides:

getProjectActions in class hudson.maven.MavenReporter

getResultActionClass

protected Class<FindBugsMavenResultAction> getResultActionClass()

Specified by:

getResultActionClass in class hudson.plugins.analysis.core.HealthAwareReporter<FindBugsResult>