hudson.plugins.emailext.plugins.content
Class AbstractChangesSinceContent

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

All Implemented Interfaces:

hudson.ExtensionPoint, EmailContent

Direct Known Subclasses:

ChangesSinceLastSuccessfulBuildContent, ChangesSinceLastUnstableBuildContent

public abstract class AbstractChangesSinceContent
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	CHANGES_FORMAT_ARG_NAME
static java.lang.String	FORMAT_ARG_NAME
static java.lang.String	PATH_FORMAT_ARG_NAME
static java.lang.String	REVERSE_ARG_NAME
static boolean	REVERSE_DEFAULT_VALUE
static java.lang.String	SHOW_PATHS_ARG_NAME

Constructor Summary

AbstractChangesSinceContent()

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 emailType, java.util.Map<java.lang.String,?> args) This method returns the generated content that should replace the token.
abstract java.lang.String	getDefaultFormatValue()
abstract <P extends hudson.model.AbstractProject<P,B>,B extends hudson.model.AbstractBuild<P,B>> hudson.model.AbstractBuild<P,B>	getFirstIncludedBuild(hudson.model.AbstractBuild<P,B> build)
java.lang.String	getHelpText() This is a string that will be rendered in the help section of the plugin.
abstract java.lang.String	getShortHelpDescription()
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

Methods inherited from interface hudson.plugins.emailext.plugins.EmailContent

getToken

Field Detail

REVERSE_ARG_NAME

public static final java.lang.String REVERSE_ARG_NAME

See Also:

Constant Field Values

REVERSE_DEFAULT_VALUE

public static final boolean REVERSE_DEFAULT_VALUE

See Also:

Constant Field Values

FORMAT_ARG_NAME

public static final java.lang.String FORMAT_ARG_NAME

See Also:

Constant Field Values

SHOW_PATHS_ARG_NAME

public static final java.lang.String SHOW_PATHS_ARG_NAME

See Also:

Constant Field Values

CHANGES_FORMAT_ARG_NAME

public static final java.lang.String CHANGES_FORMAT_ARG_NAME

See Also:

Constant Field Values

PATH_FORMAT_ARG_NAME

public static final java.lang.String PATH_FORMAT_ARG_NAME

See Also:

Constant Field Values

Constructor Detail

AbstractChangesSinceContent

public AbstractChangesSinceContent()

Method Detail

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

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

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 emailType,
                                                                                                                           java.util.Map<java.lang.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 - TODO

args - 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

getDefaultFormatValue

public abstract java.lang.String getDefaultFormatValue()

getShortHelpDescription

public abstract java.lang.String getShortHelpDescription()

getFirstIncludedBuild

public abstract <P extends hudson.model.AbstractProject<P,B>,B extends hudson.model.AbstractBuild<P,B>> hudson.model.AbstractBuild<P,B> getFirstIncludedBuild(hudson.model.AbstractBuild<P,B> build)