ifs.fnd.internationalization

Class AmountToWordsUtil

java.lang.Object

ifs.fnd.internationalization.AmountToWordsUtil

public class AmountToWordsUtil
extends java.lang.Object

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object[]	getCurrencyList() Gives a list of currency codes recognized by the utility.
static AmountToWordsUtil	getInstance() Provides a shared instance of the AmountToWordsUtil.
java.lang.Object[]	getLocalesList() Gives a list of locales where corresponding spelloutrules can be found in the spelloutrules configuration file.
java.lang.String	spellout(java.math.BigDecimal amount, java.lang.String localeCode) Converts a BigDecimal representation of a financial amount to words without any currency units.
java.lang.String	spellout(java.math.BigDecimal amount, java.lang.String localeCode, java.lang.String currency, java.lang.String format) Converts a BigDecimal representation of a financial amount to words with a specified curency.
java.lang.String	spellout(double amount, java.lang.String localeCode) Converts a double representation of a financial amount to words without any currency units.
java.lang.String	spellout(java.lang.Double amount, java.lang.String localeCode) Converts a Double representation of a financial amount to words without any currency units.
java.lang.String	spellout(double amount, java.lang.String ifslangcode, java.lang.String currency) Converts a double representation of a financial amount to words using the default format.
java.lang.String	spellout(double amount, java.lang.String localeCode, java.lang.String currency, java.lang.String format) Converts a double representation of a financial amount to words with a specified curency.
java.lang.String	spellout(java.lang.Double amount, java.lang.String localeCode, java.lang.String currency, java.lang.String format) Converts a Double representation of a financial amount to words with a specified curency.
java.lang.String	spellout(long amount, java.lang.String localeCode) Converts a long representation of a financial amount to words without any currency units.
java.lang.String	spellout(java.lang.Long amount, java.lang.String localeCode) Converts a Long representation of a financial amount to words without any currency units.
java.lang.String	spellout(long amount, java.lang.String localeCode, java.lang.String currency, java.lang.String format) Converts a long representation of a financial amount to words with a specified curency.
java.lang.String	spellout(java.lang.Long amount, java.lang.String localeCode, java.lang.String currency, java.lang.String format) Converts a Long representation of a financial amount to words with a specified curency.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static AmountToWordsUtil getInstance()

Provides a shared instance of the AmountToWordsUtil. Clients should always invoke this method whenever an instance of AmountToWordsUtil is needed. Use of the default constructor is prohibited.

Returns:

shared instance of the AmountToWordsUtil

spellout

public java.lang.String spellout(double amount,
                        java.lang.String ifslangcode,
                        java.lang.String currency)
                          throws UnknownCurrencyException

Converts a double representation of a financial amount to words using the default format.

Parameters:

amount - financial amount

ifslangcode - ifs language that should be used for the conversion (e.g. en, fr, ja)

Returns:

amount in words in default format

Throws:

UnknownCurrencyException

spellout

public java.lang.String spellout(java.math.BigDecimal amount,
                        java.lang.String localeCode)

Converts a BigDecimal representation of a financial amount to words without any currency units.

Parameters:

amount - financial amount

localeCode - locale that should be used for the conversion (e.g. en_US)

Returns:

amount in words without currency units

spellout

public java.lang.String spellout(long amount,
                        java.lang.String localeCode)

Converts a long representation of a financial amount to words without any currency units.

Parameters:

amount - financial amount

localeCode - locale that should be used for the conversion (e.g. en_US)

Returns:

amount in words without currency units

spellout

public java.lang.String spellout(java.lang.Long amount,
                        java.lang.String localeCode)

Converts a Long representation of a financial amount to words without any currency units.

Parameters:

amount - financial amount

localeCode - locale that should be used for the conversion (e.g. en_US)

Returns:

amount in words without currency units

spellout

public java.lang.String spellout(java.lang.Double amount,
                        java.lang.String localeCode)

Converts a Double representation of a financial amount to words without any currency units.

Parameters:

amount - financial amount

localeCode - locale that should be used for the conversion (e.g. en_US)

Returns:

amount in words without currency units

spellout

public java.lang.String spellout(double amount,
                        java.lang.String localeCode)

Converts a double representation of a financial amount to words without any currency units.

Parameters:

amount - financial amount

localeCode - locale that should be used for the conversion (e.g. en_US)

Returns:

amount in words without currency units

spellout

public java.lang.String spellout(java.math.BigDecimal amount,
                        java.lang.String localeCode,
                        java.lang.String currency,
                        java.lang.String format)
                          throws UnknownCurrencyException

Converts a BigDecimal representation of a financial amount to words with a specified curency. See spellout(double, String, String, String) for a complete description.

Throws:

UnknownCurrencyException

spellout

public java.lang.String spellout(long amount,
                        java.lang.String localeCode,
                        java.lang.String currency,
                        java.lang.String format)
                          throws UnknownCurrencyException

Converts a long representation of a financial amount to words with a specified curency. See spellout(double, String, String, String) for a complete description.

Throws:

UnknownCurrencyException

spellout

public java.lang.String spellout(java.lang.Long amount,
                        java.lang.String localeCode,
                        java.lang.String currency,
                        java.lang.String format)
                          throws UnknownCurrencyException

Converts a Long representation of a financial amount to words with a specified curency. See spellout(double, String, String, String) for a complete description.

Throws:

UnknownCurrencyException

spellout

public java.lang.String spellout(java.lang.Double amount,
                        java.lang.String localeCode,
                        java.lang.String currency,
                        java.lang.String format)
                          throws UnknownCurrencyException

Converts a Double representation of a financial amount to words with a specified curency. See spellout(double, String, String, String) for a complete description.

Throws:

UnknownCurrencyException

spellout

public java.lang.String spellout(double amount,
                        java.lang.String localeCode,
                        java.lang.String currency,
                        java.lang.String format)
                          throws UnknownCurrencyException

Converts a double representation of a financial amount to words with a specified curency. format could be one of the three values, namely; SpelloutRule.WITHOUT_CURRENCY, SpelloutRule.CURRENCY_ONLY or SpelloutRule.CURRENCY_AND_HUNDREDTHS. Depending on the format the sub-rule used to perform the conversion would change.

currency parameter is always validated against the currency codes extracted from the configuration file. If no currency codes found in the configuration file, any value passed to the currencyparameter is considered as valid.

Parameters:

amount - financial amount

localeCode - locale that should be used for the conversion (e.g. en_US)

currency - curency code that should be used in resulting representation

format - format of the resulting representation. Possible values are SpelloutRule.WITHOUT_CURRENCY, SpelloutRule.CURRENCY_ONLY and SpelloutRule.CURRENCY_AND_HUNDREDTHS.

Returns:

amount in words with currency units

Throws:

UnknownCurrencyException - if currency is not valid.

getLocalesList

public java.lang.Object[] getLocalesList()

Gives a list of locales where corresponding spelloutrules can be found in the spelloutrules configuration file.

Returns:

a String array of locale codes recommended to use with the utility. null if no spelloutrules found in the configuration file.

getCurrencyList

public java.lang.Object[] getCurrencyList()

Gives a list of currency codes recognized by the utility. In other words, this returns all the currency codes defined in the currency data configuation file.

Returns:

a String array of currency codes recommended to use with the utility. null if no currencies found in the configuration file.