forestry.mail

Enum EnumDeliveryState

java.lang.Object

java.lang.Enum<EnumDeliveryState>

forestry.mail.EnumDeliveryState

All Implemented Interfaces:

IPostalState, java.io.Serializable, java.lang.Comparable<EnumDeliveryState>

public enum EnumDeliveryState
extends java.lang.Enum<EnumDeliveryState>
implements IPostalState

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALREADY_MAILED
MAILBOX_FULL
NO_MAILBOX
NOT_MAILABLE
NOT_POSTPAID
OK

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Localized description of the postal state
boolean	isOk() Normal states are OK, error states are not OK
static EnumDeliveryState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EnumDeliveryState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

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

OK

public static final EnumDeliveryState OK

NO_MAILBOX

public static final EnumDeliveryState NO_MAILBOX

NOT_MAILABLE

public static final EnumDeliveryState NOT_MAILABLE

ALREADY_MAILED

public static final EnumDeliveryState ALREADY_MAILED

NOT_POSTPAID

public static final EnumDeliveryState NOT_POSTPAID

MAILBOX_FULL

public static final EnumDeliveryState MAILBOX_FULL

Method Detail

values

public static EnumDeliveryState[] 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 (EnumDeliveryState c : EnumDeliveryState.values())
    System.out.println(c);

Returns:

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

valueOf

public static EnumDeliveryState valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

isOk

public boolean isOk()

Description copied from interface: IPostalState

Normal states are OK, error states are not OK

Specified by:

isOk in interface IPostalState

getDescription

public java.lang.String getDescription()

Description copied from interface: IPostalState

Localized description of the postal state

Specified by:

getDescription in interface IPostalState