- All Implemented Interfaces:
- Serializable,- Cloneable
DecimalFormat is a concrete subclass of
 NumberFormat that formats decimal numbers. 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).  All of these can be localized.
 To obtain a NumberFormat for a specific locale, including the
 default locale, call one of NumberFormat's factory methods, such
 as getInstance().  In general, do not call the
 DecimalFormat constructors directly, since the
 NumberFormat factory methods may return subclasses other than
 DecimalFormat. If you need to customize the format object, do
 something like this:
 
NumberFormat numFormat = NumberFormat.getInstance(loc); if (numFormat instanceof DecimalFormat decFormat) { decFormat.setDecimalSeparatorAlwaysShown(true); }
A DecimalFormat comprises a pattern and a set of
 symbols.  The pattern may be set directly using
 applyPattern(), or indirectly using the API methods.  The
 symbols are stored in a DecimalFormatSymbols object.  When using
 the NumberFormat factory methods, the pattern and symbols are
 read from localized ResourceBundles.
 
Patterns
DecimalFormat patterns have the following syntax:
 
 Pattern:
         PositivePattern
         PositivePattern ; NegativePattern
 PositivePattern:
         Prefixopt Number Suffixopt
 NegativePattern:
         Prefixopt Number Suffixopt
 Prefix:
         any Unicode characters except U+FFFE, U+FFFF, and special characters
 Suffix:
         any Unicode characters except U+FFFE, U+FFFF, and special 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
 A DecimalFormat 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, then
 DecimalFormat 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.
 
The grouping separator is commonly used for thousands, but in some
 countries 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. So "#,##,###,####" == "######,####" ==
 "##,####,####".
 
Special Pattern Characters
Many characters in a pattern are taken literally; they are matched during parsing and output unchanged during formatting. Special characters, on the other hand, stand for other characters, strings, or classes of characters. They must be quoted, unless noted otherwise, if they are to appear in the prefix or suffix as literals.
The characters listed here are used in non-localized patterns.  Localized
 patterns use the corresponding characters taken from this formatter's
 DecimalFormatSymbols object instead, and these characters lose
 their special status.  Two exceptions are the currency sign and quote, which
 are not localized.
 
Symbol Location Localized? Meaning 0Number Yes Digit #Number Yes Digit, zero shows as absent .Number Yes Decimal separator or monetary decimal separator -Number Yes Minus sign ,Number Yes Grouping separator or monetary grouping separator ENumber Yes Separates mantissa and exponent in scientific notation. Need not be quoted in prefix or suffix. ;Subpattern boundary Yes Separates positive and negative subpatterns %Prefix or suffix Yes Multiply by 100 and show as percentage U+2030Prefix or suffix Yes Multiply by 1000 and show as per mille value ¤ ( U+00A4)Prefix or suffix No 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. 'Prefix or suffix No 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".
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 formattedIt 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.
Rounding
DecimalFormat provides rounding modes defined in
 RoundingMode for formatting.  By default, it uses
 RoundingMode.HALF_EVEN.
 Digits
For formatting,DecimalFormat uses the ten consecutive
 characters starting with the localized zero digit defined in the
 DecimalFormatSymbols object as digits. For parsing, these
 digits as well as all Unicode decimal digits, as defined by
 Character.digit, are recognized.
 Special Values
Not a Number(NaN) is formatted as a string, which typically has a
 single character U+FFFD.  This string is determined by the
 DecimalFormatSymbols object.  This is the only value for which
 the prefixes and suffixes are not used.
 
Infinity is formatted as a string, which typically has a single character
 U+221E, with the positive or negative prefixes and suffixes
 applied.  The infinity string is determined by the
 DecimalFormatSymbols object.
 
Negative zero ("-0") parses to
 
- BigDecimal(0)if- isParseBigDecimal()is true,
- Long(0)if- isParseBigDecimal()is false and- isParseIntegerOnly()is true,
- Double(-0.0)if both- isParseBigDecimal()and- isParseIntegerOnly()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.
Example
// Print out a number using the localized number, integer, currency, // and percent format for each locale Locale[] locales = NumberFormat.getAvailableLocales(); double myNumber = -1234.56; NumberFormat form; for (int j = 0; j < 4; ++j) { System.out.println("FORMAT"); for (Locale locale : locales) { if (locale.getCountry().length() == 0) { continue; // Skip language-only locales } System.out.print(locale.getDisplayName()); form = switch (j) { case 0 -> NumberFormat.getInstance(locale); case 1 -> NumberFormat.getIntegerInstance(locale); case 2 -> NumberFormat.getCurrencyInstance(locale); default -> NumberFormat.getPercentInstance(locale); }; if (form instanceof DecimalFormat decForm) { System.out.print(": " + decForm.toPattern()); } System.out.print(" -> " + form.format(myNumber)); try { System.out.println(" -> " + form.parse(form.format(myNumber))); } catch (ParseException e) {} } }
- Since:
- 1.1
- See Also:
- 
Nested Class SummaryNested classes/interfaces declared in class java.text.NumberFormatNumberFormat.Field, NumberFormat.Style
- 
Field SummaryFields declared in class java.text.NumberFormatFRACTION_FIELD, INTEGER_FIELD
- 
Constructor SummaryConstructorsConstructorDescriptionCreates a DecimalFormat using the default pattern and symbols for the defaultFORMATlocale.DecimalFormat(String pattern) Creates a DecimalFormat using the given pattern and the symbols for the defaultFORMATlocale.DecimalFormat(String pattern, DecimalFormatSymbols symbols) Creates a DecimalFormat using the given pattern and symbols.
- 
Method SummaryModifier and TypeMethodDescriptionvoidapplyLocalizedPattern(String pattern) Apply the given pattern to this Format object.voidapplyPattern(String pattern) Apply the given pattern to this Format object.clone()Standard override; no change in semantics.booleanOverrides equalsformat(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 StringBufferformat(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.intReturn the grouping size.intGets the maximum number of digits allowed in the fraction portion of a number.intGets the maximum number of digits allowed in the integer portion of a number.intGets the minimum number of digits allowed in the fraction portion of a number.intGets the minimum number of digits allowed in the integer portion of a number.intGets 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 theRoundingModeused in this DecimalFormat.inthashCode()Overrides hashCodebooleanAllows you to get the behavior of the decimal separator with integers.booleanReturns whether theparse(java.lang.String, java.text.ParsePosition)method returnsBigDecimal.parse(String text, ParsePosition pos) Parses text from a string to produce aNumber.voidsetCurrency(Currency currency) Sets the currency used by this number format when formatting currency values.voidsetDecimalFormatSymbols(DecimalFormatSymbols newSymbols) Sets the decimal format symbols, which is generally not changed by the programmer or user.voidsetDecimalSeparatorAlwaysShown(boolean newValue) Allows you to set the behavior of the decimal separator with integers.voidsetGroupingSize(int newValue) Set the grouping size.voidsetMaximumFractionDigits(int newValue) Sets the maximum number of digits allowed in the fraction portion of a number.voidsetMaximumIntegerDigits(int newValue) Sets the maximum number of digits allowed in the integer portion of a number.voidsetMinimumFractionDigits(int newValue) Sets the minimum number of digits allowed in the fraction portion of a number.voidsetMinimumIntegerDigits(int newValue) Sets the minimum number of digits allowed in the integer portion of a number.voidsetMultiplier(int newValue) Sets the multiplier for use in percent, per mille, and similar formats.voidsetNegativePrefix(String newValue) Set the negative prefix.voidsetNegativeSuffix(String newValue) Set the negative suffix.voidsetParseBigDecimal(boolean newValue) Sets whether theparse(java.lang.String, java.text.ParsePosition)method returnsBigDecimal.voidsetPositivePrefix(String newValue) Set the positive prefix.voidsetPositiveSuffix(String newValue) Set the positive suffix.voidsetRoundingMode(RoundingMode roundingMode) Sets theRoundingModeused in this DecimalFormat.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.Methods declared in class java.text.NumberFormatformat, format, getAvailableLocales, getCompactNumberInstance, getCompactNumberInstance, getCurrencyInstance, getCurrencyInstance, getInstance, getInstance, getIntegerInstance, getIntegerInstance, getNumberInstance, getNumberInstance, getPercentInstance, getPercentInstance, isGroupingUsed, isParseIntegerOnly, parse, parseObject, setGroupingUsed, setParseIntegerOnlyMethods declared in class java.text.Formatformat, parseObject
- 
Constructor Details- 
DecimalFormatpublic DecimalFormat()Creates a DecimalFormat using the default pattern and symbols for the defaultFORMATlocale. This is a convenient way to obtain a DecimalFormat when internationalization is not the main concern.To obtain standard formats for a given locale, use the factory methods on NumberFormat such as getNumberInstance. These factories will return the most appropriate sub-class of NumberFormat for a given locale. - See Also:
 
- 
DecimalFormatCreates a DecimalFormat using the given pattern and the symbols for the defaultFORMATlocale. This is a convenient way to obtain a DecimalFormat when internationalization is not the main concern.To obtain standard formats for a given locale, use the factory methods on NumberFormat such as getNumberInstance. These factories will return the most appropriate sub-class of NumberFormat for a given locale. - Parameters:
- pattern- a non-localized pattern string.
- Throws:
- NullPointerException- if- patternis null
- IllegalArgumentException- if the given pattern is invalid.
- See Also:
 
- 
DecimalFormatCreates a DecimalFormat using the given pattern and symbols. Use this constructor when you need to completely customize the behavior of the format.To obtain standard formats for a given locale, use the factory methods on NumberFormat such as getInstance or getCurrencyInstance. 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 string
- symbols- the set of symbols to be used
- Throws:
- NullPointerException- if any of the given arguments is null
- IllegalArgumentException- if the given pattern is invalid
- See Also:
 
 
- 
- 
Method Details- 
formatFormats a number and appends the resulting text to the given string buffer. The number can be of any subclass ofNumber.This implementation uses the maximum precision permitted. - Overrides:
- formatin class- NumberFormat
- Parameters:
- number- the number to format
- toAppendTo- the- StringBufferto which the formatted text is to be appended
- pos- keeps track on the position of the field within the returned string. For example, for formatting a number- 1234567.89in- Locale.USlocale, if the given- fieldPositionis- NumberFormat.INTEGER_FIELD, the begin index and end index of- fieldPositionwill be set to 0 and 9, respectively for the output string- 1,234,567.89.
- Returns:
- the value passed in as toAppendTo
- Throws:
- IllegalArgumentException- if- numberis null or not an instance of- Number.
- NullPointerException- if- toAppendToor- posis null
- ArithmeticException- if rounding is needed with rounding mode being set to RoundingMode.UNNECESSARY
- See Also:
 
- 
formatFormats a double to produce a string.- Specified by:
- formatin class- NumberFormat
- Parameters:
- number- The double to format
- result- where the text is to be appended
- fieldPosition- keeps track on the position of the field within the returned string. For example, for formatting a number- 1234567.89in- Locale.USlocale, if the given- fieldPositionis- NumberFormat.INTEGER_FIELD, the begin index and end index of- fieldPositionwill be set to 0 and 9, respectively for the output string- 1,234,567.89.
- Returns:
- The formatted number string
- Throws:
- NullPointerException- if- resultor- fieldPositionis- null
- ArithmeticException- if rounding is needed with rounding mode being set to RoundingMode.UNNECESSARY
- See Also:
 
- 
formatFormat a long to produce a string.- Specified by:
- formatin class- NumberFormat
- Parameters:
- number- The long to format
- result- where the text is to be appended
- fieldPosition- keeps track on the position of the field within the returned string. For example, for formatting a number- 123456789in- Locale.USlocale, if the given- fieldPositionis- NumberFormat.INTEGER_FIELD, the begin index and end index of- fieldPositionwill be set to 0 and 11, respectively for the output string- 123,456,789.
- Returns:
- The formatted number string
- Throws:
- NullPointerException- if- resultor- fieldPositionis- null
- ArithmeticException- if rounding is needed with rounding mode being set to RoundingMode.UNNECESSARY
- See Also:
 
- 
formatToCharacterIteratorFormats an Object producing anAttributedCharacterIterator. You can use the returnedAttributedCharacterIteratorto 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:
- formatToCharacterIteratorin class- Format
- 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
 
- 
parseParses text from a string to produce aNumber.The method attempts to parse text starting at the index given by pos. If parsing succeeds, then the index ofposis 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 updatedposcan be used to indicate the starting point for the next call to this method. If an error occurs, then the index ofposis not changed, the error index ofposis set to the index of the character where the error occurred, and null is returned.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 asLongobjects, no matter how they are written:"17"and"17.000"both parse toLong(17). Values that cannot fit into aLongare returned asDoubles. This includes values with a fractional part, infinite values,NaN, and the value -0.0.DecimalFormatdoes not decide whether to return aDoubleor aLongbased 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 NumbermethodsdoubleValue,longValue, etc., to obtain the type they want.
- If isParseBigDecimal()is true, values are returned asBigDecimalobjects. 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 asDoubleinstances holding the values of the correspondingDoubleconstants.
 DecimalFormatparses all Unicode characters that represent decimal digits, as defined byCharacter.digit(). In addition,DecimalFormatalso recognizes as digits the ten consecutive characters starting with the localized zero digit defined in theDecimalFormatSymbolsobject.- Specified by:
- parsein class- NumberFormat
- Parameters:
- text- the string to be parsed
- pos- A- ParsePositionobject with index and error index information as described above.
- Returns:
- the parsed value, or nullif the parse fails
- Throws:
- NullPointerException- if- textor- posis null.
- See Also:
 
- If 
- 
getDecimalFormatSymbolsReturns 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:
 
- 
setDecimalFormatSymbolsSets the decimal format symbols, which is generally not changed by the programmer or user.- Parameters:
- newSymbols- desired DecimalFormatSymbols
- See Also:
 
- 
getPositivePrefixGet the positive prefix.Examples: +123, $123, sFr123 - Returns:
- the positive prefix
 
- 
setPositivePrefixSet the positive prefix.Examples: +123, $123, sFr123 - Parameters:
- newValue- the new positive prefix
 
- 
getNegativePrefixGet the negative prefix.Examples: -123, ($123) (with negative suffix), sFr-123 - Returns:
- the negative prefix
 
- 
setNegativePrefixSet the negative prefix.Examples: -123, ($123) (with negative suffix), sFr-123 - Parameters:
- newValue- the new negative prefix
 
- 
getPositiveSuffixGet the positive suffix.Example: 123% - Returns:
- the positive suffix
 
- 
setPositiveSuffixSet the positive suffix.Example: 123% - Parameters:
- newValue- the new positive suffix
 
- 
getNegativeSuffixGet the negative suffix.Examples: -123%, ($123) (with positive suffixes) - Returns:
- the negative suffix
 
- 
setNegativeSuffixSet the negative suffix.Examples: 123% - Parameters:
- newValue- the new negative suffix
 
- 
getMultiplierpublic int getMultiplier()Gets the multiplier for use in percent, per mille, and similar formats.- Returns:
- the multiplier
- See Also:
 
- 
setMultiplierpublic 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. - Parameters:
- newValue- the new multiplier
- See Also:
 
- 
getGroupingSizepublic 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:
 
- 
setGroupingSizepublic 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- if- newValueis negative or greater than- Byte.MAX_VALUE
- See Also:
 
- 
isDecimalSeparatorAlwaysShownpublic 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:
- trueif the decimal separator is always shown;- falseotherwise
 
- 
setDecimalSeparatorAlwaysShownpublic 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-- trueif the decimal separator is always shown;- falseotherwise
 
- 
isParseBigDecimalpublic boolean isParseBigDecimal()Returns whether theparse(java.lang.String, java.text.ParsePosition)method returnsBigDecimal. The default value is false.- Returns:
- trueif the parse method returns BigDecimal;- falseotherwise
- Since:
- 1.5
- See Also:
 
- 
setParseBigDecimalpublic void setParseBigDecimal(boolean newValue) Sets whether theparse(java.lang.String, java.text.ParsePosition)method returnsBigDecimal.- Parameters:
- newValue-- trueif the parse method returns BigDecimal;- falseotherwise
- Since:
- 1.5
- See Also:
 
- 
cloneStandard override; no change in semantics.- Overrides:
- clonein class- NumberFormat
- Returns:
- a clone of this instance.
- See Also:
 
- 
equalsOverrides equals- Overrides:
- equalsin class- NumberFormat
- Parameters:
- obj- the reference object with which to compare.
- Returns:
- trueif this object is the same as the obj argument;- falseotherwise.
- See Also:
 
- 
hashCodepublic int hashCode()Overrides hashCode- Overrides:
- hashCodein class- NumberFormat
- Returns:
- a hash code value for this object.
- See Also:
 
- 
toPatternSynthesizes a pattern string that represents the current state of this Format object.- Returns:
- a pattern string
- See Also:
 
- 
toLocalizedPatternSynthesizes a localized pattern string that represents the current state of this Format object.- Returns:
- a localized pattern string
- See Also:
 
- 
applyPatternApply 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.There is no limit to integer digits set by this routine, since that is the typical end-user desire; use setMaximumInteger if you want to set a real value. For negative numbers, use a second pattern, separated by a semicolon Example "#,#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- if- patternis null
- IllegalArgumentException- if the given pattern is invalid.
 
- 
applyLocalizedPatternApply 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.There is no limit to integer digits set by this routine, since that is the typical end-user desire; use setMaximumInteger if you want to set a real value. For negative numbers, use a second pattern, separated by a semicolon Example "#,#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- if- patternis null
- IllegalArgumentException- if the given pattern is invalid.
 
- 
setMaximumIntegerDigitspublic void setMaximumIntegerDigits(int newValue) Sets the maximum number of digits allowed in the integer portion of a number. For formatting numbers other thanBigIntegerandBigDecimalobjects, the lower ofnewValueand 309 is used. Negative input values are replaced with 0.- Overrides:
- setMaximumIntegerDigitsin class- NumberFormat
- 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:
 
- 
setMinimumIntegerDigitspublic void setMinimumIntegerDigits(int newValue) Sets the minimum number of digits allowed in the integer portion of a number. For formatting numbers other thanBigIntegerandBigDecimalobjects, the lower ofnewValueand 309 is used. Negative input values are replaced with 0.- Overrides:
- setMinimumIntegerDigitsin class- NumberFormat
- 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:
 
- 
setMaximumFractionDigitspublic void setMaximumFractionDigits(int newValue) Sets the maximum number of digits allowed in the fraction portion of a number. For formatting numbers other thanBigIntegerandBigDecimalobjects, the lower ofnewValueand 340 is used. Negative input values are replaced with 0.- Overrides:
- setMaximumFractionDigitsin class- NumberFormat
- 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:
 
- 
setMinimumFractionDigitspublic void setMinimumFractionDigits(int newValue) Sets the minimum number of digits allowed in the fraction portion of a number. For formatting numbers other thanBigIntegerandBigDecimalobjects, the lower ofnewValueand 340 is used. Negative input values are replaced with 0.- Overrides:
- setMinimumFractionDigitsin class- NumberFormat
- 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:
 
- 
getMaximumIntegerDigitspublic int getMaximumIntegerDigits()Gets the maximum number of digits allowed in the integer portion of a number. For formatting numbers other thanBigIntegerandBigDecimalobjects, the lower of the return value and 309 is used.- Overrides:
- getMaximumIntegerDigitsin class- NumberFormat
- Returns:
- the maximum number of digits
- See Also:
 
- 
getMinimumIntegerDigitspublic int getMinimumIntegerDigits()Gets the minimum number of digits allowed in the integer portion of a number. For formatting numbers other thanBigIntegerandBigDecimalobjects, the lower of the return value and 309 is used.- Overrides:
- getMinimumIntegerDigitsin class- NumberFormat
- Returns:
- the minimum number of digits
- See Also:
 
- 
getMaximumFractionDigitspublic int getMaximumFractionDigits()Gets the maximum number of digits allowed in the fraction portion of a number. For formatting numbers other thanBigIntegerandBigDecimalobjects, the lower of the return value and 340 is used.- Overrides:
- getMaximumFractionDigitsin class- NumberFormat
- Returns:
- the maximum number of digits.
- See Also:
 
- 
getMinimumFractionDigitspublic int getMinimumFractionDigits()Gets the minimum number of digits allowed in the fraction portion of a number. For formatting numbers other thanBigIntegerandBigDecimalobjects, the lower of the return value and 340 is used.- Overrides:
- getMinimumFractionDigitsin class- NumberFormat
- Returns:
- the minimum number of digits
- See Also:
 
- 
getCurrencyGets the currency used by this decimal format when formatting currency values. The currency is obtained by callingDecimalFormatSymbols.getCurrencyon this number format's symbols.- Overrides:
- getCurrencyin class- NumberFormat
- Returns:
- the currency used by this decimal format, or null
- Since:
- 1.4
 
- 
setCurrencySets 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.setCurrencyon this number format's symbols.- Overrides:
- setCurrencyin class- NumberFormat
- Parameters:
- currency- the new currency to be used by this decimal format
- Throws:
- NullPointerException- if- currencyis null
- Since:
- 1.4
 
- 
getRoundingModeGets theRoundingModeused in this DecimalFormat.- Overrides:
- getRoundingModein class- NumberFormat
- Returns:
- The RoundingModeused for this DecimalFormat.
- Since:
- 1.6
- See Also:
 
- 
setRoundingModeSets theRoundingModeused in this DecimalFormat.- Overrides:
- setRoundingModein class- NumberFormat
- Parameters:
- roundingMode- The- RoundingModeto be used
- Throws:
- NullPointerException- if- roundingModeis null.
- Since:
- 1.6
- See Also:
 
 
-