Package hudson.plugins.descriptionsetter

Class DescriptionSetterHelper

java.lang.Object

hudson.plugins.descriptionsetter.DescriptionSetterHelper

public class DescriptionSetterHelper
extends Object

Helper class that performs common functionality used by both DescriptionSetterBuilder and DescriptionSetterPublisher.

Constructor Summary

Constructors

Constructor	Description
DescriptionSetterHelper()

Method Summary

Modifier and Type	Method	Description
static boolean	setDescription(AbstractBuild<?,?> build, BuildListener listener, String regexp, String description)	Sets the description on the given build based on the specified regular expression and description.
static boolean	setDescription(AbstractBuild<?,?> build, BuildListener listener, String regexp, String description, boolean appendMode)	Sets the description on the given build based on the specified regular expression and description.

Methods inherited from class java.lang.Object

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

Constructor Detail

DescriptionSetterHelper

public DescriptionSetterHelper()

Method Detail

setDescription

public static boolean setDescription(AbstractBuild<?,?> build,
                                     BuildListener listener,
                                     String regexp,
                                     String description)
                              throws InterruptedException

Sets the description on the given build based on the specified regular expression and description.

Parameters:

build - the build whose description to set.

listener - the build listener to report events to.

regexp - the regular expression to apply to the build log.

description - the description to set.

Returns:

true, regardless of if the regular expression matched and a description could be set or not.

Throws:

InterruptedException - if the build is interrupted by the user.

setDescription

public static boolean setDescription(AbstractBuild<?,?> build,
                                     BuildListener listener,
                                     String regexp,
                                     String description,
                                     boolean appendMode)
                              throws InterruptedException

Sets the description on the given build based on the specified regular expression and description.

Parameters:

build - the build whose description to set.

listener - the build listener to report events to.

regexp - the regular expression to apply to the build log.

description - the description to set.

appendMode - if true, description is added to the current one

Returns:

true, regardless of if the regular expression matched and a description could be set or not.

Throws:

InterruptedException - if the build is interrupted by the user.