sample/java.util.Currency.txt

   1 *java.util.Currency* *Currency* Represents a currency.
   2
   3 public final class Currency
   4   extends    |java.lang.Object|
   5   implements |java.io.Serializable|
   6
   7 |java.util.Currency_Description|
   8 |java.util.Currency_Fields|
   9 |java.util.Currency_Constructors|
  10 |java.util.Currency_Methods|
  11
  12 ================================================================================
  13
  14 *java.util.Currency_Methods*
  15 |java.util.Currency.getCurrencyCode()|Gets the ISO 4217 currency code of this c
  16 |java.util.Currency.getDefaultFractionDigits()|Gets the default number of fract
  17 |java.util.Currency.getInstance(Locale)|Returns the Currency instance for the c
  18 |java.util.Currency.getInstance(String)|Returns the Currency instance for the g
  19 |java.util.Currency.getSymbol()|Gets the symbol of this currency for the defaul
  20 |java.util.Currency.getSymbol(Locale)|Gets the symbol of this currency for the
  21 |java.util.Currency.toString()|Returns the ISO 4217 currency code of this curre
  22
  23 *java.util.Currency_Description*
  24
  25 Represents a currency. Currencies are identified by their ISO 4217 currency
  26 codes. Visit the BSi web site for more information, including a table of
  27 currency codes.
  28
  29 The class is designed so that there's never more than one Currency instance for
  30 any given currency. Therefore, there's no public constructor. You obtain a
  31 Currency instance using the getInstance methods.
  32
  33
  34
  35 *java.util.Currency.getCurrencyCode()*
  36
  37 public |java.lang.String| getCurrencyCode()
  38
  39 Gets the ISO 4217 currency code of this currency.
  40
  41
  42
  43     Returns: the ISO 4217 currency code of this currency.
  44
  45 *java.util.Currency.getDefaultFractionDigits()*
  46
  47 public int getDefaultFractionDigits()
  48
  49 Gets the default number of fraction digits used with this currency. For
  50 example, the default number of fraction digits for the Euro is 2, while for the
  51 Japanese Yen it's 0. In the case of pseudo-currencies, such as IMF Special
  52 Drawing Rights, -1 is returned.
  53
  54
  55
  56     Returns: the default number of fraction digits used with this currency
  57
  58 *java.util.Currency.getInstance(Locale)*
  59
  60 public static |java.util.Currency| getInstance(java.util.Locale locale)
  61
  62 Returns the Currency instance for the country of the given locale. The language
  63 and variant components of the locale are ignored. The result may vary over
  64 time, as countries change their currencies. For example, for the original
  65 member countries of the European Monetary Union, the method returns the old
  66 national currencies until December 31, 2001, and the Euro from January 1, 2002,
  67 local time of the respective countries.
  68
  69 The method returns null for territories that don't have a currency, such as
  70 Antarctica.
  71
  72
  73     locale - the locale for whose country a Currency instance is needed
  74
  75     Returns: the Currency instance for the country of the given locale, or null
  76
  77 *java.util.Currency.getInstance(String)*
  78
  79 public static |java.util.Currency| getInstance(java.lang.String currencyCode)
  80
  81 Returns the Currency instance for the given currency code.
  82
  83
  84     currencyCode - the ISO 4217 code of the currency
  85
  86     Returns: the Currency instance for the given currency code
  87
  88 *java.util.Currency.getSymbol()*
  89
  90 public |java.lang.String| getSymbol()
  91
  92 Gets the symbol of this currency for the default locale. For example, for the
  93 US Dollar, the symbol is "$" if the default locale is the US, while for other
  94 locales it may be "US$". If no symbol can be determined, the ISO 4217 currency
  95 code is returned.
  96
  97
  98
  99     Returns: the symbol of this currency for the default locale
 100
 101 *java.util.Currency.getSymbol(Locale)*
 102
 103 public |java.lang.String| getSymbol(java.util.Locale locale)
 104
 105 Gets the symbol of this currency for the specified locale. For example, for the
 106 US Dollar, the symbol is "$" if the specified locale is the US, while for other
 107 locales it may be "US$". If no symbol can be determined, the ISO 4217 currency
 108 code is returned.
 109
 110
 111     locale - the locale for which a display name for this currency is needed
 112
 113     Returns: the symbol of this currency for the specified locale
 114
 115 *java.util.Currency.toString()*
 116
 117 public |java.lang.String| toString()
 118
 119 Returns the ISO 4217 currency code of this currency.
 120
 121
 122
 123     Returns: the ISO 4217 currency code of this currency
 124
 125