hudson.plugins.checkstyle
Class CheckStyleReporter

java.lang.Object
  hudson.maven.MavenReporter
      hudson.plugins.analysis.core.HealthAwareReporter<CheckStyleResult>
          hudson.plugins.checkstyle.CheckStyleReporter

All Implemented Interfaces:

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

public class CheckStyleReporter
extends hudson.plugins.analysis.core.HealthAwareReporter<CheckStyleResult>

Publishes the results of the Checkstyle 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

CheckStyleReporter(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 canComputeNew)
Creates a new instance of CheckStyleReporter.

Method Summary

protected boolean	acceptGoal(String goal)
protected hudson.maven.MavenAggregatedReport	createMavenAggregatedReport(hudson.maven.MavenBuild build, CheckStyleResult result)
protected CheckStyleResult	createResult(hudson.maven.MavenBuild build, hudson.plugins.analysis.core.ParserResult project)
List<CheckStyleProjectAction>	getProjectActions(hudson.maven.MavenModule module)
protected Class<CheckStyleMavenResultAction>	getResultActionClass()
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)

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

canComputeNew, canContinue, end, getCanComputeNew, getCanRunOnFailed, getDefaultEncoding, getDescriptor, getHealthy, getMinimumPriority, getModuleName, getTargetPath, getThresholdLimit, getThresholds, getUnHealthy, getUseDeltaValues, postExecute

Methods inherited from class hudson.maven.MavenReporter

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckStyleReporter

@DataBoundConstructor
public CheckStyleReporter(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 canComputeNew)

Creates a new instance of CheckStyleReporter.

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

Method Detail

acceptGoal

protected boolean acceptGoal(String goal)

Specified by:

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

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<CheckStyleResult>

Throws:

InterruptedException

IOException

createResult

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

Specified by:

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

createMavenAggregatedReport

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

Specified by:

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

getProjectActions

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

Specified by:

getProjectActions in interface hudson.maven.MavenProjectActionBuilder

Overrides:

getProjectActions in class hudson.maven.MavenReporter

getResultActionClass

protected Class<CheckStyleMavenResultAction> getResultActionClass()

Specified by:

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