prajna.data

Enum CurrencyUnit

java.lang.Object

java.lang.Enum<CurrencyUnit>

prajna.data.CurrencyUnit

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CurrencyUnit>, Unit

public enum CurrencyUnit
extends java.lang.Enum<CurrencyUnit>
implements Unit

Unit class which represents currency values. The base unit for currency is the US Dollar. This class does not yet handle currency conversion properly, and the conversion values are somewhat arbitrary.

Author:

Edward Swing

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOLLAR
EURO
YEN

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAbbreviation() Get the abbreviation for the unit
double	getConvertFactor() Get the conversion factor for this unit.
static CurrencyUnit	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CurrencyUnit[]	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

DOLLAR

public static final CurrencyUnit DOLLAR

EURO

public static final CurrencyUnit EURO

YEN

public static final CurrencyUnit YEN

Method Detail

values

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

Returns:

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

valueOf

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

getAbbreviation

public java.lang.String getAbbreviation()

Get the abbreviation for the unit

Specified by:

getAbbreviation in interface Unit

Returns:

the abbreviation

getConvertFactor

public double getConvertFactor()

Get the conversion factor for this unit. This method does not currently handle currency conversions with up-to-date conversion values.

Specified by:

getConvertFactor in interface Unit

Returns:

the conversion factor