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.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 pattern, java.lang.String threshold, java.lang.String newThreshold, java.lang.String failureThreshold, java.lang.String newFailureThreshold, java.lang.String healthy, java.lang.String unHealthy, java.lang.String thresholdLimit, java.lang.String defaultEncoding, boolean useDeltaValues, boolean canRunOnFailed)
Creates a new instance of CheckstylePublisher.

Method Summary

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, getFailureThreshold, getHealthy, getMinimumPriority, getNewFailureThreshold, getNewThreshold, getRequiredMonitorService, getThreshold, getThresholdLimit, 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 pattern,
                                                java.lang.String threshold,
                                                java.lang.String newThreshold,
                                                java.lang.String failureThreshold,
                                                java.lang.String newFailureThreshold,
                                                java.lang.String healthy,
                                                java.lang.String unHealthy,
                                                java.lang.String thresholdLimit,
                                                java.lang.String defaultEncoding,
                                                boolean useDeltaValues,
                                                boolean canRunOnFailed)

Creates a new instance of CheckstylePublisher.

Parameters:

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

threshold - Annotation threshold to be reached if a build should be considered as unstable.

newThreshold - New annotations threshold to be reached if a build should be considered as unstable.

failureThreshold - Annotation threshold to be reached if a build should be considered as failure.

newFailureThreshold - New annotations threshold to be reached if a build should be considered as failure.

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

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

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