Added in API level 1

Summary: Ctors | Methods | Inherited Methods

DecimalFormatSymbols

public class DecimalFormatSymbols
extends Object implements Cloneable, Serializable

java.lang.Object
↳	java.text.DecimalFormatSymbols

This class represents the set of symbols (such as the decimal separator, the grouping separator, and so on) needed by DecimalFormat to format numbers. DecimalFormat creates for itself an instance of DecimalFormatSymbols from its locale data. If you need to change any of these symbols, you can get the DecimalFormatSymbols object from your DecimalFormat and modify it.

See also:

Locale
DecimalFormat

Summary

Public constructors
`DecimalFormatSymbols()` Create a DecimalFormatSymbols object for the default `FORMAT` locale.
`DecimalFormatSymbols(Locale locale)` Create a DecimalFormatSymbols object for the given locale.

Public methods
`Object`	`clone()` Standard override.
`boolean`	`equals(Object obj)` Override equals.
`static Locale[]`	`getAvailableLocales()` Returns an array of all locales for which the `getInstance` methods of this class can return localized instances.
`Currency`	`getCurrency()` Gets the currency of these DecimalFormatSymbols.
`String`	`getCurrencySymbol()` Returns the currency symbol for the currency of these DecimalFormatSymbols in their locale.
`char`	`getDecimalSeparator()` Gets the character used for decimal sign.
`char`	`getDigit()` Gets the character used for a digit in a pattern.
`String`	`getExponentSeparator()` Returns the string used to separate the mantissa from the exponent.
`char`	`getGroupingSeparator()` Gets the character used for grouping separator.
`String`	`getInfinity()` Gets the string used to represent infinity.
`static final DecimalFormatSymbols`	`getInstance()` Gets the `DecimalFormatSymbols` instance for the default locale.
`static final DecimalFormatSymbols`	`getInstance(Locale locale)` Gets the `DecimalFormatSymbols` instance for the specified locale.
`String`	`getInternationalCurrencySymbol()` Returns the ISO 4217 currency code of the currency of these DecimalFormatSymbols.
`char`	`getMinusSign()` Gets the character used to represent minus sign.
`char`	`getMonetaryDecimalSeparator()` Returns the monetary decimal separator.
`char`	`getMonetaryGroupingSeparator()` Gets the character used for grouping separator for currencies.
`String`	`getNaN()` Gets the string used to represent "not a number".
`char`	`getPatternSeparator()` Gets the character used to separate positive and negative subpatterns in a pattern.
`char`	`getPerMill()` Gets the character used for per mille sign.
`char`	`getPercent()` Gets the character used for percent sign.
`char`	`getZeroDigit()` Gets the character used for zero.
`int`	`hashCode()` Override hashCode.
`void`	`setCurrency(Currency currency)` Sets the currency of these DecimalFormatSymbols.
`void`	`setCurrencySymbol(String currency)` Sets the currency symbol for the currency of these DecimalFormatSymbols in their locale.
`void`	`setDecimalSeparator(char decimalSeparator)` Sets the character used for decimal sign.
`void`	`setDigit(char digit)` Sets the character used for a digit in a pattern.
`void`	`setExponentSeparator(String exp)` Sets the string used to separate the mantissa from the exponent.
`void`	`setGroupingSeparator(char groupingSeparator)` Sets the character used for grouping separator.
`void`	`setInfinity(String infinity)` Sets the string used to represent infinity.
`void`	`setInternationalCurrencySymbol(String currencyCode)` Sets the ISO 4217 currency code of the currency of these DecimalFormatSymbols.
`void`	`setMinusSign(char minusSign)` Sets the character used to represent minus sign.
`void`	`setMonetaryDecimalSeparator(char sep)` Sets the monetary decimal separator.
`void`	`setMonetaryGroupingSeparator(char monetaryGroupingSeparator)` Sets the character used for grouping separator for currencies.
`void`	`setNaN(String NaN)` Sets the string used to represent "not a number".
`void`	`setPatternSeparator(char patternSeparator)` Sets the character used to separate positive and negative subpatterns in a pattern.
`void`	`setPerMill(char perMill)` Sets the character used for per mille sign.
`void`	`setPercent(char percent)` Sets the character used for percent sign.
`void`	`setZeroDigit(char zeroDigit)` Sets the character used for zero.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

DecimalFormatSymbols

Added in API level 1

public DecimalFormatSymbols ()

Create a DecimalFormatSymbols object for the default FORMAT locale. It is recommended that the getInstance method is used instead.

This is equivalent to calling DecimalFormatSymbols(Locale.getDefault(Locale.Category.FORMAT)).

See also:

DecimalFormatSymbols

Added in API level 1

public DecimalFormatSymbols (Locale locale)

Create a DecimalFormatSymbols object for the given locale. It is recommended that the getInstance method is used instead. If the specified locale contains the Locale.UNICODE_LOCALE_EXTENSION for the numbering system, the instance is initialized with the specified numbering system if the JRE implementation supports it. For example,

 NumberFormat.getNumberInstance(Locale.forLanguageTag("th-TH-u-nu-thai"))

This may return a NumberFormat instance with the Thai numbering system, instead of the Latin numbering system.

Parameters
`locale`	`Locale`: the desired locale

Throws
`NullPointerException`	if `locale` is null

Public methods

clone

Added in API level 1

public Object clone ()

Standard override.

Returns
`Object`	a clone of this instance.

equals

Added in API level 1

public boolean equals (Object obj)

Override equals.

Parameters
`obj`	`Object`: the reference object with which to compare.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getAvailableLocales

Added in API level 9

public static Locale[] getAvailableLocales ()

Returns an array of all locales for which the getInstance methods of this class can return localized instances. It must contain at least a Locale instance equal to Locale.US.

Returns
`Locale[]`	an array of locales for which localized `DecimalFormatSymbols` instances are available.

getCurrency

Added in API level 1

public Currency getCurrency ()

Gets the currency of these DecimalFormatSymbols. May be null if the currency symbol attribute was previously set to a value that's not a valid ISO 4217 currency code.

Returns
`Currency`	the currency used, or null

getCurrencySymbol

Added in API level 1

public String getCurrencySymbol ()

Returns the currency symbol for the currency of these DecimalFormatSymbols in their locale.

Returns
`String`	the currency symbol

getDecimalSeparator

Added in API level 1

public char getDecimalSeparator ()

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

Returns
`char`	the character used for decimal sign

getDigit

Added in API level 1

public char getDigit ()

Gets the character used for a digit in a pattern.

Returns
`char`	the character used for a digit in a pattern

getExponentSeparator

Added in API level 9

public String getExponentSeparator ()

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

Returns
`String`	the exponent separator string

See also:

setExponentSeparator(java.lang.String)

getGroupingSeparator

Added in API level 1

public char getGroupingSeparator ()

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

Returns
`char`	the grouping separator

getInfinity

Added in API level 1

public String getInfinity ()

Gets the string used to represent infinity. Almost always left unchanged.

Returns
`String`	the string representing infinity

getInstance

Added in API level 9

public static final DecimalFormatSymbols getInstance ()

Gets the DecimalFormatSymbols instance for the default locale.

This is equivalent to calling getInstance(Locale.getDefault(Locale.Category.FORMAT)).

Returns
`DecimalFormatSymbols`	a `DecimalFormatSymbols` instance.

See also:

getInstance

Added in API level 9

public static final DecimalFormatSymbols getInstance (Locale locale)

Gets the DecimalFormatSymbols instance for the specified locale. If the specified locale contains the Locale.UNICODE_LOCALE_EXTENSION for the numbering system, the instance is initialized with the specified numbering system if the JRE implementation supports it. For example,

 NumberFormat.getNumberInstance(Locale.forLanguageTag("th-TH-u-nu-thai"))

This may return a NumberFormat instance with the Thai numbering system, instead of the Latin numbering system.

Parameters
`locale`	`Locale`: the desired locale.

Returns
`DecimalFormatSymbols`	a `DecimalFormatSymbols` instance.

Throws
`NullPointerException`	if `locale` is null

getInternationalCurrencySymbol

Added in API level 1

public String getInternationalCurrencySymbol ()

Returns the ISO 4217 currency code of the currency of these DecimalFormatSymbols.

Returns
`String`	the currency code

getMinusSign

Added in API level 1

public char getMinusSign ()

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

Returns
`char`	the character representing minus sign

getMonetaryDecimalSeparator

Added in API level 1

public char getMonetaryDecimalSeparator ()

Returns the monetary decimal separator.

Returns
`char`	the monetary decimal separator

getMonetaryGroupingSeparator

Added in API level 34

public char getMonetaryGroupingSeparator ()

Gets the character used for grouping separator for currencies. May be different from grouping separator in some locales, e.g, German in Austria.

Returns
`char`	the monetary grouping separator

getNaN

Added in API level 1

public String getNaN ()

Gets the string used to represent "not a number". Almost always left unchanged.

Returns
`String`	the string representing "not a number"

getPatternSeparator

Added in API level 1

public char getPatternSeparator ()

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

Returns
`char`	the pattern separator

getPerMill

Added in API level 1

public char getPerMill ()

Gets the character used for per mille sign. Different for Arabic, etc.

Returns
`char`	the character used for per mille sign

getPercent

Added in API level 1

public char getPercent ()

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

Returns
`char`	the character used for percent sign

getZeroDigit

Added in API level 1

public char getZeroDigit ()

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

Returns
`char`	the character used for zero

hashCode

Added in API level 1

public int hashCode ()

Override hashCode.

Returns
`int`	a hash code value for this object.

setCurrency

Added in API level 1

public void setCurrency (Currency currency)

Sets the currency of these DecimalFormatSymbols. 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.

Parameters
`currency`	`Currency`: the new currency to be used

Throws
`NullPointerException`	if `currency` is null

See also:

setCurrencySymbol

Added in API level 1

public void setCurrencySymbol (String currency)

Sets the currency symbol for the currency of these DecimalFormatSymbols in their locale.

Parameters
`currency`	`String`: the currency symbol

setDecimalSeparator

Added in API level 1

public void setDecimalSeparator (char decimalSeparator)

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

Parameters
`decimalSeparator`	`char`: the character used for decimal sign

setDigit

Added in API level 1

public void setDigit (char digit)

Sets the character used for a digit in a pattern.

Parameters
`digit`	`char`: the character used for a digit in a pattern

setExponentSeparator

Added in API level 9

public void setExponentSeparator (String exp)

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

Parameters
`exp`	`String`: the exponent separator string

Throws
`NullPointerException`	if `exp` is null

See also:

getExponentSeparator()

setGroupingSeparator

Added in API level 1

public void setGroupingSeparator (char groupingSeparator)

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

Parameters
`groupingSeparator`	`char`: the grouping separator

setInfinity

Added in API level 1

public void setInfinity (String infinity)

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

Parameters
`infinity`	`String`: the string representing infinity

setInternationalCurrencySymbol

Added in API level 1

public void setInternationalCurrencySymbol (String currencyCode)

Sets the ISO 4217 currency code of the currency of these DecimalFormatSymbols. If the currency code is valid (as defined by Currency.getInstance), this also sets the currency attribute to the corresponding Currency instance and the currency symbol attribute to the currency's symbol in the DecimalFormatSymbols' locale. If the currency code is not valid, then the currency attribute is set to null and the currency symbol attribute is not modified.

Parameters
`currencyCode`	`String`: the currency code

See also:

setMinusSign

Added in API level 1

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.

Parameters
`minusSign`	`char`: the character representing minus sign

setMonetaryDecimalSeparator

Added in API level 1

public void setMonetaryDecimalSeparator (char sep)

Sets the monetary decimal separator.

Parameters
`sep`	`char`: the monetary decimal separator

setMonetaryGroupingSeparator

Added in API level 34

public void setMonetaryGroupingSeparator (char monetaryGroupingSeparator)

Sets the character used for grouping separator for currencies. Invocation of this method will not affect the normal grouping separator.

Parameters
`monetaryGroupingSeparator`	`char`: the monetary grouping separator

See also:

setGroupingSeparator(char)

setNaN

Added in API level 1

public void setNaN (String NaN)

Sets the string used to represent "not a number". Almost always left unchanged.

Parameters
`NaN`	`String`: the string representing "not a number"

setPatternSeparator

Added in API level 1

public void setPatternSeparator (char patternSeparator)

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

Parameters
`patternSeparator`	`char`: the pattern separator

setPerMill

Added in API level 1

public void setPerMill (char perMill)

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

Parameters
`perMill`	`char`: the character used for per mille sign

setPercent

Added in API level 1

public void setPercent (char percent)

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

Parameters
`percent`	`char`: the character used for percent sign

setZeroDigit

Added in API level 1

public void setZeroDigit (char zeroDigit)

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

Parameters
`zeroDigit`	`char`: the character used for zero