|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.Currency
public final class Currency
Representation of a currency for a particular locale. Each currency
is identified by its ISO 4217 code, and only one instance of this
class exists per currency. As a result, instances are created
via the getInstance()
methods rather than by using
a constructor.
Locale
,
Serialized FormMethod Summary | |
---|---|
String |
getCurrencyCode()
Returns the ISO4217 currency code of this currency. |
int |
getDefaultFractionDigits()
Returns the number of digits which occur after the decimal point for this particular currency. |
static Currency |
getInstance(Locale locale)
Builds a new currency instance for this locale. |
static Currency |
getInstance(String currencyCode)
Builds the currency corresponding to the specified currency code. |
String |
getSymbol()
This method returns the symbol which precedes or follows a value in this particular currency. |
String |
getSymbol(Locale locale)
This method returns the symbol which precedes or follows a value in this particular currency. |
String |
toString()
Returns the international ISO4217 currency code of this currency. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public String getCurrencyCode()
String
containing currency code.public int getDefaultFractionDigits()
public static Currency getInstance(Locale locale)
locale
- a Locale
instance.
Currency
instance.
NullPointerException
- if the locale or its
country code is null.
IllegalArgumentException
- if the country of
the given locale is not a supported ISO3166 code.public static Currency getInstance(String currencyCode)
currencyCode
- a string representing a currency code.
Currency
instance.
NullPointerException
- if currencyCode is null.
IllegalArgumentException
- if the supplied currency code
is not a supported ISO 4217 code.public String getSymbol()
public String getSymbol(Locale locale)
This method returns the symbol which precedes or follows a value in this particular currency. The returned value is the symbol used to denote the currency in the specified locale.
For example, a supplied locale may specify a different symbol
for the currency, due to conflicts with its own currency.
This would be the case with the American currency, the dollar.
Locales that also use a dollar-based currency (e.g. Canada, Australia)
need to differentiate the American dollar using 'US$' rather than '$'.
So, supplying one of these locales to getSymbol()
would
return this value, rather than the standard '$'.
In cases where there is no such symbol for a particular currency, the ISO 4217 currency code is returned.
locale
- the locale to express the symbol in.
NullPointerException
- if the locale is null.public String toString()
toString
in class Object
String
containing the ISO4217 currency code.Object.getClass()
,
Object.hashCode()
,
Class.getName()
,
Integer.toHexString(int)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |