forestry.api.mail

Enum EnumTradeStationState

java.lang.Object

java.lang.Enum<EnumTradeStationState>

forestry.api.mail.EnumTradeStationState

All Implemented Interfaces:

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSUFFICIENT_BUFFER
INSUFFICIENT_OFFER
INSUFFICIENT_PAPER
INSUFFICIENT_STAMPS
INSUFFICIENT_TRADE_GOOD
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 EnumTradeStationState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EnumTradeStationState[]	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 EnumTradeStationState OK

INSUFFICIENT_OFFER

public static final EnumTradeStationState INSUFFICIENT_OFFER

INSUFFICIENT_TRADE_GOOD

public static final EnumTradeStationState INSUFFICIENT_TRADE_GOOD

INSUFFICIENT_BUFFER

public static final EnumTradeStationState INSUFFICIENT_BUFFER

INSUFFICIENT_PAPER

public static final EnumTradeStationState INSUFFICIENT_PAPER

INSUFFICIENT_STAMPS

public static final EnumTradeStationState INSUFFICIENT_STAMPS

Method Detail

values

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

Returns:

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

valueOf

public static EnumTradeStationState 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