Package hudson.plugins.emailext.plugins.trigger

Class PreBuildTrigger

java.lang.Object

hudson.plugins.emailext.plugins.EmailTrigger

hudson.plugins.emailext.plugins.trigger.PreBuildTrigger

All Implemented Interfaces:

ExtensionPoint, Describable<EmailTrigger>

public class PreBuildTrigger
extends EmailTrigger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PreBuildTrigger.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static String	TRIGGER_NAME

Constructor Summary

Constructors

Constructor	Description
PreBuildTrigger(boolean sendToList, boolean sendToDevs, boolean sendToRequester, boolean sendToCulprits, String recipientList, String replyTo, String subject, String body, String attachmentsPattern, int attachBuildLog, String contentType)	Deprecated.
PreBuildTrigger(List<RecipientProvider> recipientProviders, String recipientList, String replyTo, String subject, String body, String attachmentsPattern, int attachBuildLog, String contentType)

Method Summary

Modifier and Type	Method	Description
boolean	isPreBuild()	Should this trigger run before the build? Defaults to false.
boolean	trigger(AbstractBuild<?,?> build, TaskListener listener)	Implementors of this method need to return true if the conditions to trigger an email have been met.

Methods inherited from class hudson.plugins.emailext.plugins.EmailTrigger

all, allWatchable, configure, createMailType, createMailType, getDescriptor, getEmail, getNumFailures, setEmail

Methods inherited from class java.lang.Object

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

Field Detail

TRIGGER_NAME

public static final String TRIGGER_NAME

See Also:

Constant Field Values

Constructor Detail

PreBuildTrigger

@DataBoundConstructor
public PreBuildTrigger(List<RecipientProvider> recipientProviders,
                       String recipientList,
                       String replyTo,
                       String subject,
                       String body,
                       String attachmentsPattern,
                       int attachBuildLog,
                       String contentType)

PreBuildTrigger

@Deprecated
public PreBuildTrigger(boolean sendToList,
                       boolean sendToDevs,
                       boolean sendToRequester,
                       boolean sendToCulprits,
                       String recipientList,
                       String replyTo,
                       String subject,
                       String body,
                       String attachmentsPattern,
                       int attachBuildLog,
                       String contentType)

Deprecated.

Method Detail

isPreBuild

public boolean isPreBuild()

Description copied from class: EmailTrigger

Should this trigger run before the build? Defaults to false.

Overrides:

isPreBuild in class EmailTrigger

Returns:

true if the trigger should be checked before the build.

trigger

public boolean trigger(AbstractBuild<?,?> build,
                       TaskListener listener)

Description copied from class: EmailTrigger

Implementors of this method need to return true if the conditions to trigger an email have been met.

Specified by:

trigger in class EmailTrigger

Parameters:

build - The Build object after the project has been built

listener - Used for logging to the build log

Returns:

true if the conditions have been met to trigger a build of this type