com.ail.financial
Enum FinancialFrequency

java.lang.Object
  java.lang.Enum<FinancialFrequency>
      com.ail.financial.FinancialFrequency

All Implemented Interfaces:

TypeEnum, java.io.Serializable, java.lang.Comparable<FinancialFrequency>

public enum FinancialFrequency
extends java.lang.Enum<FinancialFrequency>
implements TypeEnum

Type safe enumeration representing constant values for FinancialFrequency.

Version:

$Revision: 1.8 $

Enum Constant Summary

BIMONTHLY
Period of time

BIWEEKLY
Perdion of time

MONTHLY
Period of time

ONE_TIME
Once and once only.

QUARTERLY
Period of time

SEMESTERLY
Every half year

UNDEFINED
Undefined

WEEKLY
Period of time

YEARLY
Period of time

Method Summary

static FinancialFrequency	forName(java.lang.String name) This method is similar to the valueOf() method offered by Java's Enum type, but in this case it will match either the Enum's name or the longName.
java.lang.String	getLongName() Returns the same value as longName().
java.lang.String	getName() Returns the same value as name().
int	getOrdinal() Return this Enum's ordinal id.
java.lang.String	longName() The long name for an enum.
static FinancialFrequency	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FinancialFrequency[]	values() Returns an array containing the constants of this enum type, in the order they're declared.
java.lang.String	valuesAsCsv()

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ail.core.TypeEnum

name

Enum Constant Detail

UNDEFINED

public static final FinancialFrequency UNDEFINED

Undefined

WEEKLY

public static final FinancialFrequency WEEKLY

Period of time

BIWEEKLY

public static final FinancialFrequency BIWEEKLY

Perdion of time

MONTHLY

public static final FinancialFrequency MONTHLY

Period of time

BIMONTHLY

public static final FinancialFrequency BIMONTHLY

Period of time

QUARTERLY

public static final FinancialFrequency QUARTERLY

Period of time

SEMESTERLY

public static final FinancialFrequency SEMESTERLY

Every half year

YEARLY

public static final FinancialFrequency YEARLY

Period of time

ONE_TIME

public static final FinancialFrequency ONE_TIME

Once and once only.

Method Detail

values

public static final FinancialFrequency[] values()

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

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

Returns:

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

valueOf

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

getLongName

public java.lang.String getLongName()

Description copied from interface: TypeEnum

Returns the same value as longName(). This method only exists to make TypeEnum more Bean compatible so things like jxpath can make use of it.

Specified by:

getLongName in interface TypeEnum

Returns:

Enum's long name

valuesAsCsv

public java.lang.String valuesAsCsv()

longName

public java.lang.String longName()

Description copied from interface: TypeEnum

The long name for an enum. Unlike the name property on Java's Enum type, this need not be a valid Java identifier.

Specified by:

longName in interface TypeEnum

Returns:

The Enum's long name.

forName

public static FinancialFrequency forName(java.lang.String name)

This method is similar to the valueOf() method offered by Java's Enum type, but in this case it will match either the Enum's name or the longName.

Parameters:

name - The name to lookup

Returns:

The matching Enum, or IllegalArgumentException if there isn't a match.

getName

public java.lang.String getName()

Description copied from interface: TypeEnum

Returns the same value as name(). This method only exists to make TypeEnum more Bean compatible so things like jxpath can make use of it.

Specified by:

getName in interface TypeEnum

Returns:

Enum's name

getOrdinal

public int getOrdinal()

Description copied from interface: TypeEnum

Return this Enum's ordinal id. This method only exists to make TypeEnum more Bean compatible so things like jxpath can make use of it.

Specified by:

getOrdinal in interface TypeEnum

Returns:

Enum's ordinal.