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:
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
|
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 |
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. |
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
|
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 (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
|
Object clone ()
Standard override.
Returns | |
---|---|
Object |
a clone of this instance. |
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. |
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. |
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 |
String getCurrencySymbol ()
Returns the currency symbol for the currency of these DecimalFormatSymbols in their locale.
Returns | |
---|---|
String |
char getDecimalSeparator ()
Gets the character used for decimal sign. Different for French, etc.
Returns | |
---|---|
char |
char getDigit ()
Gets the character used for a digit in a pattern.
Returns | |
---|---|
char |
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:
char getGroupingSeparator ()
Gets the character used for thousands separator. Different for French, etc.
Returns | |
---|---|
char |
String getInfinity ()
Gets the string used to represent infinity. Almost always left unchanged.
Returns | |
---|---|
String |
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. |
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 |
String getInternationalCurrencySymbol ()
Returns the ISO 4217 currency code of the currency of these DecimalFormatSymbols.
Returns | |
---|---|
String |
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 |
char getMonetaryDecimalSeparator ()
Returns the monetary decimal separator.
Returns | |
---|---|
char |
String getNaN ()
Gets the string used to represent "not a number". Almost always left unchanged.
Returns | |
---|---|
String |
char getPatternSeparator ()
Gets the character used to separate positive and negative subpatterns in a pattern.
Returns | |
---|---|
char |
char getPerMill ()
Gets the character used for per mille sign. Different for Arabic, etc.
Returns | |
---|---|
char |
char getPercent ()
Gets the character used for percent sign. Different for Arabic, etc.
Returns | |
---|---|
char |
char getZeroDigit ()
Gets the character used for zero. Different for Arabic, etc.
Returns | |
---|---|
char |
int hashCode ()
Override hashCode.
Returns | |
---|---|
int |
a hash code value for this object. |
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 |
void setCurrencySymbol (String currency)
Sets the currency symbol for the currency of these DecimalFormatSymbols in their locale.
Parameters | |
---|---|
currency |
String
|
void setDecimalSeparator (char decimalSeparator)
Sets the character used for decimal sign. Different for French, etc.
Parameters | |
---|---|
decimalSeparator |
char
|
void setDigit (char digit)
Sets the character used for a digit in a pattern.
Parameters | |
---|---|
digit |
char
|
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:
void setGroupingSeparator (char groupingSeparator)
Sets the character used for thousands separator. Different for French, etc.
Parameters | |
---|---|
groupingSeparator |
char
|
void setInfinity (String infinity)
Sets the string used to represent infinity. Almost always left unchanged.
Parameters | |
---|---|
infinity |
String
|
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
|
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
|
void setMonetaryDecimalSeparator (char sep)
Sets the monetary decimal separator.
Parameters | |
---|---|
sep |
char
|
void setNaN (String NaN)
Sets the string used to represent "not a number". Almost always left unchanged.
Parameters | |
---|---|
NaN |
String
|
void setPatternSeparator (char patternSeparator)
Sets the character used to separate positive and negative subpatterns in a pattern.
Parameters | |
---|---|
patternSeparator |
char
|
void setPerMill (char perMill)
Sets the character used for per mille sign. Different for Arabic, etc.
Parameters | |
---|---|
perMill |
char
|
void setPercent (char percent)
Sets the character used for percent sign. Different for Arabic, etc.
Parameters | |
---|---|
percent |
char
|
void setZeroDigit (char zeroDigit)
Sets the character used for zero. Different for Arabic, etc.
Parameters | |
---|---|
zeroDigit |
char
|