Skip to content

Most visited

Recently visited

navigation
Added in API level 1

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:

Summary

Public constructors

DecimalFormatSymbols()

Create a DecimalFormatSymbols object for the default 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 thousands 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.

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 thousands 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 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

Public constructors

DecimalFormatSymbols

Added in API level 1
DecimalFormatSymbols ()

Create a DecimalFormatSymbols object for the default locale. This constructor can only construct instances for the locales supported by the Java runtime environment, not for those supported by installed DecimalFormatSymbolsProvider implementations. For full locale coverage, use the getInstance method.

DecimalFormatSymbols

Added in API level 1
DecimalFormatSymbols (Locale locale)

Create a DecimalFormatSymbols object for the given locale. This constructor can only construct instances for the locales supported by the Java runtime environment, not for those supported by installed DecimalFormatSymbolsProvider implementations. For full locale coverage, use the getInstance method.

Parameters
locale Locale
Throws
NullPointerException if locale is null

Public methods

clone

Added in API level 1
Object clone ()

Standard override.

Returns
Object a clone of this instance.

equals

Added in API level 1
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
Locale[] getAvailableLocales ()

Returns an array of all locales for which the getInstance methods of this class can return localized instances. The returned array represents the union of locales supported by the Java runtime and by installed DecimalFormatSymbolsProvider implementations. 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
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
String getCurrencySymbol ()

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

Returns
String

getDecimalSeparator

Added in API level 1
char getDecimalSeparator ()

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

Returns
char

getDigit

Added in API level 1
char getDigit ()

Gets the character used for a digit in a pattern.

Returns
char

getExponentSeparator

Added in API level 9
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:

getGroupingSeparator

Added in API level 1
char getGroupingSeparator ()

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

Returns
char

getInfinity

Added in API level 1
String getInfinity ()

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

Returns
String

getInstance

Added in API level 9
DecimalFormatSymbols getInstance ()

Gets the DecimalFormatSymbols instance for the default locale. This method provides access to DecimalFormatSymbols instances for locales supported by the Java runtime itself as well as for those supported by installed DecimalFormatSymbolsProvider implementations.

Returns
DecimalFormatSymbols a DecimalFormatSymbols instance.

getInstance

Added in API level 9
DecimalFormatSymbols getInstance (Locale locale)

Gets the DecimalFormatSymbols instance for the specified locale. This method provides access to DecimalFormatSymbols instances for locales supported by the Java runtime itself as well as for those supported by installed DecimalFormatSymbolsProvider implementations.

Parameters
locale Locale: the desired locale.
Returns
DecimalFormatSymbols a DecimalFormatSymbols instance.
Throws
NullPointerException if locale is null

getInternationalCurrencySymbol

Added in API level 1
String getInternationalCurrencySymbol ()

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

Returns
String

getMinusSign

Added in API level 1
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

getMonetaryDecimalSeparator

Added in API level 1
char getMonetaryDecimalSeparator ()

Returns the monetary decimal separator.

Returns
char

getNaN

Added in API level 1
String getNaN ()

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

Returns
String

getPatternSeparator

Added in API level 1
char getPatternSeparator ()

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

Returns
char

getPerMill

Added in API level 1
char getPerMill ()

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

Returns
char

getPercent

Added in API level 1
char getPercent ()

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

Returns
char

getZeroDigit

Added in API level 1
char getZeroDigit ()

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

Returns
char

hashCode

Added in API level 1
int hashCode ()

Override hashCode.

Returns
int a hash code value for this object.

setCurrency

Added in API level 1
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
void setCurrencySymbol (String currency)

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

Parameters
currency String

setDecimalSeparator

Added in API level 1
void setDecimalSeparator (char decimalSeparator)

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

Parameters
decimalSeparator char

setDigit

Added in API level 1
void setDigit (char digit)

Sets the character used for a digit in a pattern.

Parameters
digit char

setExponentSeparator

Added in API level 9
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:

setGroupingSeparator

Added in API level 1
void setGroupingSeparator (char groupingSeparator)

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

Parameters
groupingSeparator char

setInfinity

Added in API level 1
void setInfinity (String infinity)

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

Parameters
infinity String

setInternationalCurrencySymbol

Added in API level 1
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

See also:

setMinusSign

Added in API level 1
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

setMonetaryDecimalSeparator

Added in API level 1
void setMonetaryDecimalSeparator (char sep)

Sets the monetary decimal separator.

Parameters
sep char

setNaN

Added in API level 1
void setNaN (String NaN)

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

Parameters
NaN String

setPatternSeparator

Added in API level 1
void setPatternSeparator (char patternSeparator)

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

Parameters
patternSeparator char

setPerMill

Added in API level 1
void setPerMill (char perMill)

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

Parameters
perMill char

setPercent

Added in API level 1
void setPercent (char percent)

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

Parameters
percent char

setZeroDigit

Added in API level 1
void setZeroDigit (char zeroDigit)

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

Parameters
zeroDigit char
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.