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
|
|
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
|
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 |
static
final
DecimalFormatSymbols
|
getInstance(Locale locale)
Gets the |
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 | |
---|---|
Public constructors
DecimalFormatSymbols
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))
.
DecimalFormatSymbols
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"))
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
public Object clone ()
Standard override.
Returns | |
---|---|
Object |
a clone of this instance. |
equals
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
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
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
public String getCurrencySymbol ()
Returns the currency symbol for the currency of these DecimalFormatSymbols in their locale.
Returns | |
---|---|
String |
the currency symbol |
getDecimalSeparator
public char getDecimalSeparator ()
Gets the character used for decimal sign. Different for French, etc.
Returns | |
---|---|
char |
the character used for decimal sign |
getDigit
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
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:
getGroupingSeparator
public char getGroupingSeparator ()
Gets the character used for grouping separator. Different for French, etc.
Returns | |
---|---|
char |
the grouping separator |
getInfinity
public String getInfinity ()
Gets the string used to represent infinity. Almost always left unchanged.
Returns | |
---|---|
String |
the string representing infinity |
getInstance
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. |
getInstance
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"))
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
public String getInternationalCurrencySymbol ()
Returns the ISO 4217 currency code of the currency of these DecimalFormatSymbols.
Returns | |
---|---|
String |
the currency code |
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.
Returns | |
---|---|
char |
the character representing minus sign |
getMonetaryDecimalSeparator
public char getMonetaryDecimalSeparator ()
Returns the monetary decimal separator.
Returns | |
---|---|
char |
the monetary decimal separator |
getMonetaryGroupingSeparator
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
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
public char getPatternSeparator ()
Gets the character used to separate positive and negative subpatterns in a pattern.
Returns | |
---|---|
char |
the pattern separator |
getPerMill
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
public char getPercent ()
Gets the character used for percent sign. Different for Arabic, etc.
Returns | |
---|---|
char |
the character used for percent sign |
getZeroDigit
public char getZeroDigit ()
Gets the character used for zero. Different for Arabic, etc.
Returns | |
---|---|
char |
the character used for zero |
hashCode
public int hashCode ()
Override hashCode.
Returns | |
---|---|
int |
a hash code value for this 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 |
Currency : the new currency to be used |
Throws | |
---|---|
NullPointerException |
if currency is null |
setCurrencySymbol
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
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
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
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:
setGroupingSeparator
public void setGroupingSeparator (char groupingSeparator)
Sets the character used for grouping separator. Different for French, etc.
Parameters | |
---|---|
groupingSeparator |
char : the grouping separator |
setInfinity
public void setInfinity (String infinity)
Sets the string used to represent infinity. Almost always left unchanged.
Parameters | |
---|---|
infinity |
String : the string representing 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
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 |
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 |
char : the character representing minus sign |
setMonetaryDecimalSeparator
public void setMonetaryDecimalSeparator (char sep)
Sets the monetary decimal separator.
Parameters | |
---|---|
sep |
char : the monetary decimal separator |
setMonetaryGroupingSeparator
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:
setNaN
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
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
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
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
public void setZeroDigit (char zeroDigit)
Sets the character used for zero. Different for Arabic, etc.
Parameters | |
---|---|
zeroDigit |
char : the character used for zero |