hudson.plugins.analysis.collector

Class AnalysisPublisher

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

hudson.plugins.analysis.core.HealthAwareRecorder

hudson.plugins.analysis.core.HealthAwarePublisher

hudson.plugins.analysis.collector.AnalysisPublisher

All Implemented Interfaces:

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

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

Collects the results of the various analysis plug-ins.

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

Constructors

Constructor and Description

AnalysisPublisher(String healthy, String unHealthy, String thresholdLimit, String defaultEncoding, 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 isCheckStyleActivated, boolean isDryActivated, boolean isFindBugsActivated, boolean isPmdActivated, boolean isOpenTasksActivated, boolean isWarningsActivated, boolean canRunOnFailed, boolean useStableBuildAsReference, boolean canComputeNew) Creates a new instance of AnalysisPublisher.

Method Summary

Methods

Modifier and Type	Method and Description
hudson.matrix.MatrixAggregator	createAggregator(hudson.matrix.MatrixBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener)
AnalysisDescriptor	getDescriptor()
hudson.model.Action	getProjectAction(hudson.model.AbstractProject<?,?> project)
boolean	isCheckStyleActivated() Returns whether CheckStyle results should be collected.
boolean	isDryActivated() Returns whether DRY results should be collected.
boolean	isFindBugsActivated() Returns whether FindBugs results should be collected.
boolean	isOpenTasksActivated() Returns whether open tasks should be collected.
boolean	isPmdActivated() Returns whether PMD results should be collected.
boolean	isWarningsActivated() Returns whether compiler warnings results should be collected.
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

perform, updateBuildResult

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

canComputeNew, canContinue, canResolveRelativePaths, copyFilesWithAnnotationsToBuildFolder, getCanComputeNew, getCanResolveRelativePaths, getCanRunOnFailed, getDefaultEncoding, getHealthy, getMinimumPriority, getRequiredMonitorService, getShouldDetectModules, getThresholdLimit, getThresholds, getUnHealthy, getUseDeltaValues, getUseStableBuildAsReference, isAntBuild, isMavenBuild, isThresholdEnabled, perform, readResolve, shouldDetectModules, useOnlyStableBuildsAsReference

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

AnalysisPublisher

@DataBoundConstructor
public AnalysisPublisher(String healthy,
                                      String unHealthy,
                                      String thresholdLimit,
                                      String defaultEncoding,
                                      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 isCheckStyleActivated,
                                      boolean isDryActivated,
                                      boolean isFindBugsActivated,
                                      boolean isPmdActivated,
                                      boolean isOpenTasksActivated,
                                      boolean isWarningsActivated,
                                      boolean canRunOnFailed,
                                      boolean useStableBuildAsReference,
                                      boolean canComputeNew)

Creates a new instance of AnalysisPublisher.

Parameters:

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

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

isCheckStyleActivated - determines whether to collect the warnings from Checkstyle

isDryActivated - determines whether to collect the warnings from DRY

isFindBugsActivated - determines whether to collect the warnings from FindBugs

isPmdActivated - determines whether to collect the warnings from PMD

isOpenTasksActivated - determines whether to collect open tasks

isWarningsActivated - determines whether to collect compiler warnings

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

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

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

Method Detail

isCheckStyleActivated

public boolean isCheckStyleActivated()

Returns whether CheckStyle results should be collected.

Returns:

true if CheckStyle results should be collected, false otherwise

isDryActivated

public boolean isDryActivated()

Returns whether DRY results should be collected.

Returns:

true if DRY results should be collected, false otherwise

isFindBugsActivated

public boolean isFindBugsActivated()

Returns whether FindBugs results should be collected.

Returns:

true if FindBugs results should be collected, false otherwise

isPmdActivated

public boolean isPmdActivated()

Returns whether PMD results should be collected.

Returns:

true if PMD results should be collected, false otherwise

isOpenTasksActivated

public boolean isOpenTasksActivated()

Returns whether open tasks should be collected.

Returns:

true if open tasks should be collected, false otherwise

isWarningsActivated

public boolean isWarningsActivated()

Returns whether compiler warnings results should be collected.

Returns:

true if compiler warnings results should be collected, false otherwise

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 InterruptedException,
                                                        IOException

Specified by:

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

Throws:

InterruptedException

IOException

getDescriptor

public AnalysisDescriptor getDescriptor()

Specified by:

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

Overrides:

getDescriptor in class hudson.plugins.analysis.core.HealthAwareRecorder

createAggregator

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