Package com.nsdev.lettergenerator.letter

Enum Class LetterElement

java.lang.Object

java.lang.Enum<LetterElement>

com.nsdev.lettergenerator.letter.LetterElement

All Implemented Interfaces:

Serializable, Comparable<LetterElement>, Constable

public enum LetterElement
extends Enum<LetterElement>

Semantic content positions used by letter authoring and theme defaults.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSING	Closing phrase after body content.
DATE	Letter date.
RECIPIENT	Recipient identity and address.
REFERENCE	Labeled reference information.
SALUTATION	Opening greeting.
SENDER	Sender identity and address.
SUBJECT	Letter subject.

Method Summary

Modifier and Type	Method	Description
static LetterElement	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LetterElement[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SENDER

public static final LetterElement SENDER

Sender identity and address.

DATE

public static final LetterElement DATE

Letter date.

RECIPIENT

public static final LetterElement RECIPIENT

Recipient identity and address.

REFERENCE

public static final LetterElement REFERENCE

Labeled reference information.

SUBJECT

public static final LetterElement SUBJECT

Letter subject.

SALUTATION

public static final LetterElement SALUTATION

Opening greeting.

CLOSING

public static final LetterElement CLOSING

Closing phrase after body content.

Method Details

values

public static LetterElement[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static LetterElement valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null