Class DecimalFormatSymbols
java.lang.Object
java.text.DecimalFormatSymbols
- All Implemented Interfaces:
- Serializable,- Cloneable
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.
 If the locale contains "rg" (region override) Unicode extension, the symbols are overridden for the designated region.
- Since:
- 1.1
- See Also:
- 
Constructor SummaryConstructorsConstructorDescriptionCreate a DecimalFormatSymbols object for the defaultFORMATlocale.DecimalFormatSymbols(Locale locale) Create a DecimalFormatSymbols object for the given locale.
- 
Method SummaryModifier and TypeMethodDescriptionclone()Standard override.booleanCompares the specified object with thisDecimalFormatSymbolsfor equality.static Locale[]Returns an array of all locales for which thegetInstancemethods of this class can return localized instances.Returns theCurrencyof thisDecimalFormatSymbols.Returns the currency symbol for the currency of these DecimalFormatSymbols in their locale.charGets the character used for decimal sign.chargetDigit()Gets the character used for a digit in a pattern.Returns the string used to separate the mantissa from the exponent.charGets the character used for grouping separator.Gets the string used to represent infinity.static final DecimalFormatSymbolsGets theDecimalFormatSymbolsinstance for the default locale.static final DecimalFormatSymbolsgetInstance(Locale locale) Gets theDecimalFormatSymbolsinstance for the specified locale.Returns the ISO 4217 currency code of the currency of these DecimalFormatSymbols.Returns locale used to create this instance.charGets the character used to represent minus sign.charReturns the monetary decimal separator.charGets the character used for grouping separator for currencies.getNaN()Gets the string used to represent "not a number".charGets the character used to separate positive and negative subpatterns in a pattern.charGets the character used for percent sign.charGets the character used for per mille sign.charGets the character used for zero.inthashCode()Returns the hash code for thisDecimalFormatSymbols.voidsetCurrency(Currency currency) Sets the currency of thisDecimalFormatSymbols.voidsetCurrencySymbol(String currency) Sets the currency symbol for the currency of thisDecimalFormatSymbolsin their locale.voidsetDecimalSeparator(char decimalSeparator) Sets the character used for decimal sign.voidsetDigit(char digit) Sets the character used for a digit in a pattern.voidSets the string used to separate the mantissa from the exponent.voidsetGroupingSeparator(char groupingSeparator) Sets the character used for grouping separator.voidsetInfinity(String infinity) Sets the string used to represent infinity.voidsetInternationalCurrencySymbol(String currencyCode) Sets the ISO 4217 currency code of the currency of these DecimalFormatSymbols.voidsetMinusSign(char minusSign) Sets the character used to represent minus sign.voidsetMonetaryDecimalSeparator(char sep) Sets the monetary decimal separator.voidsetMonetaryGroupingSeparator(char monetaryGroupingSeparator) Sets the character used for grouping separator for currencies.voidSets the string used to represent "not a number".voidsetPatternSeparator(char patternSeparator) Sets the character used to separate positive and negative subpatterns in a pattern.voidsetPercent(char percent) Sets the character used for percent sign.voidsetPerMill(char perMill) Sets the character used for per mille sign.voidsetZeroDigit(char zeroDigit) Sets the character used for zero.
- 
Constructor Details- 
DecimalFormatSymbolspublic DecimalFormatSymbols()Create a DecimalFormatSymbols object for the defaultFORMATlocale. This constructor can only construct instances for the locales supported by the Java runtime environment, not for those supported by installedDecimalFormatSymbolsProviderimplementations. For full locale coverage, use thegetInstancemethod.This is equivalent to calling DecimalFormatSymbols(Locale.getDefault(Locale.Category.FORMAT)).- See Also:
 
- 
DecimalFormatSymbolsCreate 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 installedDecimalFormatSymbolsProviderimplementations. For full locale coverage, use thegetInstancemethod. If the specified locale contains theLocale.UNICODE_LOCALE_EXTENSIONfor 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 aNumberFormatinstance with the Thai numbering system, instead of the Latin numbering system.- Parameters:
- locale- the desired locale
- Throws:
- NullPointerException- if- localeis null
 
 
- 
- 
Method Details- 
getAvailableLocalesReturns an array of all locales for which thegetInstancemethods of this class can return localized instances. The returned array represents the union of locales supported by the Java runtime and by installedDecimalFormatSymbolsProviderimplementations. At a minimum, the returned array must contain aLocaleinstance equal toLocale.ROOTand aLocaleinstance equal toLocale.US.- Returns:
- an array of locales for which localized
         DecimalFormatSymbolsinstances are available.
- Since:
- 1.6
 
- 
getInstanceGets theDecimalFormatSymbolsinstance for the default locale. This method provides access toDecimalFormatSymbolsinstances for locales supported by the Java runtime itself as well as for those supported by installedDecimalFormatSymbolsProviderimplementations.This is equivalent to calling getInstance(Locale.getDefault(Locale.Category.FORMAT)).- Returns:
- a DecimalFormatSymbolsinstance.
- Since:
- 1.6
- See Also:
 
- 
getInstanceGets theDecimalFormatSymbolsinstance for the specified locale. This method provides access toDecimalFormatSymbolsinstances for locales supported by the Java runtime itself as well as for those supported by installedDecimalFormatSymbolsProviderimplementations. If the specified locale contains theLocale.UNICODE_LOCALE_EXTENSIONfor 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 aNumberFormatinstance with the Thai numbering system, instead of the Latin numbering system.- Parameters:
- locale- the desired locale.
- Returns:
- a DecimalFormatSymbolsinstance.
- Throws:
- NullPointerException- if- localeis null
- Since:
- 1.6
 
- 
getLocaleReturns locale used to create this instance.- Returns:
- locale used to create this instance
- Since:
- 19
 
- 
getZeroDigitpublic char getZeroDigit()Gets the character used for zero. Different for Arabic, etc.- Returns:
- the character used for zero
 
- 
setZeroDigitpublic void setZeroDigit(char zeroDigit) Sets the character used for zero. Different for Arabic, etc.- Parameters:
- zeroDigit- the character used for zero
 
- 
getGroupingSeparatorpublic char getGroupingSeparator()Gets the character used for grouping separator. Different for French, etc.- Returns:
- the grouping separator
 
- 
setGroupingSeparatorpublic void setGroupingSeparator(char groupingSeparator) Sets the character used for grouping separator. Different for French, etc.- Parameters:
- groupingSeparator- the grouping separator
 
- 
getDecimalSeparatorpublic char getDecimalSeparator()Gets the character used for decimal sign. Different for French, etc.- Returns:
- the character used for decimal sign
 
- 
setDecimalSeparatorpublic void setDecimalSeparator(char decimalSeparator) Sets the character used for decimal sign. Different for French, etc.- Parameters:
- decimalSeparator- the character used for decimal sign
 
- 
getPerMillpublic char getPerMill()Gets the character used for per mille sign. Different for Arabic, etc.- Returns:
- the character used for per mille sign
 
- 
setPerMillpublic void setPerMill(char perMill) Sets the character used for per mille sign. Different for Arabic, etc.- Parameters:
- perMill- the character used for per mille sign
 
- 
getPercentpublic char getPercent()Gets the character used for percent sign. Different for Arabic, etc.- Returns:
- the character used for percent sign
 
- 
setPercentpublic void setPercent(char percent) Sets the character used for percent sign. Different for Arabic, etc.- Parameters:
- percent- the character used for percent sign
 
- 
getDigitpublic char getDigit()Gets the character used for a digit in a pattern.- Returns:
- the character used for a digit in a pattern
 
- 
setDigitpublic void setDigit(char digit) Sets the character used for a digit in a pattern.- Parameters:
- digit- the character used for a digit in a pattern
 
- 
getPatternSeparatorpublic char getPatternSeparator()Gets the character used to separate positive and negative subpatterns in a pattern.- Returns:
- the pattern separator
 
- 
setPatternSeparatorpublic void setPatternSeparator(char patternSeparator) Sets the character used to separate positive and negative subpatterns in a pattern.- Parameters:
- patternSeparator- the pattern separator
 
- 
getInfinityGets the string used to represent infinity. Almost always left unchanged.- Returns:
- the string representing infinity
 
- 
setInfinitySets the string used to represent infinity. Almost always left unchanged.- Parameters:
- infinity- the string representing infinity
- Throws:
- NullPointerException- if- infinityis- null
 
- 
getNaNGets the string used to represent "not a number". Almost always left unchanged.- Returns:
- the string representing "not a number"
 
- 
setNaNSets the string used to represent "not a number". Almost always left unchanged.- Parameters:
- NaN- the string representing "not a number"
- Throws:
- NullPointerException- if- NaNis- null
 
- 
getMinusSignpublic 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:
- the character representing minus sign
 
- 
setMinusSignpublic 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- the character representing minus sign
 
- 
getCurrencySymbolReturns the currency symbol for the currency of these DecimalFormatSymbols in their locale.- Returns:
- the currency symbol
- Since:
- 1.2
 
- 
setCurrencySymbolSets the currency symbol for the currency of thisDecimalFormatSymbolsin their locale. UnlikesetInternationalCurrencySymbol(String), this method does not update the currency attribute nor the international currency symbol attribute.- Parameters:
- currency- the currency symbol
- Throws:
- NullPointerException- if- currencyis- null
- Since:
- 1.2
 
- 
getInternationalCurrencySymbolReturns the ISO 4217 currency code of the currency of these DecimalFormatSymbols.- Returns:
- the currency code
- Since:
- 1.2
 
- 
setInternationalCurrencySymbolSets the ISO 4217 currency code of the currency of these DecimalFormatSymbols. If the currency code is valid (as defined byCurrency.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 and the currency symbol attribute are not modified.- Parameters:
- currencyCode- the currency code
- Throws:
- NullPointerException- if- currencyCodeis- null
- Since:
- 1.2
- See Also:
 
- 
getCurrencyReturns theCurrencyof thisDecimalFormatSymbols.- Returns:
- the Currencyof thisDecimalFormatSymbols
- Since:
- 1.4
 
- 
setCurrencySets the currency of thisDecimalFormatSymbols. 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- currencyis null
- Since:
- 1.4
- See Also:
 
- 
getMonetaryDecimalSeparatorpublic char getMonetaryDecimalSeparator()Returns the monetary decimal separator.- Returns:
- the monetary decimal separator
- Since:
- 1.2
 
- 
setMonetaryDecimalSeparatorpublic void setMonetaryDecimalSeparator(char sep) Sets the monetary decimal separator.- Parameters:
- sep- the monetary decimal separator
- Since:
- 1.2
 
- 
getExponentSeparatorReturns 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
- Since:
- 1.6
- See Also:
 
- 
setExponentSeparatorSets 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- expis null
- Since:
- 1.6
- See Also:
 
- 
getMonetaryGroupingSeparatorpublic char getMonetaryGroupingSeparator()Gets the character used for grouping separator for currencies. May be different fromgrouping separatorin some locales, e.g, German in Austria.- Returns:
- the monetary grouping separator
- Since:
- 15
 
- 
setMonetaryGroupingSeparatorpublic void setMonetaryGroupingSeparator(char monetaryGroupingSeparator) Sets the character used for grouping separator for currencies. Invocation of this method will not affect the normalgrouping separator.- Parameters:
- monetaryGroupingSeparator- the monetary grouping separator
- Since:
- 15
- See Also:
 
- 
clone
- 
equalsCompares the specified object with thisDecimalFormatSymbolsfor equality. Returns true if the object is also aDecimalFormatSymbolsand the twoDecimalFormatSymbolsobjects represent the same set of symbols.- Overrides:
- equalsin class- Object
- Implementation Requirements:
- This method performs an equality check with a notion of class
 identity based on getClass(), rather thaninstanceof. Therefore, in the equals methods in subclasses, no instance of this class should compare as equal to an instance of a subclass.
- Parameters:
- obj- object to be compared for equality
- Returns:
- trueif the specified object is equal to this- DecimalFormatSymbols
- See Also:
 
- 
hashCodepublic int hashCode()Returns the hash code for thisDecimalFormatSymbols.- Overrides:
- hashCodein class- Object
- Implementation Requirements:
- Non-transient instance fields of this class are used to calculate
 a hash code value which adheres to the contract defined in Objects.hashCode(java.lang.Object).
- Returns:
- the hash code for this DecimalFormatSymbols
- See Also:
 
 
-