hudson.plugins.emailext.plugins.content
Class JellyScriptContent

java.lang.Object
  hudson.plugins.emailext.plugins.content.JellyScriptContent

All Implemented Interfaces:

hudson.ExtensionPoint, EmailContent

public class JellyScriptContent
extends java.lang.Object
implements EmailContent

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.plugins.emailext.plugins.EmailContent

EmailContent.Args

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

static java.lang.String

TEMPLATE_NAME_ARG

Constructor Summary

JellyScriptContent()

Method Summary

java.util.List<java.lang.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>> java.lang.String	getContent(hudson.model.AbstractBuild<P,B> build, ExtendedEmailPublisher publisher, EmailType type, java.util.Map<java.lang.String,?> args) This method returns the generated content that should replace the token.
java.lang.String	getHelpText() This is a string that will be rendered in the help section of the plugin.
java.lang.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

Field Detail

TEMPLATE_NAME_ARG

public static final java.lang.String TEMPLATE_NAME_ARG

See Also:

Constant Field Values

Constructor Detail

JellyScriptContent

public JellyScriptContent()

Method Detail

getToken

public java.lang.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

getHelpText

public java.lang.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

getArguments

public java.util.List<java.lang.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

getContent

public <P extends hudson.model.AbstractProject<P,B>,B extends hudson.model.AbstractBuild<P,B>> java.lang.String getContent(hudson.model.AbstractBuild<P,B> build,
                                                                                                                           ExtendedEmailPublisher publisher,
                                                                                                                           EmailType type,
                                                                                                                           java.util.Map<java.lang.String,?> args)
                            throws java.io.IOException,
                                   java.lang.InterruptedException

Description copied from interface: EmailContent

This method returns the generated content that should replace the token.

Specified by:

getContent in interface EmailContent

publisher - TODO

args - the arguments for generating the content

Throws:

java.io.IOException

java.lang.InterruptedException

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