DecimalFormatSymbols

See also:

• Locale
• DecimalFormat

CURRENCY_SPC_CURRENCY_MATCH

public static final int CURRENCY_SPC_CURRENCY_MATCH

[icu] Indicates the currency match pattern used in getPatternForCurrencySpacing(int, boolean).

Constant Value: 0 (0x00000000)

CURRENCY_SPC_INSERT

public static final int CURRENCY_SPC_INSERT

[icu] Indicates the insertion value used in getPatternForCurrencySpacing(int, boolean).

Constant Value: 2 (0x00000002)

CURRENCY_SPC_SURROUNDING_MATCH

public static final int CURRENCY_SPC_SURROUNDING_MATCH

[icu] Indicates the surrounding match pattern used in getPatternForCurrencySpacing(int, boolean).

Constant Value: 1 (0x00000001)

DecimalFormatSymbols

public DecimalFormatSymbols ()

Creates a DecimalFormatSymbols object for the default FORMAT locale.

DecimalFormatSymbols

public DecimalFormatSymbols (Locale locale)

Creates a DecimalFormatSymbols object for the given locale.

DecimalFormatSymbols

public DecimalFormatSymbols (ULocale locale)

[icu] Creates a DecimalFormatSymbols object for the given locale.

clone

public Object clone ()

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x

 x.clone().getClass() == x.getClass()

 x.clone().equals(x)

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

equals

public boolean equals (Object obj)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

forNumberingSystem

public static DecimalFormatSymbols forNumberingSystem (ULocale locale, 
                NumberingSystem ns)

[icu] Returns a DecimalFormatSymbols instance for the given locale with digits and symbols corresponding to the given NumberingSystem.

This method behaves equivalently to getInstance() called with a locale having a "numbers=xxxx" keyword specifying the numbering system by name.

In this method, the NumberingSystem argument will be used even if the locale has its own "numbers=xxxx" keyword.

forNumberingSystem

public static DecimalFormatSymbols forNumberingSystem (Locale locale, 
                NumberingSystem ns)

[icu] Returns a DecimalFormatSymbols instance for the given locale with digits and symbols corresponding to the given NumberingSystem.

This method behaves equivalently to getInstance() called with a locale having a "numbers=xxxx" keyword specifying the numbering system by name.

In this method, the NumberingSystem argument will be used even if the locale has its own "numbers=xxxx" keyword.

getAvailableLocales

public static Locale[] getAvailableLocales ()

Returns an array of all locales for which the getInstance methods of this class can return localized instances.

Note: Unlike java.text.DecimalFormatSymbols#getAvailableLocales, this method simply returns the array of Locales available for this class. ICU currently does not support DecimalFormatSymbolsProvider, which was introduced in Java 6.

getAvailableULocales

public static ULocale[] getAvailableULocales ()

[icu] Returns an array of all locales for which the getInstance methods of this class can return localized instances.

Note: Unlike java.text.DecimalFormatSymbols#getAvailableLocales, this method simply returns the array of ULocales available in this class. ICU currently does not support DecimalFormatSymbolsProvider, which was introduced in Java 6.

getCurrency

public Currency getCurrency ()

Returns the currency symbol, for DecimalFormatSymbols#getCurrency() API compatibility only. ICU clients should use the Currency API directly.

getCurrencySymbol

public String getCurrencySymbol ()

Returns the string denoting the local currency.

getDecimalSeparator

public char getDecimalSeparator ()

Returns the character used for decimal sign. Different for French, etc.

getDecimalSeparatorString

public String getDecimalSeparatorString ()

[icu] Returns the string used for decimal sign.

getDigit

public char getDigit ()

Returns the character used for a digit in a pattern.

getDigitStrings

public String[] getDigitStrings ()

[icu] Returns the array of strings used as digits, in order from 0 through 9

getDigits

public char[] getDigits ()

Returns the array of characters used as digits, in order from 0 through 9

getExponentMultiplicationSign

public String getExponentMultiplicationSign ()

Returns the multiplication sign

getExponentSeparator

public String getExponentSeparator ()

[icu] Returns the string used to separate the mantissa from the exponent. Examples: "x10^" for 1.23x10^4, "E" for 1.23E4.

getGroupingSeparator

public char getGroupingSeparator ()

Returns the character used for grouping separator. Different for French, etc.

getGroupingSeparatorString

public String getGroupingSeparatorString ()

[icu] Returns the string used for grouping separator. Different for French, etc.

getInfinity

public String getInfinity ()

Returns the String used to represent infinity. Almost always left unchanged.

getInstance

public static DecimalFormatSymbols getInstance ()

Returns a DecimalFormatSymbols instance for the default locale.

Note: Unlike java.text.DecimalFormatSymbols#getInstance, this method simply returns new android.icu.text.DecimalFormatSymbols(). ICU currently does not support DecimalFormatSymbolsProvider, which was introduced in Java 6.

getInstance

public static DecimalFormatSymbols getInstance (Locale locale)

Returns a DecimalFormatSymbols instance for the given locale.

Note: Unlike java.text.DecimalFormatSymbols#getInstance, this method simply returns new android.icu.text.DecimalFormatSymbols(locale). ICU currently does not support DecimalFormatSymbolsProvider, which was introduced in Java 6.

getInstance

public static DecimalFormatSymbols getInstance (ULocale locale)

Returns a DecimalFormatSymbols instance for the given locale.

Note: Unlike java.text.DecimalFormatSymbols#getInstance, this method simply returns new android.icu.text.DecimalFormatSymbols(locale). ICU currently does not support DecimalFormatSymbolsProvider, which was introduced in Java 6.

getInternationalCurrencySymbol

public String getInternationalCurrencySymbol ()

Returns the international string denoting the local currency.

getLocale

public Locale getLocale ()

Returns the locale for which this object was constructed.

getMinusSign

public char getMinusSign ()

Returns the character used to represent minus sign. If no explicit negative format is specified, one is formed by prefixing minusSign to the positive format.

getMinusSignString

public String getMinusSignString ()

[icu] Returns the string used to represent minus sign.

getMonetaryDecimalSeparator

public char getMonetaryDecimalSeparator ()

Returns the monetary decimal separator.

getMonetaryDecimalSeparatorString

public String getMonetaryDecimalSeparatorString ()

[icu] Returns the monetary decimal separator string.

getMonetaryGroupingSeparator

public char getMonetaryGroupingSeparator ()

[icu] Returns the monetary grouping separator.

getMonetaryGroupingSeparatorString

public String getMonetaryGroupingSeparatorString ()

[icu] Returns the monetary grouping separator.

getNaN

public String getNaN ()

Returns the String used to represent NaN. Almost always left unchanged.

getPadEscape

public char getPadEscape ()

[icu] Returns the character used to pad numbers out to a specified width. This is not the pad character itself; rather, it is the special pattern character preceding the pad character. In the pattern "*_#,##0", '*' is the pad escape, and '_' is the pad character.

getPatternForCurrencySpacing

public String getPatternForCurrencySpacing (int itemType, 
                boolean beforeCurrency)

[icu] Returns the desired currency spacing value. Original values come from ICU's CLDR data based on the locale provided during construction, and can be null. These values govern what and when text is inserted between a currency code/name/symbol and the currency amount when formatting money.

For more information, see UTS#35 section 5.10.2.

getPatternSeparator

public char getPatternSeparator ()

Returns the character used to separate positive and negative subpatterns in a pattern.

getPerMill

public char getPerMill ()

Returns the character used for mille percent sign. Different for Arabic, etc.

getPerMillString

public String getPerMillString ()

[icu] Returns the string used for permille sign.

getPercent

public char getPercent ()

Returns the character used for percent sign. Different for Arabic, etc.

getPercentString

public String getPercentString ()

[icu] Returns the string used for percent sign.

getPlusSign

public char getPlusSign ()

[icu] Returns the localized plus sign.

getPlusSignString

public String getPlusSignString ()

[icu] Returns the string used to represent plus sign.

getSignificantDigit

public char getSignificantDigit ()

Returns the character used to represent a significant digit in a pattern.

getULocale

public ULocale getULocale ()

Returns the locale for which this object was constructed.

getZeroDigit

public char getZeroDigit ()

Returns the character used for zero. Different for Arabic, etc.

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

setCurrency

public void setCurrency (Currency currency)

Sets the currency.

Note: ICU does not use the DecimalFormatSymbols for the currency any more. This API is present for API compatibility only.

This also sets the currency symbol attribute to the currency's symbol in the DecimalFormatSymbols' locale, and the international currency symbol attribute to the currency's ISO 4217 currency code.

setCurrencySymbol

public void setCurrencySymbol (String currency)

Sets the string denoting the local currency.

setDecimalSeparator

public void setDecimalSeparator (char decimalSeparator)

Sets the character used for decimal sign. Different for French, etc.

setDecimalSeparatorString

public void setDecimalSeparatorString (String decimalSeparatorString)

[icu] Sets the string used for decimal sign.

Note: When the input decimal separator String is represented by multiple Java chars, then getDecimalSeparator() will return the default decimal separator character ('.').

setDigit

public void setDigit (char digit)

Sets the character used for a digit in a pattern.

setDigitStrings

public void setDigitStrings (String[] digitStrings)

[icu] Sets the array of strings used as digits, in order from 0 through 9

Note:

When the input array of digit strings contains any strings represented by multiple Java chars, then getDigits() will return the default digits ('0' - '9') and getZeroDigit() will return the default zero digit ('0').

setExponentMultiplicationSign

public void setExponentMultiplicationSign (String exponentMultiplicationSign)

Sets the multiplication sign

setExponentSeparator

public void setExponentSeparator (String exp)

[icu] Sets the string used to separate the mantissa from the exponent. Examples: "x10^" for 1.23x10^4, "E" for 1.23E4.

setGroupingSeparator

public void setGroupingSeparator (char groupingSeparator)

Sets the character used for grouping separator. Different for French, etc.

setGroupingSeparatorString

public void setGroupingSeparatorString (String groupingSeparatorString)

[icu] Sets the string used for grouping separator.

Note: When the input grouping separator String is represented by multiple Java chars, then getGroupingSeparator() will return the default grouping separator character (',').

setInfinity

public void setInfinity (String infinity)

Sets the String used to represent infinity. Almost always left unchanged.

setInternationalCurrencySymbol

public void setInternationalCurrencySymbol (String currency)

Sets the international string denoting the local currency.

setMinusSign

public void setMinusSign (char minusSign)

Sets the character used to represent minus sign. If no explicit negative format is specified, one is formed by prefixing minusSign to the positive format.

setMinusSignString

public void setMinusSignString (String minusSignString)

[icu] Sets the string used to represent minus sign.

Note: When the input minus sign String is represented by multiple Java chars, then getMinusSign() will return the default minus sign character ('-').

setMonetaryDecimalSeparator

public void setMonetaryDecimalSeparator (char sep)

Sets the monetary decimal separator.

setMonetaryDecimalSeparatorString

public void setMonetaryDecimalSeparatorString (String sep)

[icu] Sets the monetary decimal separator string.

Note: When the input monetary decimal separator String is represented by multiple Java chars, then getMonetaryDecimalSeparatorString() will return the default monetary decimal separator character ('.').

setMonetaryGroupingSeparator

public void setMonetaryGroupingSeparator (char sep)

[icu] Sets the monetary grouping separator.

setMonetaryGroupingSeparatorString

public void setMonetaryGroupingSeparatorString (String sep)

[icu] Sets the monetary grouping separator string.

Note: When the input grouping separator String is represented by multiple Java chars, then getMonetaryGroupingSeparator() will return the default monetary grouping separator character (',').

setNaN

public void setNaN (String NaN)

Sets the String used to represent NaN. Almost always left unchanged.

setPadEscape

public void setPadEscape (char c)

[icu] Sets the character used to pad numbers out to a specified width. This is not the pad character itself; rather, it is the special pattern character preceding the pad character. In the pattern "*_#,##0", '*' is the pad escape, and '_' is the pad character.

setPatternForCurrencySpacing

public void setPatternForCurrencySpacing (int itemType, 
                boolean beforeCurrency, 
                String pattern)

[icu] Sets the indicated currency spacing pattern or value. See getPatternForCurrencySpacing(int, boolean) for more information.

Values for currency match and surrounding match must be UnicodeSet patterns. Values for insert can be any string.

Note: ICU4J does not currently use this information.

setPatternSeparator

public void setPatternSeparator (char patternSeparator)

Sets the character used to separate positive and negative subpatterns in a pattern.

setPerMill

public void setPerMill (char perMill)

Sets the character used for mille percent sign. Different for Arabic, etc.

setPerMillString

public void setPerMillString (String perMillString)

[icu] Sets the string used for permille sign.

Note: When the input permille String is represented by multiple Java chars, then getPerMill() will return the default permille character ('‰').

setPercent

public void setPercent (char percent)

Sets the character used for percent sign. Different for Arabic, etc.

setPercentString

public void setPercentString (String percentString)

[icu] Sets the string used for percent sign.

Note: When the input grouping separator String is represented by multiple Java chars, then getPercent() will return the default percent sign character ('%').

setPlusSign

public void setPlusSign (char plus)

[icu] Sets the localized plus sign.

setPlusSignString

public void setPlusSignString (String plusSignString)

[icu] Sets the localized plus sign string.

Note: When the input plus sign String is represented by multiple Java chars, then getPlusSign() will return the default plus sign character ('+').

setSignificantDigit

public void setSignificantDigit (char sigDigit)

Sets the character used to represent a significant digit in a pattern.

setZeroDigit

public void setZeroDigit (char zeroDigit)

Sets the character used for zero.

Note: This method propagates digit 1 to digit 9 by incrementing code point one by one.