declare namespace java { namespace util { /** * Represents a currency. Currencies are identified by their ISO 4217 currency * codes. Visit the * ISO web site for more information. *
* The class is designed so that there's never more than one
* Currency
instance for any given currency. Therefore, there's
* no public constructor. You obtain a Currency
instance using
* the getInstance
methods.
*
* Users can supersede the Java runtime currency data by means of the system * property {@code java.util.currency.data}. If this system property is * defined then its value is the location of a properties file, the contents of * which are key/value pairs of the ISO 3166 country codes and the ISO 4217 * currency data respectively. The value part consists of three ISO 4217 values * of a currency, i.e., an alphabetic code, a numeric code, and a minor unit. * Those three ISO 4217 values are separated by commas. * The lines which start with '#'s are considered comment lines. An optional UTC * timestamp may be specified per currency entry if users need to specify a * cutover date indicating when the new data comes into effect. The timestamp is * appended to the end of the currency properties and uses a comma as a separator. * If a UTC datestamp is present and valid, the JRE will only use the new currency * properties if the current UTC date is later than the date specified at class * loading time. The format of the timestamp must be of ISO 8601 format : * {@code 'yyyy-MM-dd'T'HH:mm:ss'}. For example, *
*
* #Sample currency properties
*
* JP=JPZ,999,0
*
* will supersede the currency data for Japan. *
*
* #Sample currency properties with cutover date
*
* JP=JPZ,999,0,2014-01-01T00:00:00
*
* will supersede the currency data for Japan if {@code Currency} class is loaded after * 1st January 2014 00:00:00 GMT. *
* Where syntactically malformed entries are encountered, the entry is ignored
* and the remainder of entries in file are processed. For instances where duplicate
* country code entries exist, the behavior of the Currency information for that
* {@code Currency} is undefined and the remainder of entries in file are processed.
* @since 1.4
*/
// @ts-ignore
class Currency extends java.lang.Object implements java.io.Serializable {
/**
* Returns the Currency
instance for the given currency code.
* @param currencyCode the ISO 4217 code of the currency
* @return the Currency
instance for the given currency code
* @exception NullPointerException if currencyCode
is null
* @exception IllegalArgumentException if currencyCode
is not
* a supported ISO 4217 code.
*/
// @ts-ignore
public static getInstance(currencyCode: java.lang.String | string): java.util.Currency
/**
* Returns the Currency
instance for the country of the
* given locale. The language and variant components of the locale
* are ignored. The result may vary over time, as countries change their
* currencies. For example, for the original member countries of the
* European Monetary Union, the method returns the old national currencies
* until December 31, 2001, and the Euro from January 1, 2002, local time
* of the respective countries.
*
* The method returns
* This is equivalent to calling
* {@link #getSymbol(Locale)
* getSymbol(Locale.getDefault(Locale.Category.DISPLAY))}.
* @return the symbol of this currency for the default
* {#link Locale.Category#DISPLAY DISPLAY} locale
*/
// @ts-ignore
public getSymbol(): string
/**
* Gets the symbol of this currency for the specified locale.
* For example, for the US Dollar, the symbol is "$" if the specified
* locale is the US, while for other locales it may be "US$". If no
* symbol can be determined, the ISO 4217 currency code is returned.
* @param locale the locale for which a display name for this currency is
* needed
* @return the symbol of this currency for the specified locale
* @exception NullPointerException if
* This is equivalent to calling
* {@link #getDisplayName(Locale)
* getDisplayName(Locale.getDefault(Locale.Category.DISPLAY))}.
* @return the display name of this currency for the default
* {#link Locale.Category#DISPLAY DISPLAY} locale
* @since 1.7
*/
// @ts-ignore
public getDisplayName(): string
/**
* Gets the name that is suitable for displaying this currency for
* the specified locale. If there is no suitable display name found
* for the specified locale, the ISO 4217 currency code is returned.
* @param locale the locale for which a display name for this currency is
* needed
* @return the display name of this currency for the specified locale
* @exception NullPointerException if null
for territories that don't
* have a currency, such as Antarctica.
* @param locale the locale for whose country a Currency
* instance is needed
* @return the Currency
instance for the country of the given
* locale, or {#code null}
* @exception NullPointerException if locale
or its country
* code is {#code null}
* @exception IllegalArgumentException if the country of the given {#code locale}
* is not a supported ISO 3166 country code.
*/
// @ts-ignore
public static getInstance(locale: java.util.Locale): java.util.Currency
/**
* Gets the set of available currencies. The returned set of currencies
* contains all of the available currencies, which may include currencies
* that represent obsolete ISO 4217 codes. The set can be modified
* without affecting the available currencies in the runtime.
* @return the set of available currencies. If there is no currency
* available in the runtime, the returned set is empty.
* @since 1.7
*/
// @ts-ignore
public static getAvailableCurrencies(): Arraylocale
is null
*/
// @ts-ignore
public getSymbol(locale: java.util.Locale): string
/**
* Gets the default number of fraction digits used with this currency.
* For example, the default number of fraction digits for the Euro is 2,
* while for the Japanese Yen it's 0.
* In the case of pseudo-currencies, such as IMF Special Drawing Rights,
* -1 is returned.
* @return the default number of fraction digits used with this currency
*/
// @ts-ignore
public getDefaultFractionDigits(): number /*int*/
/**
* Returns the ISO 4217 numeric code of this currency.
* @return the ISO 4217 numeric code of this currency
* @since 1.7
*/
// @ts-ignore
public getNumericCode(): number /*int*/
/**
* Gets the name that is suitable for displaying this currency for
* the default {@link Locale.Category#DISPLAY DISPLAY} locale.
* If there is no suitable display name found
* for the default locale, the ISO 4217 currency code is returned.
* locale
is null
* @since 1.7
*/
// @ts-ignore
public getDisplayName(locale: java.util.Locale): string
/**
* Returns the ISO 4217 currency code of this currency.
* @return the ISO 4217 currency code of this currency
*/
// @ts-ignore
public toString(): string
}
}
}