Skip to content

Most visited

Recently visited

navigation
Added in API level 1

DecimalFormat

public class DecimalFormat
extends NumberFormat

java.lang.Object
   ↳ java.text.Format
     ↳ java.text.NumberFormat
       ↳ java.text.DecimalFormat


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, or Indic digits. It also supports different flavors of numbers, including integers ("123"), fixed-point numbers ("123.4"), scientific notation ("1.23E4"), percentages ("12%"), and currency amounts ("$123"). All of these flavors can be easily localized.

This is an enhanced version of DecimalFormat that is based on the standard version in the RI. New or changed functionality is labeled NEW.

To obtain a NumberFormat for a specific locale (including the default locale), call one of NumberFormat's factory methods such as NumberFormat.getInstance. Do not call the DecimalFormat constructors directly, unless you know what you are doing, since the NumberFormat factory methods may return subclasses other than DecimalFormat. If you need to customize the format object, do something like this:

 NumberFormat f = NumberFormat.getInstance(loc);
 if (f instanceof DecimalFormat) {
     ((DecimalFormat)f).setDecimalSeparatorAlwaysShown(true);
 }
 

Patterns

A DecimalFormat consists of a pattern and a set of symbols. The pattern may be set directly using applyPattern(String), or indirectly using other API methods which manipulate aspects of the pattern, such as the minimum number of integer digits. The symbols are stored in a DecimalFormatSymbols object. When using the NumberFormat factory methods, the pattern and symbols are read from ICU's locale data.

Special Pattern Characters

Many characters in a pattern are taken literally; they are matched during parsing and are written out unchanged during formatting. On the other hand, special characters stand for other characters, strings, or classes of characters. For example, the '#' character is replaced by a localized digit. Often the replacement character is the same as the pattern character; in the U.S. locale, the ',' grouping character is replaced by ','. However, the replacement is still happening, and if the symbols are modified, the grouping character changes. Some special characters affect the behavior of the formatter by their presence; for example, if the percent character is seen, then the value is multiplied by 100 before being displayed.

To insert a special character in a pattern as a literal, that is, without any special meaning, the character must be quoted. There are some exceptions to this which are noted below.

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
0 Number Yes Digit.
@ Number No NEW  Significant digit.
# Number Yes Digit, leading zeroes are not shown.
. Number Yes Decimal separator or monetary decimal separator.
- Number Yes Minus sign.
, Number Yes Grouping separator.
E Number Yes Separates mantissa and exponent in scientific notation. Does not need to be quoted in prefix or suffix.
+ Exponent Yes NEW  Prefix positive exponents with localized plus sign. Does not need to 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.
(\u2030) Prefix or suffix Yes Multiply by 1000 and show as per mille.
¤ (\u00A4) 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 separator is used instead of the decimal separator.
' 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".
* Prefix or suffix boundary Yes NEW  Pad escape, precedes pad character.

A DecimalFormat pattern contains a positive and negative subpattern, for example, "#,##0.00;(#,##0.00)". Each subpattern has a prefix, a numeric part and a suffix. If there is no explicit negative subpattern, the negative subpattern is the localized minus sign prefixed to the positive 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 ignored in the negative subpattern. This means that "#,##0.0#;(#)" produces precisely the same result as "#,##0.0#;(#,##0.0#)".

The prefixes, suffixes, and various symbols used for infinity, digits, thousands 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 parse(String) to be able to distinguish positive from negative values. Another example is that the decimal separator and thousands separator should be distinct characters, or parsing will be impossible.

The grouping separator is a character that separates clusters of integer digits to make large numbers more legible. It is commonly used for thousands, but in some locales it separates ten-thousands. The grouping size is the number of digits between the grouping separators, such as 3 for "100,000,000" or 4 for "1 0000 0000". There are actually two different grouping sizes: One used for the least significant integer digits, the primary grouping size, and one used for all others, the secondary grouping size. In most locales these are the same, but sometimes they are different. For example, if the primary grouping interval is 3, and the secondary is 2, then this corresponds to the pattern "#,##,##0", and the number 123456789 is formatted as "12,34,56,789". If a pattern contains multiple grouping separators, the interval between the last one and the end of the integer defines the primary grouping size, and the interval between the last two defines the secondary grouping size. All others are ignored, so "#,##,###,####", "###,###,####" and "##,#,###,####" produce the same result.

Illegal patterns, such as "#.#.#" or "#.###,###", will cause DecimalFormat to throw an IllegalArgumentException with a message that describes the problem.

Pattern BNF

 pattern    := subpattern (';' subpattern)?
 subpattern := prefix? number exponent? suffix?
 number     := (integer ('.' fraction)?) | sigDigits
 prefix     := '\\u0000'..'\\uFFFD' - specialCharacters
 suffix     := '\\u0000'..'\\uFFFD' - specialCharacters
 integer    := '#'* '0'* '0'
 fraction   := '0'* '#'*
 sigDigits  := '#'* '@' '@'* '#'*
 exponent   := 'E' '+'? '0'* '0'
 padSpec    := '*' padChar
 padChar    := '\\u0000'..'\\uFFFD' - quote

 Notation:
   X*       0 or more instances of X
   X?       0 or 1 instances of X
   X|Y      either X or Y
   C..D     any character from C up to D, inclusive
   S-T      characters in S, except those in T
 
The first subpattern is for positive numbers. The second (optional) subpattern is for negative numbers.

Not indicated in the BNF syntax above:

Parsing

DecimalFormat parses all Unicode characters that represent decimal digits, as defined by digit(int, int). In addition, DecimalFormat also recognizes as digits the ten consecutive characters starting with the localized zero digit defined in the DecimalFormatSymbols object. During formatting, the DecimalFormatSymbols-based digits are written out.

During parsing, grouping separators are ignored.

If parse(String, ParsePosition) fails to parse a string, it returns null and leaves the parse position unchanged.

Formatting

Formatting is guided by several parameters, all of which can be specified either using a pattern or using the API. The following description applies to formats that do not use scientific notation or significant digits.

Special Values

NaN is represented as a single character, typically \uFFFD. This character is determined by the DecimalFormatSymbols object. This is the only value for which the prefixes and suffixes are not used.

Infinity is represented as a single character, typically \u221E, with the positive or negative prefixes and suffixes applied. The infinity character is determined by the DecimalFormatSymbols object.

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 103. The mantissa is typically in the half-open interval [1.0, 10.0) or sometimes [0.0, 1.0), but it does not need to be. DecimalFormat supports arbitrary mantissas. DecimalFormat can be instructed to use scientific notation through the API or through the pattern. 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".

NEW  Significant Digits

DecimalFormat has two ways of controlling how many digits are shown: (a) significant digit counts or (b) integer and fraction digit counts. Integer and fraction digit counts are described above. When a formatter uses significant digits counts, the number of integer and fraction digits is not specified directly, and the formatter settings for these counts are ignored. Instead, the formatter uses as many integer and fraction digits as required to display the specified number of significant digits.

Examples:
Pattern Minimum significant digits Maximum significant digits Number Output of format()
@@@ 3 3 12345 12300
@@@ 3 3 0.12345 0.123
@@## 2 4 3.14159 3.142
@@## 2 4 1.23004 1.23

NEW  Padding

DecimalFormat supports padding the result of format to a specific width. Padding may be specified either through the API or through the pattern syntax. In a pattern, the pad escape character followed by a single pad character causes padding to be parsed and formatted. The pad escape character is '*' in unlocalized patterns. For example, "$*x#,##0.00" formats 123 to "$xx123.00", and 1234 to "$1,234.00".

Serialization

Features marked as NEW and patterns that use characters not documented above are unlikely to serialize/deserialize correctly.

Synchronization

DecimalFormat objects are not synchronized. Multiple threads should not access one formatter concurrently.

See also:

Summary

Inherited constants

From class java.text.NumberFormat

Public constructors

DecimalFormat()

Constructs a new DecimalFormat for formatting and parsing numbers for the user's default locale.

DecimalFormat(String pattern)

Constructs a new DecimalFormat using the specified non-localized pattern and the DecimalFormatSymbols for the user's default Locale.

DecimalFormat(String pattern, DecimalFormatSymbols value)

Constructs a new DecimalFormat using the specified non-localized pattern and DecimalFormatSymbols.

Public methods

void applyLocalizedPattern(String pattern)

Changes the pattern of this decimal format to the specified pattern which uses localized pattern characters.

void applyPattern(String pattern)

Changes the pattern of this decimal format to the specified pattern which uses non-localized pattern characters.

Object clone()

Returns a new instance of DecimalFormat with the same pattern and properties.

boolean equals(Object object)

Compares the specified object to this decimal format and indicates if they are equal.

StringBuffer format(long value, StringBuffer buffer, FieldPosition position)

Formats the specified long value as a string using the pattern of this number format and appends the string to the specified string buffer.

StringBuffer format(double value, StringBuffer buffer, FieldPosition position)

Formats the specified double value as a string using the pattern of this number format and appends the string to the specified string buffer.

final StringBuffer format(Object number, StringBuffer buffer, FieldPosition position)

Formats a number into a supplied buffer.

AttributedCharacterIterator formatToCharacterIterator(Object object)

Formats the specified object using the rules of this decimal format and returns an AttributedCharacterIterator with the formatted number and attributes.

Currency getCurrency()

Returns the currency used by this decimal format.

DecimalFormatSymbols getDecimalFormatSymbols()

Returns the DecimalFormatSymbols used by this decimal format.

int getGroupingSize()

Returns the number of digits grouped together by the grouping separator.

int getMultiplier()

Returns the multiplier which is applied to the number before formatting or after parsing.

String getNegativePrefix()

Returns the prefix which is formatted or parsed before a negative number.

String getNegativeSuffix()

Returns the suffix which is formatted or parsed after a negative number.

String getPositivePrefix()

Returns the prefix which is formatted or parsed before a positive number.

String getPositiveSuffix()

Returns the suffix which is formatted or parsed after a positive number.

RoundingMode getRoundingMode()

Returns the RoundingMode used by this NumberFormat.

int hashCode()

Returns an integer hash code for this object.

boolean isDecimalSeparatorAlwaysShown()

Indicates whether the decimal separator is shown when there are no fractional digits.

boolean isGroupingUsed()

Returns true if digit grouping is used in this format.

boolean isParseBigDecimal()

This value indicates whether the return object of the parse operation is of type BigDecimal.

boolean isParseIntegerOnly()

Returns true if this number format only parses integer numbers.

Number parse(String string, ParsePosition position)

Parses a Long or Double from the specified string starting at the index specified by position.

void setCurrency(Currency currency)

Sets the currency used by this decimal format.

void setDecimalFormatSymbols(DecimalFormatSymbols value)

Sets the DecimalFormatSymbols used by this decimal format.

void setDecimalSeparatorAlwaysShown(boolean value)

Sets whether the decimal separator is shown even when there are no fractional digits.

void setGroupingSize(int value)

Sets the number of digits grouped together by the grouping separator.

void setGroupingUsed(boolean value)

Sets whether or not digit grouping will be used in this format.

void setMaximumFractionDigits(int value)

Sets the maximum number of digits after the decimal point.

void setMaximumIntegerDigits(int value)

Sets the maximum number of digits before the decimal point.

void setMinimumFractionDigits(int value)

Sets the minimum number of digits after the decimal point.

void setMinimumIntegerDigits(int value)

Sets the minimum number of digits before the decimal point.

void setMultiplier(int value)

Sets the multiplier which is applied to the number before formatting or after parsing.

void setNegativePrefix(String value)

Sets the prefix which is formatted or parsed before a negative number.

void setNegativeSuffix(String value)

Sets the suffix which is formatted or parsed after a negative number.

void setParseBigDecimal(boolean newValue)

Sets the behavior of the parse method.

void setParseIntegerOnly(boolean value)

Sets the flag that indicates whether numbers will be parsed as integers.

void setPositivePrefix(String value)

Sets the prefix which is formatted or parsed before a positive number.

void setPositiveSuffix(String value)

Sets the suffix which is formatted or parsed after a positive number.

void setRoundingMode(RoundingMode roundingMode)

Sets the RoundingMode used by this NumberFormat.

String toLocalizedPattern()

Returns the pattern of this decimal format using localized pattern characters.

String toPattern()

Returns the pattern of this decimal format using non-localized pattern characters.

String toString()

Returns a string containing a concise, human-readable description of this object.

Inherited methods

From class java.text.NumberFormat
From class java.text.Format
From class java.lang.Object

Public constructors

DecimalFormat

Added in API level 1
DecimalFormat ()

Constructs a new DecimalFormat for formatting and parsing numbers for the user's default locale. See "Be wary of the default locale".

DecimalFormat

Added in API level 1
DecimalFormat (String pattern)

Constructs a new DecimalFormat using the specified non-localized pattern and the DecimalFormatSymbols for the user's default Locale. See "Be wary of the default locale".

Parameters
pattern String: the non-localized pattern.
Throws
IllegalArgumentException if the pattern cannot be parsed.

DecimalFormat

Added in API level 1
DecimalFormat (String pattern, 
                DecimalFormatSymbols value)

Constructs a new DecimalFormat using the specified non-localized pattern and DecimalFormatSymbols.

Parameters
pattern String: the non-localized pattern.
value DecimalFormatSymbols: the DecimalFormatSymbols.
Throws
IllegalArgumentException if the pattern cannot be parsed.

Public methods

applyLocalizedPattern

Added in API level 1
void applyLocalizedPattern (String pattern)

Changes the pattern of this decimal format to the specified pattern which uses localized pattern characters.

Parameters
pattern String: the localized pattern.
Throws
IllegalArgumentException if the pattern cannot be parsed.

applyPattern

Added in API level 1
void applyPattern (String pattern)

Changes the pattern of this decimal format to the specified pattern which uses non-localized pattern characters.

Parameters
pattern String: the non-localized pattern.
Throws
IllegalArgumentException if the pattern cannot be parsed.

clone

Added in API level 1
Object clone ()

Returns a new instance of DecimalFormat with the same pattern and properties.

Returns
Object a shallow copy of this format.

equals

Added in API level 1
boolean equals (Object object)

Compares the specified object to this decimal format and indicates if they are equal. In order to be equal, object must be an instance of DecimalFormat with the same pattern and properties.

Parameters
object Object: the object to compare with this object.
Returns
boolean true if the specified object is equal to this decimal format; false otherwise.

See also:

format

Added in API level 1
StringBuffer format (long value, 
                StringBuffer buffer, 
                FieldPosition position)

Formats the specified long value as a string using the pattern of this number format and appends the string to the specified string buffer.

If the field member of position contains a value specifying a format field, then its beginIndex and endIndex members will be updated with the position of the first occurrence of this field in the formatted text.

Parameters
value long: the long to format.
buffer StringBuffer: the target string buffer to append the formatted long value to.
position FieldPosition: on input: an optional alignment field; on output: the offsets of the alignment field in the formatted text.
Returns
StringBuffer the string buffer.

format

Added in API level 1
StringBuffer format (double value, 
                StringBuffer buffer, 
                FieldPosition position)

Formats the specified double value as a string using the pattern of this number format and appends the string to the specified string buffer.

If the field member of position contains a value specifying a format field, then its beginIndex and endIndex members will be updated with the position of the first occurrence of this field in the formatted text.

Parameters
value double: the double to format.
buffer StringBuffer: the target string buffer to append the formatted double value to.
position FieldPosition: on input: an optional alignment field; on output: the offsets of the alignment field in the formatted text.
Returns
StringBuffer the string buffer.

format

Added in API level 1
StringBuffer format (Object number, 
                StringBuffer buffer, 
                FieldPosition position)

Formats a number into a supplied buffer.

The number must be a subclass of Number. Instances of Byte, Short, Integer, and Long have Number.longValue invoked, as do instances of BigInteger where BigInteger.bitLength returns less than 64. All other values have Number.doubleValue invoked instead.

If the field member of field contains a value specifying a format field, then its beginIndex and endIndex members will be updated with the position of the first occurrence of this field in the formatted text.

Parameters
number Object: the object to format, must be a Number.
buffer StringBuffer: the target string buffer to append the formatted number to.
position FieldPosition: on input: an optional alignment field; on output: the offsets of the alignment field in the formatted text.
Returns
StringBuffer the string buffer.

formatToCharacterIterator

Added in API level 1
AttributedCharacterIterator formatToCharacterIterator (Object object)

Formats the specified object using the rules of this decimal format and returns an AttributedCharacterIterator with the formatted number and attributes.

Parameters
object Object: the object to format.
Returns
AttributedCharacterIterator an AttributedCharacterIterator with the formatted number and attributes.
Throws
IllegalArgumentException if object cannot be formatted by this format.
NullPointerException if object is null.

getCurrency

Added in API level 1
Currency getCurrency ()

Returns the currency used by this decimal format.

Returns
Currency the currency used by this decimal format.

See also:

getDecimalFormatSymbols

Added in API level 1
DecimalFormatSymbols getDecimalFormatSymbols ()

Returns the DecimalFormatSymbols used by this decimal format.

Returns
DecimalFormatSymbols a copy of the DecimalFormatSymbols used by this decimal format.

getGroupingSize

Added in API level 1
int getGroupingSize ()

Returns the number of digits grouped together by the grouping separator. This only allows to get the primary grouping size. There is no API to get the secondary grouping size.

Returns
int the number of digits grouped together.

getMultiplier

Added in API level 1
int getMultiplier ()

Returns the multiplier which is applied to the number before formatting or after parsing. The multiplier is meant for tasks like parsing percentages. For example, given a multiplier of 100, 1.23 would be formatted as "123" and "123" would be parsed as 1.23.

Returns
int

getNegativePrefix

Added in API level 1
String getNegativePrefix ()

Returns the prefix which is formatted or parsed before a negative number.

Returns
String the negative prefix.

getNegativeSuffix

Added in API level 1
String getNegativeSuffix ()

Returns the suffix which is formatted or parsed after a negative number.

Returns
String the negative suffix.

getPositivePrefix

Added in API level 1
String getPositivePrefix ()

Returns the prefix which is formatted or parsed before a positive number.

Returns
String the positive prefix.

getPositiveSuffix

Added in API level 1
String getPositiveSuffix ()

Returns the suffix which is formatted or parsed after a positive number.

Returns
String the positive suffix.

getRoundingMode

Added in API level 9
RoundingMode getRoundingMode ()

Returns the RoundingMode used by this NumberFormat.

Returns
RoundingMode

hashCode

Added in API level 1
int hashCode ()

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
int this object's hash code.

isDecimalSeparatorAlwaysShown

Added in API level 1
boolean isDecimalSeparatorAlwaysShown ()

Indicates whether the decimal separator is shown when there are no fractional digits.

Returns
boolean true if the decimal separator should always be formatted; false otherwise.

isGroupingUsed

Added in API level 1
boolean isGroupingUsed ()

Returns true if digit grouping is used in this format. Grouping affects both formatting and parsing.

Returns
boolean true if a grouping separator is used; false otherwise.

isParseBigDecimal

Added in API level 1
boolean isParseBigDecimal ()

This value indicates whether the return object of the parse operation is of type BigDecimal. This value defaults to false.

Returns
boolean true if parse always returns BigDecimals, false if the type of the result is Long or Double.

isParseIntegerOnly

Added in API level 1
boolean isParseIntegerOnly ()

Returns true if this number format only parses integer numbers. Parsing stops if a decimal separator is encountered.

Returns
boolean

parse

Added in API level 1
Number parse (String string, 
                ParsePosition position)

Parses a Long or Double from the specified string starting at the index specified by position. If the string is successfully parsed then the index of the ParsePosition is updated to the index following the parsed text. On error, the index is unchanged and the error index of ParsePosition is set to the index where the error occurred.

Parameters
string String: the string to parse.
position ParsePosition: input/output parameter, specifies the start index in string from where to start parsing. If parsing is successful, it is updated with the index following the parsed text; on error, the index is unchanged and the error index is set to the index where the error occurred.
Returns
Number a Long or Double resulting from the parse or null if there is an error. The result will be a Long if the parsed number is an integer in the range of a long, otherwise the result is a Double. If isParseBigDecimal is true then it returns the result as a BigDecimal.

setCurrency

Added in API level 1
void setCurrency (Currency currency)

Sets the currency used by this decimal format. The min and max fraction digits remain the same.

Parameters
currency Currency: the new currency.

setDecimalFormatSymbols

Added in API level 1
void setDecimalFormatSymbols (DecimalFormatSymbols value)

Sets the DecimalFormatSymbols used by this decimal format.

Parameters
value DecimalFormatSymbols

setDecimalSeparatorAlwaysShown

Added in API level 1
void setDecimalSeparatorAlwaysShown (boolean value)

Sets whether the decimal separator is shown even when there are no fractional digits.

Parameters
value boolean

setGroupingSize

Added in API level 1
void setGroupingSize (int value)

Sets the number of digits grouped together by the grouping separator. This only allows to set the primary grouping size; the secondary grouping size can only be set with a pattern.

Parameters
value int

setGroupingUsed

Added in API level 1
void setGroupingUsed (boolean value)

Sets whether or not digit grouping will be used in this format. Grouping affects both formatting and parsing.

Parameters
value boolean: true if a grouping separator is used; false otherwise.

setMaximumFractionDigits

Added in API level 1
void setMaximumFractionDigits (int value)

Sets the maximum number of digits after the decimal point. If the value passed is negative then it is replaced by 0. Regardless of this setting, no more than 340 digits will be used.

Parameters
value int: the maximum number of fraction digits.

setMaximumIntegerDigits

Added in API level 1
void setMaximumIntegerDigits (int value)

Sets the maximum number of digits before the decimal point. If the value passed is negative then it is replaced by 0. Regardless of this setting, no more than 309 digits will be used.

Parameters
value int: the new maximum number of integer numerals for display.

setMinimumFractionDigits

Added in API level 1
void setMinimumFractionDigits (int value)

Sets the minimum number of digits after the decimal point. If the value passed is negative then it is replaced by 0. Regardless of this setting, no more than 340 digits will be used.

Parameters
value int: the minimum number of fraction digits.

setMinimumIntegerDigits

Added in API level 1
void setMinimumIntegerDigits (int value)

Sets the minimum number of digits before the decimal point. If the value passed is negative then it is replaced by 0. Regardless of this setting, no more than 309 digits will be used.

Parameters
value int: the minimum number of integer digits.

setMultiplier

Added in API level 1
void setMultiplier (int value)

Sets the multiplier which is applied to the number before formatting or after parsing. The multiplier meant for tasks like parsing percentages. For example, given a multiplier of 100, 1.23 would be formatted as "123" and "123" would be parsed as 1.23.

Parameters
value int

setNegativePrefix

Added in API level 1
void setNegativePrefix (String value)

Sets the prefix which is formatted or parsed before a negative number.

Parameters
value String

setNegativeSuffix

Added in API level 1
void setNegativeSuffix (String value)

Sets the suffix which is formatted or parsed after a negative number.

Parameters
value String

setParseBigDecimal

Added in API level 1
void setParseBigDecimal (boolean newValue)

Sets the behavior of the parse method. If set to true then all the returned objects will be of type BigDecimal.

Parameters
newValue boolean: true if all the returned objects should be of type BigDecimal; false otherwise.

setParseIntegerOnly

Added in API level 1
void setParseIntegerOnly (boolean value)

Sets the flag that indicates whether numbers will be parsed as integers. When this decimal format is used for parsing and this value is set to true, then the resulting numbers will be of type java.lang.Integer. Special cases are NaN, positive and negative infinity, which are still returned as java.lang.Double.

Parameters
value boolean: true that the resulting numbers of parse operations will be of type java.lang.Integer except for the special cases described above.

setPositivePrefix

Added in API level 1
void setPositivePrefix (String value)

Sets the prefix which is formatted or parsed before a positive number.

Parameters
value String

setPositiveSuffix

Added in API level 1
void setPositiveSuffix (String value)

Sets the suffix which is formatted or parsed after a positive number.

Parameters
value String

setRoundingMode

Added in API level 9
void setRoundingMode (RoundingMode roundingMode)

Sets the RoundingMode used by this NumberFormat.

Parameters
roundingMode RoundingMode

toLocalizedPattern

Added in API level 1
String toLocalizedPattern ()

Returns the pattern of this decimal format using localized pattern characters.

Returns
String the localized pattern.

toPattern

Added in API level 1
String toPattern ()

Returns the pattern of this decimal format using non-localized pattern characters.

Returns
String the non-localized pattern.

toString

Added in API level 1
String toString ()

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
String a printable representation of this object.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.