hudson.plugins.warnings
Class WarningPublisher

java.lang.Object
  hudson.tasks.BuildStepCompatibilityLayer
      hudson.tasks.Publisher
          hudson.plugins.warnings.util.HealthAwarePublisher
              hudson.plugins.warnings.WarningPublisher

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Publisher>, hudson.tasks.BuildStep

public class WarningPublisher
extends HealthAwarePublisher

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

Author:

Ulli Hafner

Nested Class Summary

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

hudson.tasks.BuildStep.PublisherList

Field Summary

static WarningDescriptor

WARNINGS_DESCRIPTOR Descriptor of this publisher.

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

WarningPublisher(java.lang.String threshold, java.lang.String healthy, java.lang.String unHealthy, java.lang.String height)
Creates a new instance of WarningPublisher.

Method Summary

hudson.model.Descriptor<hudson.tasks.Publisher>	getDescriptor()
hudson.model.Action	getProjectAction(hudson.model.AbstractProject<?,?> project)
JavaProject	perform(hudson.model.AbstractBuild<?,?> build, java.io.PrintStream logger) Performs the publishing of the results of this plug-in.

Methods inherited from class hudson.plugins.warnings.util.HealthAwarePublisher

createHealthReporter, getHealthy, getHealthyAnnotations, getHeight, getMinimumAnnotations, getThreshold, getTrendHeight, getUnHealthy, getUnHealthyAnnotations, isHealthyReportEnabled, isThresholdEnabled, log, perform

Methods inherited from class hudson.tasks.Publisher

getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

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

prebuild

Field Detail

WARNINGS_DESCRIPTOR

public static final WarningDescriptor WARNINGS_DESCRIPTOR

Descriptor of this publisher.

Constructor Detail

WarningPublisher

@DataBoundConstructor
public WarningPublisher(java.lang.String threshold,
                                             java.lang.String healthy,
                                             java.lang.String unHealthy,
                                             java.lang.String height)

Creates a new instance of WarningPublisher.

Parameters:

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

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

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

height - the height of the trend graph

Method Detail

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 JavaProject perform(hudson.model.AbstractBuild<?,?> build,
                           java.io.PrintStream logger)
                    throws java.lang.InterruptedException,
                           java.io.IOException

Performs the publishing of the results of this plug-in.

Specified by:

perform in class HealthAwarePublisher

Parameters:

build - the build

logger - the logger to report the progress to

Returns:

the java project containing the found annotations

Throws:

java.lang.InterruptedException - If the build is interrupted by the user (in an attempt to abort the build.) Normally the BuildStep implementations may simply forward the exception it got from its lower-level functions.

java.io.IOException - If the implementation wants to abort the processing when an IOException happens, it can simply propagate the exception to the caller. This will cause the build to fail, with the default error message. Implementations are encouraged to catch IOException on its own to provide a better error message, if it can do so, so that users have better understanding on why it failed.

getDescriptor

public hudson.model.Descriptor<hudson.tasks.Publisher> getDescriptor()