Package org.cyclos.impl.utils.notifications

Enum MailTemplateVariable

java.lang.Object

java.lang.Enum<MailTemplateVariable>

org.cyclos.impl.utils.notifications.MailTemplateVariable

All Implemented Interfaces:

Serializable, Comparable<MailTemplateVariable>, HasMessageKey

public enum MailTemplateVariable
extends Enum<MailTemplateVariable>
implements HasMessageKey

Enum Constant Summary

Enum Constants

Enum Constant	Description
EMAIL	E-mail address.
MESSAGE	E-mail message
NO_REPLY	No reply phrase.
SALUTATION	Salutation phrase.
SENT_TO	Phrase indicating the destination e-mail.
SUBJECT	E-mail subject.
UNSUBSCRIBE	Phrase with a link to unsubscribe.

Method Summary

Modifier and Type	Method	Description
MessageKey	getMessageKey()
ParameterVO	toParameter(TranslationHandler translationHandler)
static MailTemplateVariable	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MailTemplateVariable[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.
static MailTemplateVariable	variable(String name)

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SALUTATION

public static final MailTemplateVariable SALUTATION

Salutation phrase.

UNSUBSCRIBE

public static final MailTemplateVariable UNSUBSCRIBE

Phrase with a link to unsubscribe.

SENT_TO

public static final MailTemplateVariable SENT_TO

Phrase indicating the destination e-mail.

NO_REPLY

public static final MailTemplateVariable NO_REPLY

No reply phrase.

SUBJECT

public static final MailTemplateVariable SUBJECT

E-mail subject.

MESSAGE

public static final MailTemplateVariable MESSAGE

E-mail message

EMAIL

public static final MailTemplateVariable EMAIL

E-mail address.

Method Detail

values

public static MailTemplateVariable[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MailTemplateVariable c : MailTemplateVariable.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MailTemplateVariable valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

variable

public static MailTemplateVariable variable(String name)

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey

toParameter

public ParameterVO toParameter(TranslationHandler translationHandler)