hudson.plugins.tasks
Class TasksPublisher

java.lang.Object
  hudson.tasks.BuildStepCompatibilityLayer
      hudson.tasks.Publisher
          hudson.plugins.tasks.util.HealthAwarePublisher
              hudson.plugins.tasks.TasksPublisher

All Implemented Interfaces:

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

public class TasksPublisher
extends HealthAwarePublisher

Publishes the results of the task scanner (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 TasksDescriptor

TASK_SCANNER_DESCRIPTOR Descriptor of this publisher.

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

TasksPublisher(java.lang.String pattern, java.lang.String excludePattern, java.lang.String threshold, java.lang.String healthy, java.lang.String unHealthy, java.lang.String height, java.lang.String thresholdLimit, java.lang.String high, java.lang.String normal, java.lang.String low)
Creates a new instance of TasksPublisher.

Method Summary

hudson.model.Descriptor<hudson.tasks.Publisher>	getDescriptor()
java.lang.String	getExcludePattern() Returns the Ant file-set pattern of files to exclude from work.
java.lang.String	getHigh() Returns the high priority task identifiers.
java.lang.String	getLow() Returns the low priority task identifiers.
java.lang.String	getNormal() Returns the normal priority task identifiers.
java.lang.String	getPattern() Returns the Ant file-set pattern of files to work with.
hudson.model.Action	getProjectAction(hudson.model.AbstractProject<?,?> project)
TasksParserResult	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.tasks.util.HealthAwarePublisher

canContinue, createHealthReporter, getHealthy, getHealthyAnnotations, getHeight, getMinimumAnnotations, getPriorities, getThreshold, getThresholdLimit, getTrendHeight, getUnHealthy, getUnHealthyAnnotations, isAntBuild, isHealthyReportEnabled, isMavenBuild, 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

TASK_SCANNER_DESCRIPTOR

public static final TasksDescriptor TASK_SCANNER_DESCRIPTOR

Descriptor of this publisher.

Constructor Detail

TasksPublisher

@DataBoundConstructor
public TasksPublisher(java.lang.String pattern,
                                           java.lang.String excludePattern,
                                           java.lang.String threshold,
                                           java.lang.String healthy,
                                           java.lang.String unHealthy,
                                           java.lang.String height,
                                           java.lang.String thresholdLimit,
                                           java.lang.String high,
                                           java.lang.String normal,
                                           java.lang.String low)

Creates a new instance of TasksPublisher.

Parameters:

pattern - Ant file-set pattern of files to scan for open tasks in

excludePattern - Ant file-set pattern of files to exclude from scan

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

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

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

height - the height of the trend graph

thresholdLimit - determines which warning priorities should be considered when evaluating the build stability and health

high - tag identifiers indicating high priority

normal - tag identifiers indicating normal priority

low - tag identifiers indicating low priority

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

getExcludePattern

public java.lang.String getExcludePattern()

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

Returns:

Ant file-set pattern of files to exclude from work

getHigh

public java.lang.String getHigh()

Returns the high priority task identifiers.

Returns:

the high priority task identifiers

getNormal

public java.lang.String getNormal()

Returns the normal priority task identifiers.

Returns:

the normal priority task identifiers

getLow

public java.lang.String getLow()

Returns the low priority task identifiers.

Returns:

the low priority task identifiers

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 TasksParserResult 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()