ilog.views.util.text

Class IlvNumberFormatFactory

java.lang.Object

ilog.views.util.text.IlvNumberFormatFactory

public class IlvNumberFormatFactory
extends Object

This class provides NumberFormat objects for specified locales.

Since:

JViews 8.8

Field Summary

Fields

Modifier and Type	Field and Description
static int	CURRENCYSTYLE Constant to specify currency style of format which uses currency symbol to represent currency, for example: "$3.00".
static int	INTEGERSTYLE Constant to specify a integer number style format.
static int	ISOCURRENCYSTYLE Constant to specify currency style of format which uses currency ISO code to represent currency, for example: "USD3.00".
static int	NUMBERSTYLE Constant to specify normal number style of format.
static int	PERCENTSTYLE Constant to specify a style of format to display percent.
static int	PLURALCURRENCYSTYLE Constant to specify currency style of format which uses currency long name with plural format to represent currency, for example, "3.00 US Dollars".
static int	SCIENTIFICSTYLE Constant to specify a style of format to display scientific number.

Method Summary

Modifier and Type	Method and Description
static NumberFormat	createCurrencyInstance() Returns a freshly created currency number formatter for the current locale.
static NumberFormat	createCurrencyInstance(Locale locale) Deprecated. This method ignores the numbers specification in the ULocale. Better use createCurrencyInstance(ULocale) instead.
static NumberFormat	createCurrencyInstance(ULocale locale) Returns a freshly created currency decimal number formatter for the given locale.
static NumberFormat	createInstance() Returns a freshly created default decimal number formatter for the current locale.
static NumberFormat	createInstance(Locale locale) Deprecated. This method ignores the numbers specification in the ULocale. Better use createInstance(ULocale) instead.
static DecimalFormat	createInstance(String pattern) Returns a freshly created decimal number formatter instance using the specified pattern for the current locale.
static DecimalFormat	createInstance(String pattern, Locale locale) Deprecated. This method ignores the numbers specification in the ULocale. Better use createInstance(String, ULocale) instead.
static DecimalFormat	createInstance(String pattern, ULocale locale) Returns a freshly created decimal number formatter instance using the specified pattern for the given locale.
static NumberFormat	createInstance(ULocale locale) Returns a freshly created default decimal number formatter for the given locale.
static NumberFormat	createIntegerInstance() Returns a freshly created integer decimal number formatter for the current locale.
static NumberFormat	createIntegerInstance(Locale locale) Deprecated. This method ignores the numbers specification in the ULocale. Better use createIntegerInstance(ULocale) instead.
static NumberFormat	createIntegerInstance(ULocale locale) Returns a freshly created integer decimal number formatter for the given locale.
static NumberFormat	createPercentInstance() Returns a freshly created percentage number formatter for the current locale.
static NumberFormat	createPercentInstance(Locale locale) Deprecated. This method ignores the numbers specification in the ULocale. Better use createPercentInstance(ULocale) instead.
static NumberFormat	createPercentInstance(ULocale locale) Returns a freshly created percentage number formatter for the given locale.
static NumberFormat	createScientificInstance() Returns a freshly created scientific decimal number formatter for the current locale.
static NumberFormat	createScientificInstance(Locale locale) Deprecated. This method ignores the numbers specification in the ULocale. Better use createScientificInstance(ULocale) instead.
static NumberFormat	createScientificInstance(ULocale locale) Returns a freshly created scientific decimal number formatter for the given locale.
static NumberFormat	getCurrencyInstance() Returns a currency number formatter for the current locale.
static NumberFormat	getCurrencyInstance(Locale locale) Deprecated. This method ignores the numbers specification in the ULocale. Better use getCurrencyInstance(ULocale) instead.
static NumberFormat	getCurrencyInstance(ULocale locale) Returns a currency decimal number formatter for the given locale.
static String	getDefaultPattern(ULocale locale, int choice) Returns the default pattern if no specific pattern is given for the DecimalFormat.
static NumberFormat	getInstance() Returns a default decimal number formatter for the current locale.
static NumberFormat	getInstance(Locale locale) Deprecated. This method ignores the numbers specification in the ULocale. Better use getInstance(ULocale) instead.
static DecimalFormat	getInstance(String pattern) Returns a decimal number formatter instance using the specified pattern for the current locale.
static DecimalFormat	getInstance(String pattern, Locale locale) Deprecated. This method ignores the numbers specification in the ULocale. Better use getInstance(String, ULocale) instead.
static DecimalFormat	getInstance(String pattern, ULocale locale) Returns a decimal number formatter instance using the specified pattern for the given locale.
static NumberFormat	getInstance(ULocale locale) Returns a default decimal number formatter for the given locale.
static NumberFormat	getIntegerInstance() Returns an integer decimal number formatter for the current locale.
static NumberFormat	getIntegerInstance(Locale locale) Deprecated. This method ignores the numbers specification in the ULocale. Better use getIntegerInstance(ULocale) instead.
static NumberFormat	getIntegerInstance(ULocale locale) Returns an integer decimal number formatter for the given locale.
static NumberFormat	getPercentInstance() Returns a percentage number formatter for the current locale.
static NumberFormat	getPercentInstance(Locale locale) Deprecated. This method ignores the numbers specification in the ULocale. Better use getPercentInstance(ULocale) instead.
static NumberFormat	getPercentInstance(ULocale locale) Returns a percentage number formatter for the given locale.
static NumberFormat	getScientificInstance() Returns a scientific decimal number formatter for the current locale.
static NumberFormat	getScientificInstance(Locale locale) Deprecated. This method ignores the numbers specification in the ULocale. Better use getScientificInstance(ULocale) instead.
static NumberFormat	getScientificInstance(ULocale locale) Returns a scientific decimal number formatter for the given locale.

Methods inherited from class java.lang.Object

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

Field Detail

NUMBERSTYLE

public static final int NUMBERSTYLE

Constant to specify normal number style of format.

See Also:

getDefaultPattern(com.ibm.icu.util.ULocale, int), Constant Field Values

CURRENCYSTYLE

public static final int CURRENCYSTYLE

Constant to specify currency style of format which uses currency symbol to represent currency, for example: "$3.00".

See Also:

getDefaultPattern(com.ibm.icu.util.ULocale, int), Constant Field Values

PERCENTSTYLE

public static final int PERCENTSTYLE

Constant to specify a style of format to display percent.

See Also:

getDefaultPattern(com.ibm.icu.util.ULocale, int), Constant Field Values

SCIENTIFICSTYLE

public static final int SCIENTIFICSTYLE

Constant to specify a style of format to display scientific number.

See Also:

getDefaultPattern(com.ibm.icu.util.ULocale, int), Constant Field Values

INTEGERSTYLE

public static final int INTEGERSTYLE

Constant to specify a integer number style format.

See Also:

getDefaultPattern(com.ibm.icu.util.ULocale, int), Constant Field Values

ISOCURRENCYSTYLE

public static final int ISOCURRENCYSTYLE

Constant to specify currency style of format which uses currency ISO code to represent currency, for example: "USD3.00".

See Also:

getDefaultPattern(com.ibm.icu.util.ULocale, int), Constant Field Values

PLURALCURRENCYSTYLE

public static final int PLURALCURRENCYSTYLE

Constant to specify currency style of format which uses currency long name with plural format to represent currency, for example, "3.00 US Dollars".

See Also:

getDefaultPattern(com.ibm.icu.util.ULocale, int), Constant Field Values

Method Detail

getInstance

public static NumberFormat getInstance()

Returns a default decimal number formatter for the current locale.

Note: The returned instance is shared and must not be destructively modified.

Returns:

A default decimal number formatter.

See Also:

createInstance()

getInstance

@Deprecated
public static NumberFormat getInstance(Locale locale)

Deprecated. This method ignores the numbers specification in the ULocale. Better use getInstance(ULocale) instead.

Returns a default decimal number formatter for the given locale.

Note: The returned instance is shared and must not be destructively modified.

Returns:

A default decimal number formatter.

See Also:

createInstance(Locale)

getInstance

public static NumberFormat getInstance(ULocale locale)

Returns a default decimal number formatter for the given locale.

Note: The returned instance is shared and must not be destructively modified.

Returns:

A default decimal number formatter.

See Also:

createInstance(ULocale)

getIntegerInstance

public static NumberFormat getIntegerInstance()

Returns an integer decimal number formatter for the current locale. It is configured to round floating point numbers to the nearest integer using IEEE half-even rounding for formatting, and to parse only the integer part of an input string.

Note: The returned instance is shared and must not be destructively modified.

Returns:

A default decimal number formatter for integers.

See Also:

createIntegerInstance()

getIntegerInstance

@Deprecated
public static NumberFormat getIntegerInstance(Locale locale)

Deprecated. This method ignores the numbers specification in the ULocale. Better use getIntegerInstance(ULocale) instead.

Returns an integer decimal number formatter for the given locale. It is configured to round floating point numbers to the nearest integer using IEEE half-even rounding for formatting, and to parse only the integer part of an input string.

Note: The returned instance is shared and must not be destructively modified.

Returns:

A default decimal number formatter for integers.

See Also:

createIntegerInstance(Locale)

getIntegerInstance

public static NumberFormat getIntegerInstance(ULocale locale)

Returns an integer decimal number formatter for the given locale. It is configured to round floating point numbers to the nearest integer using IEEE half-even rounding for formatting, and to parse only the integer part of an input string.

Note: The returned instance is shared and must not be destructively modified.

Returns:

A default decimal number formatter for integers.

See Also:

createIntegerInstance(ULocale)

getCurrencyInstance

public static NumberFormat getCurrencyInstance()

Returns a currency number formatter for the current locale.

Note: The returned instance is shared and must not be destructively modified.

Returns:

A default decimal number formatter for currency values.

See Also:

createCurrencyInstance()

getCurrencyInstance

@Deprecated
public static NumberFormat getCurrencyInstance(Locale locale)

Deprecated. This method ignores the numbers specification in the ULocale. Better use getCurrencyInstance(ULocale) instead.

Returns a currency number formatter for the given locale.

Note: The returned instance is shared and must not be destructively modified.

Returns:

A default decimal number formatter for currency values.

See Also:

createCurrencyInstance(Locale)

getCurrencyInstance

public static NumberFormat getCurrencyInstance(ULocale locale)

Returns a currency decimal number formatter for the given locale.

Note: The returned instance is shared and must not be destructively modified.

Returns:

A default decimal number formatter for currency values.

See Also:

createCurrencyInstance(ULocale)

getPercentInstance

public static NumberFormat getPercentInstance()

Returns a percentage number formatter for the current locale.

Note: The returned instance is shared and must not be destructively modified.

Returns:

A default decimal number formatter for values in percent notation.

See Also:

createPercentInstance()

getPercentInstance

@Deprecated
public static NumberFormat getPercentInstance(Locale locale)

Deprecated. This method ignores the numbers specification in the ULocale. Better use getPercentInstance(ULocale) instead.

Returns a percentage number formatter for the given locale.

Note: The returned instance is shared and must not be destructively modified.

Returns:

A default decimal number formatter for values in percent notation.

See Also:

createPercentInstance(Locale)

getPercentInstance

public static NumberFormat getPercentInstance(ULocale locale)

Returns a percentage number formatter for the given locale.

Note: The returned instance is shared and must not be destructively modified.

Returns:

A default decimal number formatter for values in percent notation.

See Also:

createInstance(ULocale)

getScientificInstance

public static NumberFormat getScientificInstance()

Returns a scientific decimal number formatter for the current locale.

Note: The returned instance is shared and must not be destructively modified.

Returns:

A default decimal number formatter for values in scientific notation.

See Also:

createScientificInstance()

getScientificInstance

@Deprecated
public static NumberFormat getScientificInstance(Locale locale)

Deprecated. This method ignores the numbers specification in the ULocale. Better use getScientificInstance(ULocale) instead.

Returns a scientific decimal number formatter for the given locale.

Note: The returned instance is shared and must not be destructively modified.

Returns:

A default decimal number formatter for values in scientific notation.

See Also:

createScientificInstance(Locale)

getScientificInstance

public static NumberFormat getScientificInstance(ULocale locale)

Returns a scientific decimal number formatter for the given locale.

Note: The returned instance is shared and must not be destructively modified.

Returns:

A default decimal number formatter for values in scientific notation.

See Also:

createScientificInstance(ULocale)

getInstance

public static DecimalFormat getInstance(String pattern)

Returns a decimal number formatter instance using the specified pattern for the current locale.

Note: The returned instance is shared and must not be destructively modified.

Note: This method ignores the number system specification in the current locale, if it specifies a number system that is not based on decimal digits. To fully obey the locale, please use the method getInstance() instead of this method.

Parameters:

pattern - A DecimalFormat compatible pattern.

Returns:

A pattern based decimal number formatter

Throws:

IllegalArgumentException - if the pattern is invalid.

See Also:

createInstance(String), getDefaultPattern(ULocale, int)

getInstance

@Deprecated
public static DecimalFormat getInstance(String pattern,
                                                    Locale locale)

Deprecated. This method ignores the numbers specification in the ULocale. Better use getInstance(String, ULocale) instead.

Returns a decimal number formatter instance using the specified pattern for the given locale.

Note: The returned instance is shared and must not be destructively modified.

Parameters:

pattern - A DecimalFormat compatible pattern.

locale - The locale or null for the current locale.

Returns:

A pattern based decimal number formatter

Throws:

IllegalArgumentException - if the pattern is invalid.

See Also:

createInstance(String, Locale), getDefaultPattern(ULocale, int)

getInstance

public static DecimalFormat getInstance(String pattern,
                                        ULocale locale)

Returns a decimal number formatter instance using the specified pattern for the given locale.

Note: The returned instance is shared and must not be destructively modified.

Note: This method ignores the number system specification in the locale, if it specifies a number system that is not based on decimal digits. To fully obey the locale, please use the method getInstance(ULocale) instead of this method.

Parameters:

pattern - A DecimalFormat compatible pattern.

locale - The locale or null for the current locale.

Returns:

A pattern based decimal number formatter

Throws:

IllegalArgumentException - if the pattern is invalid.

See Also:

createInstance(String, ULocale), getDefaultPattern(ULocale, int)

getDefaultPattern

public static String getDefaultPattern(ULocale locale,
                                       int choice)

Returns the default pattern if no specific pattern is given for the DecimalFormat. The style choices are:

• NUMBERSTYLE,
• CURRENCYSTYLE,
• PERCENTSTYLE,
• SCIENTIFICSTYLE,
• INTEGERSTYLE,
• ISOCURRENCYSTYLE,
• PLURALCURRENCYSTYLE.

The returned pattern can be used with createInstance(String, ULocale), createInstance(String, Locale), createInstance(String), getInstance(String, ULocale), getInstance(String, Locale), or getInstance(String), but it should not be used with DecimalFormat directly.

Parameters:

locale - The locale or null for the current locale.

choice - The style choices.

Returns:

The default pattern for this locale and style.

createInstance

public static NumberFormat createInstance()

Returns a freshly created default decimal number formatter for the current locale.

Returns:

A default decimal number formatter.

See Also:

getInstance()

createInstance

@Deprecated
public static NumberFormat createInstance(Locale locale)

Deprecated. This method ignores the numbers specification in the ULocale. Better use createInstance(ULocale) instead.

Returns a freshly created default decimal number formatter for the given locale.

Returns:

A default decimal number formatter.

See Also:

getInstance(Locale)

createInstance

public static NumberFormat createInstance(ULocale locale)

Returns a freshly created default decimal number formatter for the given locale.

Returns:

A default decimal number formatter.

See Also:

getInstance(ULocale)

createIntegerInstance

public static NumberFormat createIntegerInstance()

Returns a freshly created integer decimal number formatter for the current locale. It is configured to round floating point numbers to the nearest integer using IEEE half-even rounding for formatting, and to parse only the integer part of an input string.

Returns:

A default decimal number formatter for integers.

See Also:

getIntegerInstance()

createIntegerInstance

@Deprecated
public static NumberFormat createIntegerInstance(Locale locale)

Deprecated. This method ignores the numbers specification in the ULocale. Better use createIntegerInstance(ULocale) instead.

Returns a freshly created integer decimal number formatter for the given locale. It is configured to round floating point numbers to the nearest integer using IEEE half-even rounding for formatting, and to parse only the integer part of an input string.

Returns:

A default decimal number formatter for integers.

See Also:

getIntegerInstance(Locale)

createIntegerInstance

public static NumberFormat createIntegerInstance(ULocale locale)

Returns a freshly created integer decimal number formatter for the given locale. It is configured to round floating point numbers to the nearest integer using IEEE half-even rounding for formatting, and to parse only the integer part of an input string.

Returns:

A default decimal number formatter for integers.

See Also:

getIntegerInstance(ULocale)

createCurrencyInstance

public static NumberFormat createCurrencyInstance()

Returns a freshly created currency number formatter for the current locale.

Returns:

A default decimal number formatter for currency values.

See Also:

getCurrencyInstance()

createCurrencyInstance

@Deprecated
public static NumberFormat createCurrencyInstance(Locale locale)

Deprecated. This method ignores the numbers specification in the ULocale. Better use createCurrencyInstance(ULocale) instead.

Returns a freshly created currency number formatter for the given locale.

Returns:

A default decimal number formatter for currency values.

See Also:

getCurrencyInstance(Locale)

createCurrencyInstance

public static NumberFormat createCurrencyInstance(ULocale locale)

Returns a freshly created currency decimal number formatter for the given locale.

Returns:

A default decimal number formatter for currency values.

See Also:

getCurrencyInstance(ULocale)

createPercentInstance

public static NumberFormat createPercentInstance()

Returns a freshly created percentage number formatter for the current locale.

Returns:

A default decimal number formatter for values in percent notation.

See Also:

getPercentInstance()

createPercentInstance

@Deprecated
public static NumberFormat createPercentInstance(Locale locale)

Deprecated. This method ignores the numbers specification in the ULocale. Better use createPercentInstance(ULocale) instead.

Returns a freshly created percentage number formatter for the given locale.

Returns:

A default decimal number formatter for values in percent notation.

See Also:

getPercentInstance(Locale)

createPercentInstance

public static NumberFormat createPercentInstance(ULocale locale)

Returns a freshly created percentage number formatter for the given locale.

Returns:

A default decimal number formatter for values in percent notation.

See Also:

getInstance(ULocale)

createScientificInstance

public static NumberFormat createScientificInstance()

Returns a freshly created scientific decimal number formatter for the current locale.

Returns:

A default decimal number formatter for values in scientific notation.

See Also:

getScientificInstance()

createScientificInstance

@Deprecated
public static NumberFormat createScientificInstance(Locale locale)

Deprecated. This method ignores the numbers specification in the ULocale. Better use createScientificInstance(ULocale) instead.

Returns a freshly created scientific decimal number formatter for the given locale.

Returns:

A default decimal number formatter for values in scientific notation.

See Also:

getScientificInstance(Locale)

createScientificInstance

public static NumberFormat createScientificInstance(ULocale locale)

Returns a freshly created scientific decimal number formatter for the given locale.

Returns:

A default decimal number formatter for values in scientific notation.

See Also:

getScientificInstance(ULocale)

createInstance

public static DecimalFormat createInstance(String pattern)

Returns a freshly created decimal number formatter instance using the specified pattern for the current locale.

Note: This method ignores the number system specification in the current locale, if it specifies a number system that is not based on decimal digits. To fully obey the locale, please use the method createInstance() instead of this method.

Parameters:

pattern - A DecimalFormat compatible pattern.

Returns:

A pattern based decimal number formatter

Throws:

IllegalArgumentException - if the pattern is invalid.

See Also:

getInstance(String), getDefaultPattern(ULocale, int)

createInstance

@Deprecated
public static DecimalFormat createInstance(String pattern,
                                                       Locale locale)

Deprecated. This method ignores the numbers specification in the ULocale. Better use createInstance(String, ULocale) instead.

Returns a freshly created decimal number formatter instance using the specified pattern for the given locale.

Parameters:

pattern - A DecimalFormat compatible pattern.

locale - The locale or null for the current locale.

Returns:

A pattern based decimal number formatter

Throws:

IllegalArgumentException - if the pattern is invalid.

See Also:

getInstance(String, Locale), getDefaultPattern(ULocale, int)

createInstance

public static DecimalFormat createInstance(String pattern,
                                           ULocale locale)

Returns a freshly created decimal number formatter instance using the specified pattern for the given locale.

Note: This method ignores the number system specification in the locale, if it specifies a number system that is not based on decimal digits. To fully obey the locale, please use the method createInstance(ULocale) instead of this method.

Parameters:

pattern - A DecimalFormat compatible pattern.

locale - The locale or null for the current locale.

Returns:

A pattern based decimal number formatter

Throws:

IllegalArgumentException - if the pattern is invalid.

See Also:

getInstance(String, ULocale), getDefaultPattern(ULocale, int)