hudson.plugins.emailext.plugins
Class EmailTriggerDescriptor

java.lang.Object
  hudson.plugins.emailext.plugins.EmailTriggerDescriptor

Direct Known Subclasses:

FailureTrigger.DescriptorImpl, FixedTrigger.DescriptorImpl, StillFailingTrigger.DescriptorImpl, StillUnstableTrigger.DescriptorImpl, SuccessTrigger.DescriptorImpl, UnstableTrigger.DescriptorImpl

public abstract class EmailTriggerDescriptor
extends java.lang.Object

Field Summary

protected java.util.List<java.lang.String>

replacesList

Constructor Summary

EmailTriggerDescriptor()

Method Summary

void	addTriggerNameToReplace(java.lang.String triggerName) You can add the name of a trigger that this trigger should override if both this and the specified trigger meet the criteria to send an email.
abstract java.lang.String	getHelpText()
java.lang.String	getMailerId() Get a name that can be used to determine which properties in the jelly script applyt to this trigger.
EmailTrigger	getNewInstance(EmailType type)
abstract java.lang.String	getTriggerName()
java.util.List<java.lang.String>	getTriggerReplaceList()
protected abstract EmailTrigger	newInstance()

Methods inherited from class java.lang.Object

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

Field Detail

replacesList

protected java.util.List<java.lang.String> replacesList

Constructor Detail

EmailTriggerDescriptor

public EmailTriggerDescriptor()

Method Detail

getTriggerName

public abstract java.lang.String getTriggerName()

Returns:

The display name of the trigger type.

getMailerId

public java.lang.String getMailerId()

Get a name that can be used to determine which properties in the jelly script applyt to this trigger.

Returns:

addTriggerNameToReplace

public void addTriggerNameToReplace(java.lang.String triggerName)

You can add the name of a trigger that this trigger should override if both this and the specified trigger meet the criteria to send an email. If a trigger is specified, then its corresponding email will not be sent. This is a means to simplify the work a plugin developer needs to do to make sure that only a single email is sent.

Parameters:

triggerName - is the name of a trigger that should be deactivated if it is specified.

See Also:

getTriggerName()

getTriggerReplaceList

public java.util.List<java.lang.String> getTriggerReplaceList()

newInstance

protected abstract EmailTrigger newInstance()

getNewInstance

public EmailTrigger getNewInstance(EmailType type)

getHelpText

public abstract java.lang.String getHelpText()