hudson.plugins.checkstyle
Class CheckStylePublisher

java.lang.Object
  hudson.tasks.BuildStepCompatibilityLayer
      hudson.tasks.Publisher
          hudson.tasks.Recorder
              hudson.plugins.analysis.core.HealthAwarePublisher
                  hudson.plugins.checkstyle.CheckStylePublisher

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.matrix.MatrixAggregatable, hudson.model.Describable<hudson.tasks.Publisher>, hudson.plugins.analysis.core.HealthDescriptor, hudson.tasks.BuildStep, java.io.Serializable

public class CheckStylePublisher
extends hudson.plugins.analysis.core.HealthAwarePublisher

Publishes the results of the Checkstyle analysis (freestyle project type).

Author:

Ulli Hafner

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class hudson.tasks.Publisher

hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

CheckStylePublisher(java.lang.String healthy, java.lang.String unHealthy, java.lang.String thresholdLimit, java.lang.String defaultEncoding, boolean useDeltaValues, java.lang.String unstableTotalAll, java.lang.String unstableTotalHigh, java.lang.String unstableTotalNormal, java.lang.String unstableTotalLow, java.lang.String unstableNewAll, java.lang.String unstableNewHigh, java.lang.String unstableNewNormal, java.lang.String unstableNewLow, java.lang.String failedTotalAll, java.lang.String failedTotalHigh, java.lang.String failedTotalNormal, java.lang.String failedTotalLow, java.lang.String failedNewAll, java.lang.String failedNewHigh, java.lang.String failedNewNormal, java.lang.String failedNewLow, boolean canRunOnFailed, java.lang.String pattern)
Creates a new instance of CheckstylePublisher.

Method Summary

hudson.matrix.MatrixAggregator	createAggregator(hudson.matrix.MatrixBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener)
CheckStyleDescriptor	getDescriptor()
java.lang.String	getPattern() Returns the Ant file-set pattern of files to work with.
hudson.model.Action	getProjectAction(hudson.model.AbstractProject<?,?> project)
hudson.plugins.analysis.core.BuildResult	perform(hudson.model.AbstractBuild<?,?> build, hudson.plugins.analysis.util.PluginLogger logger)

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

canContinue, getCanRunOnFailed, getDefaultEncoding, getHealthy, getMinimumPriority, getRequiredMonitorService, getThresholdLimit, getThresholds, getUnHealthy, getUseDeltaValues, isAntBuild, isMavenBuild, perform, readResolve

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectActions, prebuild

Constructor Detail

CheckStylePublisher

@DataBoundConstructor
public CheckStylePublisher(java.lang.String healthy,
                                                java.lang.String unHealthy,
                                                java.lang.String thresholdLimit,
                                                java.lang.String defaultEncoding,
                                                boolean useDeltaValues,
                                                java.lang.String unstableTotalAll,
                                                java.lang.String unstableTotalHigh,
                                                java.lang.String unstableTotalNormal,
                                                java.lang.String unstableTotalLow,
                                                java.lang.String unstableNewAll,
                                                java.lang.String unstableNewHigh,
                                                java.lang.String unstableNewNormal,
                                                java.lang.String unstableNewLow,
                                                java.lang.String failedTotalAll,
                                                java.lang.String failedTotalHigh,
                                                java.lang.String failedTotalNormal,
                                                java.lang.String failedTotalLow,
                                                java.lang.String failedNewAll,
                                                java.lang.String failedNewHigh,
                                                java.lang.String failedNewNormal,
                                                java.lang.String failedNewLow,
                                                boolean canRunOnFailed,
                                                java.lang.String pattern)

Creates a new instance of CheckstylePublisher.

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

defaultEncoding - the default encoding to be used when reading and parsing files

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

pattern - Ant file-set pattern to scan for Checkstyle files

Method Detail

getPattern

public java.lang.String getPattern()

Returns the Ant file-set pattern of files to work with.

Returns:

Ant file-set pattern of files to work with

getProjectAction

public hudson.model.Action getProjectAction(hudson.model.AbstractProject<?,?> project)

Specified by:

getProjectAction in interface hudson.tasks.BuildStep

Overrides:

getProjectAction in class hudson.tasks.BuildStepCompatibilityLayer

perform

public hudson.plugins.analysis.core.BuildResult perform(hudson.model.AbstractBuild<?,?> build,
                                                        hudson.plugins.analysis.util.PluginLogger logger)
                                                 throws java.lang.InterruptedException,
                                                        java.io.IOException

Specified by:

perform in class hudson.plugins.analysis.core.HealthAwarePublisher

Throws:

java.lang.InterruptedException

java.io.IOException

getDescriptor

public CheckStyleDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Publisher>

Overrides:

getDescriptor in class hudson.tasks.Recorder

createAggregator

public hudson.matrix.MatrixAggregator createAggregator(hudson.matrix.MatrixBuild build,
                                                       hudson.Launcher launcher,
                                                       hudson.model.BuildListener listener)