hudson.plugins.emailext.plugins.content
Class BuildNumberContent
java.lang.Object
hudson.plugins.emailext.plugins.content.BuildNumberContent
- All Implemented Interfaces:
- hudson.ExtensionPoint, EmailContent
public class BuildNumberContent
- extends Object
- implements EmailContent
Nested classes/interfaces inherited from interface hudson.ExtensionPoint |
hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson |
Method Summary |
List<String> |
getArguments()
These are the arguments accepted when generating the content for this token. |
<P extends hudson.model.AbstractProject<P,B>,B extends hudson.model.AbstractBuild<P,B>>
String |
|
getContent(hudson.model.AbstractBuild<P,B> build,
ExtendedEmailPublisher publisher,
EmailType emailType,
Map<String,?> args)
This method returns the generated content that should replace the token. |
String |
getHelpText()
This is a string that will be rendered in the help section of the plugin. |
String |
getToken()
This is the token that will be replaced by the content when the email is sent. |
boolean |
hasNestedContent()
Specifies whether or not the content returned by this object can have nested
tokens in it that need to be resolved before sending the email. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
BuildNumberContent
public BuildNumberContent()
getToken
public String getToken()
- Description copied from interface:
EmailContent
- This is the token that will be replaced by the content when the email is sent.
If the email has a string like "$REPLACE_ME", then the implementation of this
method should return "REPLACE_ME".
- Specified by:
getToken
in interface EmailContent
getArguments
public List<String> getArguments()
- Description copied from interface:
EmailContent
- These are the arguments accepted when generating the content for this token.
- Specified by:
getArguments
in interface EmailContent
getHelpText
public String getHelpText()
- Description copied from interface:
EmailContent
- This is a string that will be rendered in the help section of the plugin.
It describes what the content does and what it puts in the email.
- Specified by:
getHelpText
in interface EmailContent
getContent
public <P extends hudson.model.AbstractProject<P,B>,B extends hudson.model.AbstractBuild<P,B>> String getContent(hudson.model.AbstractBuild<P,B> build,
ExtendedEmailPublisher publisher,
EmailType emailType,
Map<String,?> args)
- Description copied from interface:
EmailContent
- This method returns the generated content that should replace the token.
- Specified by:
getContent
in interface EmailContent
publisher
- TODOargs
- the arguments for generating the content
hasNestedContent
public boolean hasNestedContent()
- Description copied from interface:
EmailContent
- Specifies whether or not the content returned by this object can have nested
tokens in it that need to be resolved before sending the email.
- Specified by:
hasNestedContent
in interface EmailContent
Copyright © 2004-2012. All Rights Reserved.