hudson.plugins.emailext.plugins
Class EmailTriggerDescriptor

java.lang.Object
  extended by hudson.plugins.emailext.plugins.EmailTriggerDescriptor
Direct Known Subclasses:
AbortedTrigger.DescriptorImpl, FailureTrigger.DescriptorImpl, FixedTrigger.DescriptorImpl, ImprovementTrigger.DescriptorImpl, NotBuiltTrigger.DescriptorImpl, PreBuildTrigger.DescriptorImpl, RegressionTrigger.DescriptorImpl, StillFailingTrigger.DescriptorImpl, StillUnstableTrigger.DescriptorImpl, SuccessTrigger.DescriptorImpl, UnstableTrigger.DescriptorImpl

public abstract class EmailTriggerDescriptor
extends Object


Field Summary
protected  List<String> replacesList
           
 
Constructor Summary
EmailTriggerDescriptor()
           
 
Method Summary
 void addTriggerNameToReplace(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  String getHelpText()
           
 String getMailerId()
          Get a name that can be used to determine which properties in the jelly script apply to this trigger.
 EmailTrigger getNewInstance(EmailType type)
           
abstract  String getTriggerName()
           
 List<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 List<String> replacesList
Constructor Detail

EmailTriggerDescriptor

public EmailTriggerDescriptor()
Method Detail

getTriggerName

public abstract String getTriggerName()
Returns:
The display name of the trigger type.

getMailerId

public String getMailerId()
Get a name that can be used to determine which properties in the jelly script apply to this trigger.

Returns:
the jelly name of the trigger type

addTriggerNameToReplace

public void addTriggerNameToReplace(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 List<String> getTriggerReplaceList()

newInstance

protected abstract EmailTrigger newInstance()

getNewInstance

public EmailTrigger getNewInstance(EmailType type)

getHelpText

public abstract String getHelpText()


Copyright © 2004-2012. All Rights Reserved.