CCurrency (josef 3.2.5 API)

java.lang.Object
- java.lang.Enum<CCurrency>
- - org.josef.finance.CCurrency

All Implemented Interfaces:

Serializable, Comparable<CCurrency>
```
public enum CCurrency
extends Enum<CCurrency>
```
Enumeration of ISO 4217 currency codes.
If Currency fulfills your needs, please use that class. This list is by no way exhaustive but contains at least the most commonly used currency codes.
Besides not being complete, this enum has no notion yet of which currencies are valid at this time or were valid in an earlier period. This can however easily be added. For an example check out: Iso3166Country.
Finally, this enum has no knowledge of pseudo currencies.

Version:

1.0 $Revision: 6488 $

Author:

Kees Schotanus

See Also:

Currency

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ARGENTINE_PESO` Argentine Peso.
`AUSTRALIAN_DOLLAR` Australian Dollar.
`BRAZILIAN_REAL` Brazilian Real.
`CANADIAN_DOLLAR` Canadian Dollar.
`EURO` Euro.
`ICELAND_KRONA` Iceland Krona.
`INDIAN_RUPEE` Indian Rupee.
`MEXICAN_PESO` Mexican Peso.
`POUND_STERLING` Pound Sterling.
`RAND` Rand.
`SWISS_FRANC` Swiss Franc.
`TURKISH_LIRA` Turkish Lira.
`US_DOLLAR` US Dollar.
`YEN` Japanese Yen.
`YUAN_RENMINBI` Chinese Yen.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CCurrency`	`findCurrency(int numericCode)` Finds the currency with the supplied numericCode.
`static CCurrency`	`findCurrency(Locale locale)` Finds the currency used by the supplied locale.
`static CCurrency`	`findCurrency(String alphaCode)` Finds the currency with the supplied alphaCode.
`String`	`getAlphaCode()` Gets the alpha code of this currency.
`int`	`getDecimals()` Gets the number of decimals used with this currency.
`int`	`getNumericCode()` Gets the numeric code of this currency.
`String`	`getSymbol()` Gets the symbol of this currency.
`String`	`toString()` Creates a String representation of this CCurency.
`static CCurrency`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static CCurrency[]`	`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, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ARGENTINE_PESO
```
public static final CCurrency ARGENTINE_PESO
```
    Argentine Peso.
  - AUSTRALIAN_DOLLAR
```
public static final CCurrency AUSTRALIAN_DOLLAR
```
    Australian Dollar.
  - BRAZILIAN_REAL
```
public static final CCurrency BRAZILIAN_REAL
```
    Brazilian Real.
  - CANADIAN_DOLLAR
```
public static final CCurrency CANADIAN_DOLLAR
```
    Canadian Dollar.
  - EURO
```
public static final CCurrency EURO
```
    Euro.
  - ICELAND_KRONA
```
public static final CCurrency ICELAND_KRONA
```
    Iceland Krona.
  - INDIAN_RUPEE
```
public static final CCurrency INDIAN_RUPEE
```
    Indian Rupee.
  - MEXICAN_PESO
```
public static final CCurrency MEXICAN_PESO
```
    Mexican Peso.
  - POUND_STERLING
```
public static final CCurrency POUND_STERLING
```
    Pound Sterling.
  - RAND
```
public static final CCurrency RAND
```
    Rand.
  - SWISS_FRANC
```
public static final CCurrency SWISS_FRANC
```
    Swiss Franc.
  - TURKISH_LIRA
```
public static final CCurrency TURKISH_LIRA
```
    Turkish Lira.
  - US_DOLLAR
```
public static final CCurrency US_DOLLAR
```
    US Dollar.
  - YEN
```
public static final CCurrency YEN
```
    Japanese Yen.
  - YUAN_RENMINBI
```
public static final CCurrency YUAN_RENMINBI
```
    Chinese Yen.
- Method Detail
  - values
```
public static CCurrency[] 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 (CCurrency c : CCurrency.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static CCurrency valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getAlphaCode
```
public String getAlphaCode()
```
    Gets the alpha code of this currency.
    This code consists of three upper case letters.
    
    Returns:
    
    The alpha code of this currency.
  - getNumericCode
```
public int getNumericCode()
```
    Gets the numeric code of this currency.
    
    Returns:
    
    The numeric code of this currency.
  - getDecimals
```
public int getDecimals()
```
    Gets the number of decimals used with this currency.
    
    Returns:
    
    The number of decimals used with this currency.
  - getSymbol
```
public String getSymbol()
```
    Gets the symbol of this currency.
    
    Returns:
    
    The symbol of this currency.
  - toString
```
public String toString()
```
    Creates a String representation of this CCurency.
    
    Overrides:
    
    toString in class Enum<CCurrency>
    
    Returns:
    
    A String representation of this CCurency.
  - findCurrency
```
public static CCurrency findCurrency(String alphaCode)
```
    Finds the currency with the supplied alphaCode.
    
    Parameters:
    
    alphaCode - The alphabetic code of the currency to find.
    The supplied code is converted to upper case.
    
    Returns:
    
    The currency with the supplied alphaCode or null when no currency with the supplied alphaCode exists.
    
    Throws:
    
    NullPointerException - When the supplied alphaCode is null.
    
    IllegalArgumentException - When the supplied alphaCode is empty.
  - findCurrency
```
public static CCurrency findCurrency(int numericCode)
```
    Finds the currency with the supplied numericCode.
    
    Parameters:
    
    numericCode - The numeric code of the currency to find.
    
    Returns:
    
    The currency with the supplied numericCode or null when no currency with the supplied numericCode exists.
  - findCurrency
```
public static CCurrency findCurrency(Locale locale)
```
    Finds the currency used by the supplied locale.
    
    Parameters:
    
    locale - The locale to find the used currency for.
    
    Returns:
    
    The currency used by the supplied locale or null when no such currency exists.
    
    Throws:
    
    NullPointerException - When the supplied locale is null.

Enum CCurrency

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ARGENTINE_PESO

AUSTRALIAN_DOLLAR

BRAZILIAN_REAL

CANADIAN_DOLLAR

EURO

ICELAND_KRONA

INDIAN_RUPEE

MEXICAN_PESO

POUND_STERLING

RAND

SWISS_FRANC

TURKISH_LIRA

US_DOLLAR

YEN

YUAN_RENMINBI

Method Detail

values

valueOf

getAlphaCode

getNumericCode

getDecimals

getSymbol

toString

findCurrency

findCurrency

findCurrency