Class DecimalFormat
- All Implemented Interfaces:
Serializable
,Cloneable
DecimalFormat
is a concrete subclass of
NumberFormat
that formats decimal numbers in a localized manner.
It has a variety of features designed to make it possible to parse and format
numbers in any locale, including support for Western, Arabic, and Indic digits.
It also supports different kinds of numbers, including integers (123), fixed-point
numbers (123.4), scientific notation (1.23E4), percentages (12%), and
currency amounts ($123).
Getting a DecimalFormat
To obtain a standard decimal format for a specific locale, including the default locale, it is recommended to call one of theNumberFormat
factory methods
, such as NumberFormat.getInstance()
.
These factory methods may not always return a DecimalFormat
depending on the locale-service provider implementation
installed. Thus, to use an instance method defined by DecimalFormat
,
the NumberFormat
returned by the factory method should be
type checked before converted to DecimalFormat
. If the installed locale-sensitive
service implementation does not support the given Locale
, the parent
locale chain will be looked up, and a Locale
used that is supported.
If the factory methods are not desired, use one of the constructors such
as DecimalFormat(String pattern)
. See the Pattern
section for more information on the pattern
parameter.
Using DecimalFormat
The following is an example of formatting and parsing,NumberFormat nFmt = NumberFormat.getCurrencyInstance(Locale.US);
if (nFmt instanceof DecimalFormat dFmt) {
// pattern match to DecimalFormat to use setPositiveSuffix(String)
dFmt.setPositiveSuffix(" dollars");
dFmt.format(100000); // returns "$100,000.00 dollars"
dFmt.parse("$100,000.00 dollars"); // returns 100000
}
Formatting and Parsing
Rounding
When formatting,DecimalFormat
can adjust its rounding using setRoundingMode(RoundingMode)
. By default, it uses
RoundingMode.HALF_EVEN
.
Digits
When formatting,DecimalFormat
uses the ten consecutive
characters starting with the localized zero digit defined in the
DecimalFormatSymbols
object as digits.
When parsing, these digits as well as all Unicode decimal digits, as
defined by Character.digit
, are recognized.
Integer and Fraction Digit Limits
- Implementation Requirements:
- When formatting a
Number
other thanBigInteger
andBigDecimal
,309
is used as the upper limit for integer digits, and340
as the upper limit for fraction digits. This occurs, even if one of theDecimalFormat
getter methods, for example,getMinimumFractionDigits()
returns a numerically greater value.Special Values
Not a Number (
NaN
) is formatted as a string, which is typically given as "NaN". This string is determined byDecimalFormatSymbols.getNaN()
. This is the only value for which the prefixes and suffixes are not attached.Infinity is formatted as a string, which is typically given as "∞" (
U+221E
), with the positive or negative prefixes and suffixes attached. This string is determined byDecimalFormatSymbols.getInfinity()
.Negative zero (
"-0"
) parses toBigDecimal(0)
ifisParseBigDecimal()
is trueLong(0)
ifisParseBigDecimal()
is false andisParseIntegerOnly()
is trueDouble(-0.0)
if bothisParseBigDecimal()
andisParseIntegerOnly()
are false
Synchronization
Decimal formats are generally not synchronized. It is recommended to create separate format instances for each thread. If multiple threads access a format concurrently, it must be synchronized externally.
DecimalFormat Pattern
ADecimalFormat
comprises a pattern and a set of symbols. The pattern may be set directly usingapplyPattern()
, or indirectly using the various API methods. The symbols are stored in aDecimalFormatSymbols
object. When using theNumberFormat
factory methods, the pattern and symbols are created from the locale-sensitive service implementation installed.DecimalFormat
patterns have the following syntax:Pattern: PositivePattern PositivePattern ; NegativePattern PositivePattern: Prefixopt Number Suffixopt NegativePattern: Prefixopt Number Suffixopt Prefix: Any characters except the special pattern characters Suffix: Any characters except the special pattern characters Number: Integer Exponentopt Integer . Fraction Exponentopt Integer: MinimumInteger # # Integer # , Integer MinimumInteger: 0 0 MinimumInteger 0 , MinimumInteger Fraction: MinimumFractionopt OptionalFractionopt MinimumFraction: 0 MinimumFractionopt OptionalFraction: # OptionalFractionopt Exponent: E MinimumExponent MinimumExponent: 0 MinimumExponentopt
Special Pattern Characters
The special characters in the table below are interpreted syntactically when used in the DecimalFormat pattern. They must be quoted, unless noted otherwise, if they are to appear in the prefix or suffix as literals.
The characters in the
Symbol
column are used in non-localized patterns. The corresponding characters in theLocalized Symbol
column are used in localized patterns, with the characters inSymbol
losing their syntactical meaning. Two exceptions are the currency sign (U+00A4
) and quote (U+0027
), which are not localized.Non-localized patterns should be used when calling
applyPattern(String)
. Localized patterns should be used when callingapplyLocalizedPattern(String)
.Symbol Localized Symbol Location Meaning 0
DecimalFormatSymbols.getZeroDigit()
Number Digit #
DecimalFormatSymbols.getDigit()
Number Digit, zero shows as absent .
DecimalFormatSymbols.getDecimalSeparator()
Number Decimal separator or monetary decimal separator - (U+002D)
DecimalFormatSymbols.getMinusSign()
Number Minus sign ,
DecimalFormatSymbols.getGroupingSeparator()
Number Grouping separator or monetary grouping separator E
DecimalFormatSymbols.getExponentSeparator()
Number Separates mantissa and exponent in scientific notation. This value is case sensistive. Need not be quoted in prefix or suffix. ;
DecimalFormatSymbols.getPatternSeparator()
Subpattern boundary Separates positive and negative subpatterns %
DecimalFormatSymbols.getPercent()
Prefix or suffix Multiply by 100 and show as percentage ‰ ( U+2030
)DecimalFormatSymbols.getPerMill()
Prefix or suffix Multiply by 1000 and show as per mille value ¤ ( U+00A4
)n/a (not localized) Prefix or suffix Currency sign, replaced by currency symbol. If doubled, replaced by international currency symbol. If present in a pattern, the monetary decimal/grouping separators are used instead of the decimal/grouping separators. ' (U+0027)
n/a (not localized) Prefix or suffix Used to quote special characters in a prefix or suffix, for example, "'#'#"
formats 123 to"#123"
. To create a single quote itself, use two in a row:"# o''clock"
.Maximum Digits Derivation
For any givenDecimalFormat
pattern, if the pattern is not in scientific notation, the maximum number of integer digits will not be derived from the pattern, and instead set toInteger.MAX_VALUE
. Otherwise, if the pattern is in scientific notation, the maximum number of integer digits will be derived from the pattern. This derivation is detailed in theScientific Notation
section.setMaximumIntegerDigits(int)
can be used to manually adjust the maximum integer digits.Negative Subpatterns
ADecimalFormat
pattern contains a positive and negative subpattern, for example,"#,##0.00;(#,##0.00)"
. Each subpattern has a prefix, numeric part, and suffix. The negative subpattern is optional; if absent, then the positive subpattern prefixed with the minus sign'-' (U+002D HYPHEN-MINUS)
is used as the negative subpattern. That is,"0.00"
alone is equivalent to"0.00;-0.00"
. If there is an explicit negative subpattern, it serves only to specify the negative prefix and suffix; the number of digits, minimal digits, and other characteristics are all the same as the positive pattern. That means that"#,##0.0#;(#)"
produces precisely the same behavior as"#,##0.0#;(#,##0.0#)"
.The prefixes, suffixes, and various symbols used for infinity, digits, grouping separators, decimal separators, etc. may be set to arbitrary values, and they will appear properly during formatting. However, care must be taken that the symbols and strings do not conflict, or parsing will be unreliable. For example, either the positive and negative prefixes or the suffixes must be distinct for
DecimalFormat.parse()
to be able to distinguish positive from negative values. (If they are identical, thenDecimalFormat
will behave as if no negative subpattern was specified.) Another example is that the decimal separator and grouping separator should be distinct characters, or parsing will be impossible.Grouping Separator
The grouping separator is commonly used for thousands, but in some locales it separates ten-thousands. The grouping size is a constant number of digits between the grouping characters, such as 3 for 100,000,000 or 4 for 1,0000,0000. If you supply a pattern with multiple grouping characters, the interval between the last one and the end of the integer is the one that is used. For example,
"#,##,###,####"
=="######,####"
=="##,####,####"
.Scientific Notation
Numbers in scientific notation are expressed as the product of a mantissa and a power of ten, for example, 1234 can be expressed as 1.234 x 10^3. The mantissa is often in the range 1.0 ≤ x < 10.0, but it need not be.
DecimalFormat
can be instructed to format and parse scientific notation only via a pattern; there is currently no factory method that creates a scientific notation format. In a pattern, the exponent character immediately followed by one or more digit characters indicates scientific notation. Example:"0.###E0"
formats the number 1234 as"1.234E3"
.- The number of digit characters after the exponent character gives the
minimum exponent digit count. There is no maximum. Negative exponents are
formatted using the localized minus sign, not the prefix and suffix
from the pattern. This allows patterns such as
"0.###E0 m/s"
. - The maximum integer digits is the sum of '0's and '#'s
prior to the decimal point. The minimum integer digits is the
sum of the '0's prior to the decimal point. The maximum fraction
and minimum fraction digits follow the same rules, but apply to the
digits after the decimal point but before the exponent. For example, the
following pattern:
"#00.0####E0"
would have a minimum number of integer digits = 2("00") and a maximum number of integer digits = 3("#00"). It would have a minimum number of fraction digits = 1("0") and a maximum number of fraction digits= 5("0####"). - The minimum and maximum number of integer digits are interpreted
together:
- If the maximum number of integer digits is greater than their minimum number
and greater than 1, it forces the exponent to be a multiple of the maximum
number of integer digits, and the minimum number of integer digits to be
interpreted as 1. The most common use of this is to generate
engineering notation, in which the exponent is a multiple of three,
e.g.,
"##0.#####E0"
. Using this pattern, the number 12345 formats to"12.345E3"
, and 123456 formats to"123.456E3"
. - Otherwise, the minimum number of integer digits is achieved by adjusting the
exponent. Example: 0.00123 formatted with
"00.###E0"
yields"12.3E-4"
.
- If the maximum number of integer digits is greater than their minimum number
and greater than 1, it forces the exponent to be a multiple of the maximum
number of integer digits, and the minimum number of integer digits to be
interpreted as 1. The most common use of this is to generate
engineering notation, in which the exponent is a multiple of three,
e.g.,
- For a given number, the amount of significant digits in
the mantissa can be calculated as such
This means that generally, a mantissa will have up to the combined maximum integer and fraction digits, if the original number itself has enough significant digits. However, if there are more minimum pattern digits than significant digits in the original number, the mantissa will have significant digits that equals the combined minimum integer and fraction digits. The number of significant digits does not affect parsing.Mantissa Digits: min(max(Minimum Pattern Digits, Original Number Digits), Maximum Pattern Digits) Minimum pattern Digits: Minimum Integer Digits + Minimum Fraction Digits Maximum pattern Digits: Maximum Integer Digits + Maximum Fraction Digits Original Number Digits: The amount of significant digits in the number to be formatted
It should be noted, that the integer portion of the mantissa will give any excess digits to the fraction portion, whether it be for precision or for satisfying the total amount of combined minimum digits.
This behavior can be observed in the following example,
DecimalFormat df = new DecimalFormat("#000.000##E0"); df.format(12); // returns "12.0000E0" df.format(123456789) // returns "1.23456789E8"
- Exponential patterns may not contain grouping separators.
- Since:
- 1.1
- External Specifications
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.text.NumberFormat
NumberFormat.Field, NumberFormat.Style
-
Field Summary
Fields inherited from class java.text.NumberFormat
FRACTION_FIELD, INTEGER_FIELD
-
Constructor Summary
ConstructorDescriptionCreates a DecimalFormat using the default pattern and symbols for the defaultFORMAT
locale.DecimalFormat
(String pattern) Creates a DecimalFormat using the given pattern and the symbols for the defaultFORMAT
locale.DecimalFormat
(String pattern, DecimalFormatSymbols symbols) Creates a DecimalFormat using the given pattern and symbols. -
Method Summary
Modifier and TypeMethodDescriptionvoid
applyLocalizedPattern
(String pattern) Apply the given pattern to this Format object.void
applyPattern
(String pattern) Apply the given pattern to this Format object.clone()
Standard override; no change in semantics.boolean
Compares the specified object with thisDecimalFormat
for equality.format
(double number, StringBuffer result, FieldPosition fieldPosition) Formats a double to produce a string.format
(long number, StringBuffer result, FieldPosition fieldPosition) Format a long to produce a string.final StringBuffer
format
(Object number, StringBuffer toAppendTo, FieldPosition pos) Formats a number and appends the resulting text to the given string buffer.Formats an Object producing anAttributedCharacterIterator
.Gets the currency used by this decimal format when formatting currency values.Returns a copy of the decimal format symbols, which is generally not changed by the programmer or user.int
Return the grouping size.int
Gets the maximum number of digits allowed in the fraction portion of a number.int
Gets the maximum number of digits allowed in the integer portion of a number.int
Gets the minimum number of digits allowed in the fraction portion of a number.int
Gets the minimum number of digits allowed in the integer portion of a number.int
Gets the multiplier for use in percent, per mille, and similar formats.Get the negative prefix.Get the negative suffix.Get the positive prefix.Get the positive suffix.Gets theRoundingMode
used in this DecimalFormat.int
hashCode()
Returns the hash code for thisDecimalFormat
.boolean
Allows you to get the behavior of the decimal separator with integers.boolean
Returns whether theparse(java.lang.String, java.text.ParsePosition)
method returnsBigDecimal
.boolean
isStrict()
Returnstrue
if this format will parse numbers strictly;false
otherwise.parse
(String text, ParsePosition pos) Parses text from the beginning of the given string to produce aNumber
.void
setCurrency
(Currency currency) Sets the currency used by this number format when formatting currency values.void
setDecimalFormatSymbols
(DecimalFormatSymbols newSymbols) Sets the decimal format symbols, which is generally not changed by the programmer or user.void
setDecimalSeparatorAlwaysShown
(boolean newValue) Allows you to set the behavior of the decimal separator with integers.void
setGroupingSize
(int newValue) Set the grouping size.void
setGroupingUsed
(boolean newValue) Set whether or not grouping will be used in this format.void
setMaximumFractionDigits
(int newValue) Sets the maximum number of digits allowed in the fraction portion of a number.void
setMaximumIntegerDigits
(int newValue) Sets the maximum number of digits allowed in the integer portion of a number.void
setMinimumFractionDigits
(int newValue) Sets the minimum number of digits allowed in the fraction portion of a number.void
setMinimumIntegerDigits
(int newValue) Sets the minimum number of digits allowed in the integer portion of a number.void
setMultiplier
(int newValue) Sets the multiplier for use in percent, per mille, and similar formats.void
setNegativePrefix
(String newValue) Set the negative prefix.void
setNegativeSuffix
(String newValue) Set the negative suffix.void
setParseBigDecimal
(boolean newValue) Sets whether theparse(java.lang.String, java.text.ParsePosition)
method returnsBigDecimal
.void
setPositivePrefix
(String newValue) Set the positive prefix.void
setPositiveSuffix
(String newValue) Set the positive suffix.void
setRoundingMode
(RoundingMode roundingMode) Sets theRoundingMode
used in this DecimalFormat.void
setStrict
(boolean strict) Change the leniency value for parsing.Synthesizes a localized pattern string that represents the current state of this Format object.Synthesizes a pattern string that represents the current state of this Format object.toString()
Returns a string identifying thisDecimalFormat
, for debugging.Methods inherited from class java.text.NumberFormat
format, format, getAvailableLocales, getCompactNumberInstance, getCompactNumberInstance, getCurrencyInstance, getCurrencyInstance, getInstance, getInstance, getIntegerInstance, getIntegerInstance, getNumberInstance, getNumberInstance, getPercentInstance, getPercentInstance, isGroupingUsed, isParseIntegerOnly, parse, parseObject, setParseIntegerOnly
Methods inherited from class java.text.Format
format, parseObject
-
Constructor Details
-
DecimalFormat
public DecimalFormat()Creates a DecimalFormat using the default pattern and symbols for the defaultFORMAT
locale. This is a convenient way to obtain a DecimalFormat when internationalization is not the main concern.- API Note:
- To obtain standard formats for a given locale, use the
NumberFormat
factory methods such asNumberFormat.getNumberInstance(Locale)
. These factories will return the most appropriate subclass of NumberFormat for a given locale. - See Also:
-
DecimalFormat
Creates a DecimalFormat using the given pattern and the symbols for the defaultFORMAT
locale. This is a convenient way to obtain a DecimalFormat when internationalization is not the main concern. The number of maximum integer digits is usually not derived from the pattern. See the note in thePatterns
section for more detail.- API Note:
- To obtain standard formats for a given locale, use the
NumberFormat
factory methods such asNumberFormat.getNumberInstance(Locale)
. These factories will return the most appropriate subclass of NumberFormat for a given locale. - Parameters:
pattern
- a non-localized pattern string.- Throws:
NullPointerException
- ifpattern
is nullIllegalArgumentException
- if the given pattern is invalid.- See Also:
-
DecimalFormat
Creates a DecimalFormat using the given pattern and symbols. Use this constructor when you need to completely customize the behavior of the format. The number of maximum integer digits is usually not derived from the pattern. See the note in thePatterns
section for more detail.- API Note:
- To obtain standard formats for a given locale, use the
NumberFormat
factory methods such asNumberFormat.getInstance(Locale)
orNumberFormat.getCurrencyInstance(Locale)
. If you need only minor adjustments to a standard format, you can modify the format returned by a NumberFormat factory method. - Parameters:
pattern
- a non-localized pattern stringsymbols
- the set of symbols to be used- Throws:
NullPointerException
- if any of the given arguments is nullIllegalArgumentException
- if the given pattern is invalid- See Also:
-
-
Method Details
-
format
Formats a number and appends the resulting text to the given string buffer. The number can be of any subclass ofNumber
.- Overrides:
format
in classNumberFormat
- Implementation Requirements:
- This implementation uses the maximum precision permitted.
- Parameters:
number
- the number to formattoAppendTo
- theStringBuffer
to which the formatted text is to be appendedpos
- keeps track on the position of the field within the returned string. For example, for formatting a number1234567.89
inLocale.US
locale, if the givenfieldPosition
isNumberFormat.INTEGER_FIELD
, the begin index and end index offieldPosition
will be set to 0 and 9, respectively for the output string1,234,567.89
.- Returns:
- the value passed in as
toAppendTo
- Throws:
IllegalArgumentException
- ifnumber
is null or not an instance ofNumber
.NullPointerException
- iftoAppendTo
orpos
is nullArithmeticException
- if rounding is needed with rounding mode being set to RoundingMode.UNNECESSARY- See Also:
-
format
Formats a double to produce a string.- Specified by:
format
in classNumberFormat
- Parameters:
number
- The double to formatresult
- where the text is to be appendedfieldPosition
- keeps track on the position of the field within the returned string. For example, for formatting a number1234567.89
inLocale.US
locale, if the givenfieldPosition
isNumberFormat.INTEGER_FIELD
, the begin index and end index offieldPosition
will be set to 0 and 9, respectively for the output string1,234,567.89
.- Returns:
- The formatted number string
- Throws:
NullPointerException
- ifresult
orfieldPosition
isnull
ArithmeticException
- if rounding is needed with rounding mode being set to RoundingMode.UNNECESSARY- See Also:
-
format
Format a long to produce a string.- Specified by:
format
in classNumberFormat
- Parameters:
number
- The long to formatresult
- where the text is to be appendedfieldPosition
- keeps track on the position of the field within the returned string. For example, for formatting a number123456789
inLocale.US
locale, if the givenfieldPosition
isNumberFormat.INTEGER_FIELD
, the begin index and end index offieldPosition
will be set to 0 and 11, respectively for the output string123,456,789
.- Returns:
- The formatted number string
- Throws:
NullPointerException
- ifresult
orfieldPosition
isnull
ArithmeticException
- if rounding is needed with rounding mode being set to RoundingMode.UNNECESSARY- See Also:
-
formatToCharacterIterator
Formats an Object producing anAttributedCharacterIterator
. You can use the returnedAttributedCharacterIterator
to build the resulting String, as well as to determine information about the resulting String.Each attribute key of the AttributedCharacterIterator will be of type
NumberFormat.Field
, with the attribute value being the same as the attribute key.- Overrides:
formatToCharacterIterator
in classFormat
- Parameters:
obj
- The object to format- Returns:
- AttributedCharacterIterator describing the formatted value.
- Throws:
NullPointerException
- if obj is null.IllegalArgumentException
- when the Format cannot format the given object.ArithmeticException
- if rounding is needed with rounding mode being set to RoundingMode.UNNECESSARY- Since:
- 1.4
-
parse
Parses text from the beginning of the given string to produce aNumber
.This method attempts to parse text starting at the index given by the
ParsePosition
. If parsing succeeds, then the index of theParsePosition
is updated to the index after the last character used (parsing does not necessarily use all characters up to the end of the string), and the parsed number is returned. The updatedParsePosition
can be used to indicate the starting point for the next call to this method. If an error occurs, then the index of theParsePosition
is not changed, the error index of theParsePosition
is set to the index of the character where the error occurred, andnull
is returned.This method will return a Long if possible (e.g., within the range [Long.MIN_VALUE, Long.MAX_VALUE] and with no decimals), otherwise a Double.
Parsing can be done in either a strict or lenient manner, by default it is lenient.
Parsing fails when lenient, if the prefix and/or suffix are non-empty and cannot be found due to parsing ending early, or the first character after the prefix cannot be parsed.
Parsing fails when strict, if in
text
,- The prefix is not found. For example, a
Locale.US
currency format prefix: "$
" - The suffix is not found. For example, a
Locale.US
percent format suffix: "%
" -
NumberFormat.isGroupingUsed()
returnstrue
, andgetGroupingSize()
is not adhered to -
NumberFormat.isGroupingUsed()
returnsfalse
, and the grouping symbol is found -
NumberFormat.isGroupingUsed()
returnstrue
and the grouping symbol occurs after the decimal separator - Any other characters are found, that are not the expected symbols, and are not digits that occur within the numerical portion
The subclass returned depends on the value of
isParseBigDecimal()
as well as on the string being parsed.- If
isParseBigDecimal()
is false (the default), most integer values are returned asLong
objects, no matter how they are written:"17"
and"17.000"
both parse toLong(17)
. Values that cannot fit into aLong
are returned asDouble
s. This includes values with a fractional part, infinite values,NaN
, and the value -0.0.DecimalFormat
does not decide whether to return aDouble
or aLong
based on the presence of a decimal separator in the source string. Doing so would prevent integers that overflow the mantissa of a double, such as"-9,223,372,036,854,775,808.00"
, from being parsed accurately.Callers may use the
Number
methodsdoubleValue
,longValue
, etc., to obtain the type they want. - If
isParseBigDecimal()
is true, values are returned asBigDecimal
objects. The values are the ones constructed byBigDecimal(String)
for corresponding strings in locale-independent format. The special cases negative and positive infinity and NaN are returned asDouble
instances holding the values of the correspondingDouble
constants.
DecimalFormat
parses all Unicode characters that represent decimal digits, as defined byCharacter.digit()
. In addition,DecimalFormat
also recognizes as digits the ten consecutive characters starting with the localized zero digit defined in theDecimalFormatSymbols
object.- Specified by:
parse
in classNumberFormat
- Parameters:
text
- the string to be parsedpos
- AParsePosition
object with index and error index information as described above.- Returns:
- the parsed value, or
null
if the parse fails - Throws:
NullPointerException
- iftext
orpos
is null.- See Also:
- The prefix is not found. For example, a
-
getDecimalFormatSymbols
Returns a copy of the decimal format symbols, which is generally not changed by the programmer or user.- Returns:
- a copy of the desired DecimalFormatSymbols
- See Also:
-
setDecimalFormatSymbols
Sets the decimal format symbols, which is generally not changed by the programmer or user.- Parameters:
newSymbols
- desired DecimalFormatSymbols- See Also:
-
getPositivePrefix
Get the positive prefix.Examples: +123, $123, sFr123
- Returns:
- the positive prefix
-
setPositivePrefix
Set the positive prefix.Examples: +123, $123, sFr123
- Parameters:
newValue
- the new positive prefix
-
getNegativePrefix
Get the negative prefix.Examples: -123, ($123) (with negative suffix), sFr-123
- Returns:
- the negative prefix
-
setNegativePrefix
Set the negative prefix.Examples: -123, ($123) (with negative suffix), sFr-123
- Parameters:
newValue
- the new negative prefix
-
getPositiveSuffix
Get the positive suffix.Example: 123%
- Returns:
- the positive suffix
-
setPositiveSuffix
Set the positive suffix.Example: 123%
- Parameters:
newValue
- the new positive suffix
-
getNegativeSuffix
Get the negative suffix.Examples: -123%, ($123) (with positive suffixes)
- Returns:
- the negative suffix
-
setNegativeSuffix
Set the negative suffix.Examples: 123%
- Parameters:
newValue
- the new negative suffix
-
getMultiplier
public int getMultiplier()Gets the multiplier for use in percent, per mille, and similar formats.- Returns:
- the multiplier
- See Also:
-
setMultiplier
public void setMultiplier(int newValue) Sets the multiplier for use in percent, per mille, and similar formats. For a percent format, set the multiplier to 100 and the suffixes to have '%' (for Arabic, use the Arabic percent sign). For a per mille format, set the multiplier to 1000 and the suffixes to have 'U+2030
'.Example: with multiplier 100, 1.23 is formatted as "123", and "123" is parsed into 1.23. If
isParseIntegerOnly()
returnstrue
, "123" is parsed into 1.- Parameters:
newValue
- the new multiplier- See Also:
-
setGroupingUsed
public void setGroupingUsed(boolean newValue) Set whether or not grouping will be used in this format.- Overrides:
setGroupingUsed
in classNumberFormat
- Parameters:
newValue
-true
if grouping is used;false
otherwise- See Also:
-
getGroupingSize
public int getGroupingSize()Return the grouping size. Grouping size is the number of digits between grouping separators in the integer portion of a number. For example, in the number "123,456.78", the grouping size is 3. Grouping size of zero designates that grouping is not used, which provides the same formatting as if callingsetGroupingUsed(false)
.- Returns:
- the grouping size
- See Also:
-
setGroupingSize
public void setGroupingSize(int newValue) Set the grouping size. Grouping size is the number of digits between grouping separators in the integer portion of a number. For example, in the number "123,456.78", the grouping size is 3. Grouping size of zero designates that grouping is not used, which provides the same formatting as if callingsetGroupingUsed(false)
.The value passed in is converted to a byte, which may lose information. Values that are negative or greater than
Byte.MAX_VALUE
, will throw anIllegalArgumentException
.- Parameters:
newValue
- the new grouping size- Throws:
IllegalArgumentException
- ifnewValue
is negative or greater thanByte.MAX_VALUE
- See Also:
-
isDecimalSeparatorAlwaysShown
public boolean isDecimalSeparatorAlwaysShown()Allows you to get the behavior of the decimal separator with integers. (The decimal separator will always appear with decimals.)Example: Decimal ON: 12345 → 12345.; OFF: 12345 → 12345
- Returns:
true
if the decimal separator is always shown;false
otherwise
-
setDecimalSeparatorAlwaysShown
public void setDecimalSeparatorAlwaysShown(boolean newValue) Allows you to set the behavior of the decimal separator with integers. (The decimal separator will always appear with decimals.)Example: Decimal ON: 12345 → 12345.; OFF: 12345 → 12345
- Parameters:
newValue
-true
if the decimal separator is always shown;false
otherwise
-
isStrict
public boolean isStrict()Returnstrue
if this format will parse numbers strictly;false
otherwise.- Overrides:
isStrict
in classNumberFormat
- Returns:
true
if this format will parse numbers strictly;false
otherwise- Since:
- 23
- See Also:
-
setStrict
public void setStrict(boolean strict) Change the leniency value for parsing. Parsing can either be strict or lenient, by default it is lenient.- Overrides:
setStrict
in classNumberFormat
- Parameters:
strict
-true
if parsing should be done strictly;false
otherwise- Since:
- 23
- See Also:
-
isParseBigDecimal
public boolean isParseBigDecimal()Returns whether theparse(java.lang.String, java.text.ParsePosition)
method returnsBigDecimal
. The default value is false.- Returns:
true
if the parse method returns BigDecimal;false
otherwise- Since:
- 1.5
- See Also:
-
setParseBigDecimal
public void setParseBigDecimal(boolean newValue) Sets whether theparse(java.lang.String, java.text.ParsePosition)
method returnsBigDecimal
.- Parameters:
newValue
-true
if the parse method returns BigDecimal;false
otherwise- Since:
- 1.5
- See Also:
-
clone
Standard override; no change in semantics.- Overrides:
clone
in classNumberFormat
- Returns:
- a clone of this instance.
- See Also:
-
equals
Compares the specified object with thisDecimalFormat
for equality. Returns true if the object is also aDecimalFormat
and the two formats would format any value the same.- Overrides:
equals
in classNumberFormat
- 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:
true
if the specified object is equal to thisDecimalFormat
- See Also:
-
hashCode
public int hashCode()Returns the hash code for thisDecimalFormat
.- Overrides:
hashCode
in classNumberFormat
- Implementation Requirements:
- This method calculates the hash code value using the values returned from
getPositivePrefix()
andNumberFormat.hashCode()
. - Returns:
- the hash code for this
DecimalFormat
- See Also:
-
toString
-
toPattern
Synthesizes a pattern string that represents the current state of this Format object.- Returns:
- a pattern string
- See Also:
-
toLocalizedPattern
Synthesizes a localized pattern string that represents the current state of this Format object.- Returns:
- a localized pattern string
- See Also:
-
applyPattern
Apply the given pattern to this Format object. A pattern is a short-hand specification for the various formatting properties. These properties can also be changed individually through the various setter methods.The number of maximum integer digits is usually not derived from the pattern. See the note in the
Patterns
section for more detail. For negative numbers, use a second pattern, separated by a semicolonExample
"#,#00.0#"
→ 1,234.56This means a minimum of 2 integer digits, 1 fraction digit, and a maximum of 2 fraction digits.
Example:
"#,#00.0#;(#,#00.0#)"
for negatives in parentheses.In negative patterns, the minimum and maximum counts are ignored; these are presumed to be set in the positive pattern.
- Parameters:
pattern
- a new pattern- Throws:
NullPointerException
- ifpattern
is nullIllegalArgumentException
- if the given pattern is invalid.
-
applyLocalizedPattern
Apply the given pattern to this Format object. The pattern is assumed to be in a localized notation. A pattern is a short-hand specification for the various formatting properties. These properties can also be changed individually through the various setter methods.The number of maximum integer digits is usually not derived from the pattern. See the note in the
Patterns
section for more detail. For negative numbers, use a second pattern, separated by a semicolonExample
"#,#00.0#"
→ 1,234.56This means a minimum of 2 integer digits, 1 fraction digit, and a maximum of 2 fraction digits.
Example:
"#,#00.0#;(#,#00.0#)"
for negatives in parentheses.In negative patterns, the minimum and maximum counts are ignored; these are presumed to be set in the positive pattern.
- Parameters:
pattern
- a new pattern- Throws:
NullPointerException
- ifpattern
is nullIllegalArgumentException
- if the given pattern is invalid.
-
setMaximumIntegerDigits
public void setMaximumIntegerDigits(int newValue) Sets the maximum number of digits allowed in the integer portion of a number. Negative input values are replaced with 0.- Overrides:
setMaximumIntegerDigits
in classNumberFormat
- Parameters:
newValue
- the maximum number of integer digits to be shown; if less than zero, then zero is used. The concrete subclass may enforce an upper limit to this value appropriate to the numeric type being formatted.- See Also:
-
setMinimumIntegerDigits
public void setMinimumIntegerDigits(int newValue) Sets the minimum number of digits allowed in the integer portion of a number. Negative input values are replaced with 0.- Overrides:
setMinimumIntegerDigits
in classNumberFormat
- Parameters:
newValue
- the minimum number of integer digits to be shown; if less than zero, then zero is used. The concrete subclass may enforce an upper limit to this value appropriate to the numeric type being formatted.- See Also:
-
setMaximumFractionDigits
public void setMaximumFractionDigits(int newValue) Sets the maximum number of digits allowed in the fraction portion of a number. Negative input values are replaced with 0.- Overrides:
setMaximumFractionDigits
in classNumberFormat
- Parameters:
newValue
- the maximum number of fraction digits to be shown; if less than zero, then zero is used. The concrete subclass may enforce an upper limit to this value appropriate to the numeric type being formatted.- See Also:
-
setMinimumFractionDigits
public void setMinimumFractionDigits(int newValue) Sets the minimum number of digits allowed in the fraction portion of a number. Negative input values are replaced with 0.- Overrides:
setMinimumFractionDigits
in classNumberFormat
- Parameters:
newValue
- the minimum number of fraction digits to be shown; if less than zero, then zero is used. The concrete subclass may enforce an upper limit to this value appropriate to the numeric type being formatted.- See Also:
-
getMaximumIntegerDigits
public int getMaximumIntegerDigits()Gets the maximum number of digits allowed in the integer portion of a number. The maximum number of integer digits can be set by eithersetMaximumIntegerDigits(int)
orapplyPattern(String)
. See thePattern Section
for comprehensive rules regarding maximum integer digits in patterns.- Overrides:
getMaximumIntegerDigits
in classNumberFormat
- Returns:
- the maximum number of digits
- See Also:
-
getMinimumIntegerDigits
public int getMinimumIntegerDigits()Gets the minimum number of digits allowed in the integer portion of a number.- Overrides:
getMinimumIntegerDigits
in classNumberFormat
- Returns:
- the minimum number of digits
- See Also:
-
getMaximumFractionDigits
public int getMaximumFractionDigits()Gets the maximum number of digits allowed in the fraction portion of a number.- Overrides:
getMaximumFractionDigits
in classNumberFormat
- Returns:
- the maximum number of digits.
- See Also:
-
getMinimumFractionDigits
public int getMinimumFractionDigits()Gets the minimum number of digits allowed in the fraction portion of a number.- Overrides:
getMinimumFractionDigits
in classNumberFormat
- Returns:
- the minimum number of digits
- See Also:
-
getCurrency
Gets the currency used by this decimal format when formatting currency values. The currency is obtained by callingDecimalFormatSymbols.getCurrency
on this number format's symbols.- Overrides:
getCurrency
in classNumberFormat
- Returns:
- the currency used by this decimal format, or
null
- Since:
- 1.4
-
setCurrency
Sets the currency used by this number format when formatting currency values. This does not update the minimum or maximum number of fraction digits used by the number format. The currency is set by callingDecimalFormatSymbols.setCurrency
on this number format's symbols.- Overrides:
setCurrency
in classNumberFormat
- Parameters:
currency
- the new currency to be used by this decimal format- Throws:
NullPointerException
- ifcurrency
is null- Since:
- 1.4
-
getRoundingMode
Gets theRoundingMode
used in this DecimalFormat.- Overrides:
getRoundingMode
in classNumberFormat
- Returns:
- The
RoundingMode
used for this DecimalFormat. - Since:
- 1.6
- See Also:
-
setRoundingMode
Sets theRoundingMode
used in this DecimalFormat.- Overrides:
setRoundingMode
in classNumberFormat
- Parameters:
roundingMode
- TheRoundingMode
to be used- Throws:
NullPointerException
- ifroundingMode
is null.- Since:
- 1.6
- See Also:
-