public class

DecimalFormatSymbols

extends Object
implements Serializable Cloneable
java.lang.Object
   ↳ java.text.DecimalFormatSymbols

Class Overview

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.
final static DecimalFormatSymbols getInstance(Locale locale)
Gets the DecimalFormatSymbols instance for the specified locale.
final static DecimalFormatSymbols getInstance()
Gets the DecimalFormatSymbols instance for the default 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.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public 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.

public 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.

Throws
NullPointerException if locale is null

Public Methods

public Object clone ()

Standard override.

Returns
  • a clone of this instance.

public boolean equals (Object obj)

Override equals.

Parameters
obj the reference object with which to compare.
Returns
  • true if this object is the same as the obj argument; false otherwise.

public static 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
  • An array of locales for which localized DecimalFormatSymbols instances are available.

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
  • the currency used, or null

public String getCurrencySymbol ()

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

public char getDecimalSeparator ()

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

public char getDigit ()

Gets the character used for a digit in a pattern.

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
  • the exponent separator string
See Also

public char getGroupingSeparator ()

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

public String getInfinity ()

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

public static final 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 the desired locale.
Returns
  • a DecimalFormatSymbols instance.
Throws
NullPointerException if locale is null

public static final 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
  • a DecimalFormatSymbols instance.

public String getInternationalCurrencySymbol ()

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

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.

public char getMonetaryDecimalSeparator ()

Returns the monetary decimal separator.

public String getNaN ()

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

public char getPatternSeparator ()

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

public char getPerMill ()

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

public char getPercent ()

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

public char getZeroDigit ()

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

public int hashCode ()

Override hashCode.

Returns
  • a hash code value for this object.

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 the new currency to be used
Throws
NullPointerException if currency is null
See Also

public void setCurrencySymbol (String currency)

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

public void setDecimalSeparator (char decimalSeparator)

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

public void setDigit (char digit)

Sets the character used for a digit in a pattern.

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 the exponent separator string
Throws
NullPointerException if exp is null
See Also

public void setGroupingSeparator (char groupingSeparator)

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

public void setInfinity (String infinity)

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

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.

See Also

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.

public void setMonetaryDecimalSeparator (char sep)

Sets the monetary decimal separator.

public void setNaN (String NaN)

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

public void setPatternSeparator (char patternSeparator)

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

public void setPerMill (char perMill)

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

public void setPercent (char percent)

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

public void setZeroDigit (char zeroDigit)

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