java.text
class DecimalFormatSymbols

java.lang.Object java.text.DecimalFormatSymbols

All Implemented Interfaces:

Serializable, Cloneable

Most common way to construct:

DecimalFormat decimalformat = …;

DecimalFormatSymbols decimalformatsymbols = decimalformat.getDecimalFormatSymbols();

Based on 41 examples

public class DecimalFormatSymbols
extends Object
implements Cloneable, Serializable

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.

DecimalFormatSymbols

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 {@link java.text.spi.DecimalFormatSymbolsProvider DecimalFormatSymbolsProvider} implementations. For full locale coverage, use the {@link #getInstance(Locale) getInstance} method.

DecimalFormatSymbols

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 {@link java.text.spi.DecimalFormatSymbolsProvider DecimalFormatSymbolsProvider} implementations. For full locale coverage, use the {@link #getInstance(Locale) getInstance} method.

Parameters:

locale

clone

public Object clone()

Standard override.

Overrides:

clone in class Object

equals

public boolean equals(Object obj)

Override equals.

Overrides:

equals in class Object

Parameters:

obj

getAvailableLocales

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 {@link java.text.spi.DecimalFormatSymbolsProvider DecimalFormatSymbolsProvider} implementations. It must contain at least a Locale instance equal to {@link java.util.Locale#US Locale.US}.

Returns:

An array of locales for which localized DecimalFormatSymbols instances are available.

getCurrency

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

getCurrencySymbol

public String getCurrencySymbol()

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

getDecimalSeparator

public char getDecimalSeparator()

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

getDigit

public char getDigit()

Gets the character used for a digit in a pattern.

getExponentSeparator

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

getGroupingSeparator

public char getGroupingSeparator()

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

getInfinity

public String getInfinity()

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

getInstance

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 {@link java.text.spi.DecimalFormatSymbolsProvider DecimalFormatSymbolsProvider} implementations.

Returns:

a DecimalFormatSymbols instance.

getInstance

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 {@link java.text.spi.DecimalFormatSymbolsProvider DecimalFormatSymbolsProvider} implementations.

Parameters:

locale - the desired locale.

Returns:

a DecimalFormatSymbols instance.

getInternationalCurrencySymbol

public String getInternationalCurrencySymbol()

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

getMinusSign

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.

getMonetaryDecimalSeparator

public char getMonetaryDecimalSeparator()

Returns the monetary decimal separator.

getNaN

public String getNaN()

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

getPatternSeparator

public char getPatternSeparator()

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

getPercent

public char getPercent()

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

getPerMill

public char getPerMill()

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

getZeroDigit

public char getZeroDigit()

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

hashCode

public int hashCode()

Override hashCode.

Overrides:

hashCode in class Object

setCurrency

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

setCurrencySymbol

public void setCurrencySymbol(String currency)

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

Parameters:

currency

setDecimalSeparator

public void setDecimalSeparator(char decimalSeparator)

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

Parameters:

decimalSeparator

setDigit

public void setDigit(char digit)

Sets the character used for a digit in a pattern.

Parameters:

digit

setExponentSeparator

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

setGroupingSeparator

public void setGroupingSeparator(char groupingSeparator)

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

Parameters:

groupingSeparator

setInfinity

public void setInfinity(String infinity)

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

Parameters:

infinity

setInternationalCurrencySymbol

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 {@link java.util.Currency#getInstance(java.lang.String) 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

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.

Parameters:

minusSign

setMonetaryDecimalSeparator

public void setMonetaryDecimalSeparator(char sep)

Sets the monetary decimal separator.

Parameters:

sep

setNaN

public void setNaN(String NaN)

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

Parameters:

NaN

setPatternSeparator

public void setPatternSeparator(char patternSeparator)

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

Parameters:

patternSeparator

setPercent

public void setPercent(char percent)

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

Parameters:

percent

setPerMill

public void setPerMill(char perMill)

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

Parameters:

perMill

setZeroDigit

public void setZeroDigit(char zeroDigit)

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

Parameters:

zeroDigit