org.javamoney.moneta.spi

Class JDKCurrencyAdapter

java.lang.Object

org.javamoney.moneta.spi.JDKCurrencyAdapter

All Implemented Interfaces:

Serializable, Comparable<CurrencyUnit>, CurrencyUnit

public final class JDKCurrencyAdapter
extends Object
implements CurrencyUnit, Serializable, Comparable<CurrencyUnit>

Default implementation of a CurrencyUnit based on the using the JDK's Currency.

Version:

0.6

Author:

Anatole Tresch, Werner Keil

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
int	compareTo(CurrencyUnit currency) Compares two instances, based on getCurrencyCode().
boolean	equals(Object obj)
CurrencyContext	getContext()
String	getCurrencyCode() Gets the unique currency code, the effective code depends on the currency.
int	getDefaultFractionDigits() Gets the number of fractional digits typically used by this currency.
int	getNumericCode() Gets a numeric currency code.
int	hashCode()
String	toString() Returns getCurrencyCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getCurrencyCode

public String getCurrencyCode()

Gets the unique currency code, the effective code depends on the currency. Since each currency is identified by this code, the currency code is required to be defined for every CurrencyUnit and not null or empty. For ISO codes the 3-letter ISO code should be returned. For non ISO currencies no constraints are defined.

Specified by:

getCurrencyCode in interface CurrencyUnit

Returns:

the currency code, never null. For ISO-4217 this this will be the three letter ISO-4217 code. However, alternate currencies can have different codes. Also there is no constraint about the formatting of alternate codes, despite they fact that the currency codes must be unique.

See Also:

CurrencyUnit.getCurrencyCode()

getNumericCode

public int getNumericCode()

Gets a numeric currency code. Within the ISO-4217 name space, this equals to the ISO numeric code. In other currency name spaces this number may be different, or even undefined (-1). The numeric code is an optional alternative to the standard currency code. If defined, the numeric code is required to be unique. This method matches the API of Currency.

Specified by:

getNumericCode in interface CurrencyUnit

Returns:

the numeric currency code

See Also:

CurrencyUnit.getNumericCode()

getDefaultFractionDigits

public int getDefaultFractionDigits()

Gets the number of fractional digits typically used by this currency. Different currencies have different numbers of fractional digits by default. * For example, 'GBP' has 2 fractional digits, but 'JPY' has zero. * virtual currencies or those with no applicable fractional are indicated by -1. * This method matches the API of Currency.

Specified by:

getDefaultFractionDigits in interface CurrencyUnit

Returns:

the fractional digits, from 0 to 9 (normally 0, 2 or 3), or 0 for pseudo-currencies.

getContext

public CurrencyContext getContext()

Specified by:

getContext in interface CurrencyUnit

compareTo

public int compareTo(CurrencyUnit currency)

Compares two instances, based on getCurrencyCode().

Specified by:

compareTo in interface Comparable<CurrencyUnit>

Parameters:

currency - The instance to be compared with.

See Also:

Comparable.compareTo(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Returns getCurrencyCode()

Overrides:

toString in class Object

See Also:

Object.toString()