org.ceryle.wiki.plugin.emailnotifier
Class NotificationFormatter

java.lang.Object
  org.ceryle.wiki.plugin.emailnotifier.NotificationFormatter

public class NotificationFormatter
extends Object

Javadoc: TODO.

Author:

John Volkar (john.volkar at gmail.com)

Field Summary

static String	MARKER_CHANGED_PAGE_INFO Some 'info' about the changed page (author and version), this marker can be used in the PARAM_CHANGED_PAGE_PATTERN as desired.
static String	MARKER_CHANGED_PAGE_LIST Location where the list of changed pages will be inserted.
static String	MARKER_CHANGED_PAGE_NAME The name of the changed page, this marker can be used in the PARAM_CHANGED_PAGE_PATTERN as desired.
static String	MARKER_SUBSCRIPTION_PAGE Name of the subscription page specificed by the plugin parameter.

Constructor Summary

NotificationFormatter()

Method Summary

void	addToPageList(String pageName, List versionList)
String	getFinishedMessageBody()
void	replacePageListMarker()
void	replaceSubscriptionPageMarker(String page)
void	resetSubscriberSpecificElements()
void	updateFormatterParameters(Map paramMap)

Methods inherited from class java.lang.Object

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

Field Detail

MARKER_SUBSCRIPTION_PAGE

public static final String MARKER_SUBSCRIPTION_PAGE

Name of the subscription page specificed by the plugin parameter. Must be found in the plugin's body or else a default message body will be used.

See Also:

Constant Field Values

MARKER_CHANGED_PAGE_LIST

public static final String MARKER_CHANGED_PAGE_LIST

Location where the list of changed pages will be inserted. Must be found in the plugin's body or else a default message body will be used.

See Also:

Constant Field Values

MARKER_CHANGED_PAGE_NAME

public static final String MARKER_CHANGED_PAGE_NAME

The name of the changed page, this marker can be used in the PARAM_CHANGED_PAGE_PATTERN as desired.

See Also:

Constant Field Values

MARKER_CHANGED_PAGE_INFO

public static final String MARKER_CHANGED_PAGE_INFO

Some 'info' about the changed page (author and version), this marker can be used in the PARAM_CHANGED_PAGE_PATTERN as desired.

See Also:

Constant Field Values

Constructor Detail

NotificationFormatter

public NotificationFormatter()

Method Detail

updateFormatterParameters

public void updateFormatterParameters(Map paramMap)

replaceSubscriptionPageMarker

public void replaceSubscriptionPageMarker(String page)

replacePageListMarker

public void replacePageListMarker()

getFinishedMessageBody

public String getFinishedMessageBody()

addToPageList

public void addToPageList(String pageName,
                          List versionList)

resetSubscriberSpecificElements

public void resetSubscriberSpecificElements()