# NumberFormat

public abstract class **NumberFormat** extends [Format](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/Format.html)  

|---|---|---|
| Known Direct Subclasses [ChoiceFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html) |---|---| | [ChoiceFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html) | A `ChoiceFormat` allows you to attach a format to a range of numbers. | |||

`NumberFormat` is the abstract base class for all number
formats. This class provides the interface for formatting and parsing
numbers. `NumberFormat` also provides methods for determining
which locales have number formats, and what their names are.


`NumberFormat` helps you to format and parse numbers for any locale.
Your code can be completely independent of the locale conventions for
decimal points, thousands-separators, or even the particular decimal
digits used, or whether the number format is even decimal.


To format a number for the current Locale, use one of the factory
class methods:
>
> ```
>   myString = NumberFormat.getInstance().format(myNumber);
>  
> ```
If you are formatting multiple numbers, it is more efficient to get the format and use it multiple times so that the system doesn't have to fetch the information about the local language and country conventions multiple times.
>
> ```
>  NumberFormat nf = NumberFormat.getInstance();
>  for (int i = 0; i < myNumber.length; ++i) {
>      output.println(nf.format(myNumber[i]) + "; ");
>  }
>  
> ```
To format a number for a different Locale, specify it in the call to `getInstance`.
>
> ```
>  NumberFormat nf = NumberFormat.getInstance(Locale.FRENCH);
>  
> ```
You can also use a `NumberFormat` to parse numbers:
>
> ```
>  myNumber = nf.parse(myString);
>  
> ```
Use `getInstance` or `getNumberInstance` to get the normal number format. Use `getIntegerInstance` to get an integer number format. Use `getCurrencyInstance` to get the currency number format. And use `getPercentInstance` to get a format for displaying percentages. With this format, a fraction like 0.53 is displayed as 53%.


You can also control the display of numbers with such methods as
`setMinimumFractionDigits`.
If you want even more control over the format or parsing,
or want to give your users more control,
you can try casting the `NumberFormat` you get from the factory methods
to a `DecimalFormat`. This will work for the vast majority
of locales; just remember to put it in a `try` block in case you
encounter an unusual one.


NumberFormat and DecimalFormat are designed such that some controls
work for formatting and others work for parsing. The following is
the detailed description for each these control methods,


setParseIntegerOnly : only affects parsing, e.g.
if true, "3456.78" -\> 3456 (and leaves the parse position just after index 6)
if false, "3456.78" -\> 3456.78 (and leaves the parse position just after index 8)
This is independent of formatting. If you want to not show a decimal point
where there might be no digits after the decimal point, use
setDecimalSeparatorAlwaysShown.


setDecimalSeparatorAlwaysShown : only affects formatting, and only where
there might be no digits after the decimal point, such as with a pattern
like "#,##0.##", e.g.,
if true, 3456.00 -\> "3,456."
if false, 3456.00 -\> "3456"
This is independent of parsing. If you want parsing to stop at the decimal
point, use setParseIntegerOnly.


You can also use forms of the `parse` and `format`
methods with `ParsePosition` and `FieldPosition` to
allow you to:

- progressively parse through pieces of a string
- align the decimal point and other areas

For example, you can align numbers in two ways:

1. If you are using a monospaced font with spacing for alignment, you can pass the `FieldPosition` in your format call, with `field` = `INTEGER_FIELD`. On output, `getEndIndex` will be set to the offset between the last character of the integer and the decimal. Add (desiredSpaceCount - getEndIndex) spaces at the front of the string.
2. If you are using proportional fonts, instead of padding with spaces, measure the width of the string in pixels from the start to `getEndIndex`. Then move the pen by (desiredPixelWidth - widthToAlignmentPoint) before drawing the text. It also works where there is no decimal, but possibly additional characters at the end, e.g., with parentheses in negative numbers: "(12)" for -12.

#### Synchronization


Number 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.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html`

### Nested Class Summary

|---|---|---|---|
| class | [NumberFormat.Field](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.Field.html) || Defines constants that are used as attribute keys in the `AttributedCharacterIterator` returned from `NumberFormat.formatToCharacterIterator` and as field identifiers in `FieldPosition`. |

### Constant Summary

|---|---|---|
| int | [FRACTION_FIELD](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#FRACTION_FIELD) | Field constant used to construct a FieldPosition object. |
| int | [INTEGER_FIELD](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#INTEGER_FIELD) | Field constant used to construct a FieldPosition object. |

### Protected Constructor Summary

|---|---|
|   | [NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#NumberFormat())() Sole constructor. |

### Public Method Summary

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#clone())() Overrides Cloneable |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Overrides equals |
| [StringBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/StringBuffer.html) | [format](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#format(java.lang.Object,%20java.lang.StringBuffer,%20java.text.FieldPosition))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) number, [StringBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/StringBuffer.html) toAppendTo, [FieldPosition](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/FieldPosition.html) pos) Formats a number and appends the resulting text to the given string buffer. |
| final [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [format](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#format(double))(double number) Specialization of format. |
| abstract [StringBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/StringBuffer.html) | [format](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#format(double,%20java.lang.StringBuffer,%20java.text.FieldPosition))(double number, [StringBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/StringBuffer.html) toAppendTo, [FieldPosition](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/FieldPosition.html) pos) Specialization of format. |
| final [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [format](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#format(long))(long number) Specialization of format. |
| abstract [StringBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/StringBuffer.html) | [format](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#format(long,%20java.lang.StringBuffer,%20java.text.FieldPosition))(long number, [StringBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/StringBuffer.html) toAppendTo, [FieldPosition](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/FieldPosition.html) pos) Specialization of format. |
| static [Locale\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.html) | [getAvailableLocales](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getAvailableLocales())() Returns an array of all locales for which the `get*Instance` methods of this class can return localized instances. |
| [Currency](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Currency.html) | [getCurrency](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getCurrency())() Gets the currency used by this number format when formatting currency values. |
| static [NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html) | [getCurrencyInstance](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getCurrencyInstance(java.util.Locale))([Locale](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.html) inLocale) Returns a currency format for the specified locale. |
| final static [NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html) | [getCurrencyInstance](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getCurrencyInstance())() Returns a currency format for the current default locale. |
| final static [NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html) | [getInstance](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getInstance())() Returns a general-purpose number format for the current default locale. |
| static [NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html) | [getInstance](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getInstance(java.util.Locale))([Locale](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.html) inLocale) Returns a general-purpose number format for the specified locale. |
| final static [NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html) | [getIntegerInstance](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getIntegerInstance())() Returns an integer number format for the current default locale. |
| static [NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html) | [getIntegerInstance](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getIntegerInstance(java.util.Locale))([Locale](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.html) inLocale) Returns an integer number format for the specified locale. |
| int | [getMaximumFractionDigits](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getMaximumFractionDigits())() Returns the maximum number of digits allowed in the fraction portion of a number. |
| int | [getMaximumIntegerDigits](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getMaximumIntegerDigits())() Returns the maximum number of digits allowed in the integer portion of a number. |
| int | [getMinimumFractionDigits](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getMinimumFractionDigits())() Returns the minimum number of digits allowed in the fraction portion of a number. |
| int | [getMinimumIntegerDigits](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getMinimumIntegerDigits())() Returns the minimum number of digits allowed in the integer portion of a number. |
| final static [NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html) | [getNumberInstance](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getNumberInstance())() Returns a general-purpose number format for the current default locale. |
| static [NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html) | [getNumberInstance](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getNumberInstance(java.util.Locale))([Locale](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.html) inLocale) Returns a general-purpose number format for the specified locale. |
| static [NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html) | [getPercentInstance](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getPercentInstance(java.util.Locale))([Locale](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.html) inLocale) Returns a percentage format for the specified locale. |
| final static [NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html) | [getPercentInstance](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getPercentInstance())() Returns a percentage format for the current default locale. |
| RoundingMode | [getRoundingMode](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getRoundingMode())() Gets the `https://developers.google.com/j2objc/javadoc/jre/reference/java/math/RoundingMode.html` used in this NumberFormat. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#hashCode())() Overrides hashCode |
| boolean | [isGroupingUsed](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#isGroupingUsed())() Returns true if grouping is used in this format. |
| boolean | [isParseIntegerOnly](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#isParseIntegerOnly())() Returns true if this format will parse numbers as integers only. |
| [Number](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Number.html) | [parse](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#parse(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) source) Parses text from the beginning of the given string to produce a number. |
| abstract [Number](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Number.html) | [parse](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#parse(java.lang.String,%20java.text.ParsePosition))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) source, [ParsePosition](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ParsePosition.html) parsePosition) Returns a Long if possible (e.g., within the range \[Long.MIN_VALUE, Long.MAX_VALUE\] and with no decimals), otherwise a Double. |
| final [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [parseObject](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#parseObject(java.lang.String,%20java.text.ParsePosition))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) source, [ParsePosition](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ParsePosition.html) pos) Parses text from a string to produce a `Number`. |
| void | [setCurrency](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#setCurrency(java.util.Currency))([Currency](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Currency.html) currency) Sets the currency used by this number format when formatting currency values. |
| void | [setGroupingUsed](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#setGroupingUsed(boolean))(boolean newValue) Set whether or not grouping will be used in this format. |
| void | [setMaximumFractionDigits](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#setMaximumFractionDigits(int))(int newValue) Sets the maximum number of digits allowed in the fraction portion of a number. |
| void | [setMaximumIntegerDigits](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#setMaximumIntegerDigits(int))(int newValue) Sets the maximum number of digits allowed in the integer portion of a number. |
| void | [setMinimumFractionDigits](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#setMinimumFractionDigits(int))(int newValue) Sets the minimum number of digits allowed in the fraction portion of a number. |
| void | [setMinimumIntegerDigits](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#setMinimumIntegerDigits(int))(int newValue) Sets the minimum number of digits allowed in the integer portion of a number. |
| void | [setParseIntegerOnly](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#setParseIntegerOnly(boolean))(boolean value) Sets whether or not numbers should be parsed as integers only. |
| void | [setRoundingMode](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#setRoundingMode(java.math.RoundingMode))(RoundingMode roundingMode) Sets the `https://developers.google.com/j2objc/javadoc/jre/reference/java/math/RoundingMode.html` used in this NumberFormat. |

### Inherited Method Summary

From class [java.text.Format](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/Format.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/Format.html#clone())() Creates and returns a copy of this object. |
| final [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [format](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/Format.html#format(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Formats an object to produce a string. |
| abstract [StringBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/StringBuffer.html) | [format](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/Format.html#format(java.lang.Object,%20java.lang.StringBuffer,%20java.text.FieldPosition))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj, [StringBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/StringBuffer.html) toAppendTo, [FieldPosition](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/FieldPosition.html) pos) Formats an object and appends the resulting text to a given string buffer. |
| [AttributedCharacterIterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/AttributedCharacterIterator.html) | [formatToCharacterIterator](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/Format.html#formatToCharacterIterator(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Formats an Object producing an `AttributedCharacterIterator`. |
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [parseObject](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/Format.html#parseObject(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) source) Parses text from the beginning of the given string to produce an object. |
| abstract [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [parseObject](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/Format.html#parseObject(java.lang.String,%20java.text.ParsePosition))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) source, [ParsePosition](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ParsePosition.html) pos) Parses text from a string to produce an object. |

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

## Constants

#### public static final int
**FRACTION_FIELD**

Field constant used to construct a FieldPosition object. Signifies that
the position of the fraction part of a formatted number should be returned.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/FieldPosition.html`
Constant Value: 1

#### public static final int
**INTEGER_FIELD**

Field constant used to construct a FieldPosition object. Signifies that
the position of the integer part of a formatted number should be returned.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/FieldPosition.html`
Constant Value: 0

## Protected Constructors

#### protected
**NumberFormat**
()

Sole constructor. (For invocation by subclass constructors, typically
implicit.)

## Public Methods

#### public [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)
**clone**
()

Overrides Cloneable

##### Returns

- a clone of this instance.

#### public boolean
**equals**
([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj)

Overrides equals

##### Parameters

| obj | the object to compare this instance with. |
|---|---|

##### Returns

- `true` if the specified object is equal to this `Object`; `false` otherwise.

#### public [StringBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/StringBuffer.html)
**format**
([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) number, [StringBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/StringBuffer.html) toAppendTo, [FieldPosition](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/FieldPosition.html) pos)

Formats a number and appends the resulting text to the given string
buffer.
The number can be of any subclass of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Number.html`.


This implementation extracts the number's value using
`https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Number.html#longValue()` for all integral type values that
can be converted to `long` without loss of information,
including `BigInteger` values with a
`https://developers.google.com/j2objc/javadoc/jre/reference/java/math/BigInteger.html#bitLength()` of less than 64,
and `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Number.html#doubleValue()` for all other types. It
then calls
`https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#format(long,%20java.lang.StringBuffer,%20java.text.FieldPosition)`
or `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#format(double,%20java.lang.StringBuffer,%20java.text.FieldPosition)`.
This may result in loss of magnitude information and precision for
`BigInteger` and `BigDecimal` values.

##### Parameters

| number | the number to format |
| toAppendTo | the `StringBuffer` to which the formatted text is to be appended |
| pos | On input: an alignment field, if desired. On output: the offsets of the alignment field. |
|---|---|

##### Returns

- the value passed in as `toAppendTo`

##### Throws

| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if `number` is null or not an instance of `Number`. |
| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if `toAppendTo` or `pos` is null |
| [ArithmeticException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/ArithmeticException.html) | if rounding is needed with rounding mode being set to RoundingMode.UNNECESSARY |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/FieldPosition.html`

#### public final [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**format**
(double number)

Specialization of format.

##### Parameters

| number |   |
|---|---|

##### Throws

| [ArithmeticException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/ArithmeticException.html) | if rounding is needed with rounding mode being set to RoundingMode.UNNECESSARY |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/Format.html#format(java.lang.Object)`

#### public abstract [StringBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/StringBuffer.html)
**format**
(double number, [StringBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/StringBuffer.html) toAppendTo, [FieldPosition](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/FieldPosition.html) pos)

Specialization of format.

##### Parameters

| number |   |
| toAppendTo |   |
| pos |   |
|---|---|

##### Throws

| [ArithmeticException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/ArithmeticException.html) | if rounding is needed with rounding mode being set to RoundingMode.UNNECESSARY |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/Format.html#format(java.lang.Object)`

#### public final [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**format**
(long number)

Specialization of format.

##### Parameters

| number |   |
|---|---|

##### Throws

| [ArithmeticException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/ArithmeticException.html) | if rounding is needed with rounding mode being set to RoundingMode.UNNECESSARY |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/Format.html#format(java.lang.Object)`

#### public abstract [StringBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/StringBuffer.html)
**format**
(long number, [StringBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/StringBuffer.html) toAppendTo, [FieldPosition](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/FieldPosition.html) pos)

Specialization of format.

##### Parameters

| number |   |
| toAppendTo |   |
| pos |   |
|---|---|

##### Throws

| [ArithmeticException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/ArithmeticException.html) | if rounding is needed with rounding mode being set to RoundingMode.UNNECESSARY |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/Format.html#format(java.lang.Object)`

#### public static [Locale\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.html)
**getAvailableLocales**
()

Returns an array of all locales for which the
`get*Instance` methods of this class can return
localized instances.
The returned array represents the union of locales supported by the Java
runtime and by installed
`https://developers.google.com/j2objc/javadoc/jre/` implementations.
It must contain at least a `Locale` instance equal to
`https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.html#US`.

##### Returns

- An array of locales for which localized `NumberFormat` instances are available.

#### public [Currency](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Currency.html)
**getCurrency**
()

Gets the currency used by this number format when formatting
currency values. The initial value is derived in a locale dependent
way. The returned value may be null if no valid
currency could be determined and no currency has been set using
`https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#setCurrency(java.util.Currency)`.


The default implementation throws
`UnsupportedOperationException`.

##### Returns

- the currency used by this number format, or `null`

##### Throws

| [UnsupportedOperationException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/UnsupportedOperationException.html) | if the number format class doesn't implement currency formatting |
|---|---|

#### public static [NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html)
**getCurrencyInstance**
([Locale](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.html) inLocale)

Returns a currency format for the specified locale.

##### Parameters

| inLocale |   |
|---|---|

#### public static final [NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html)
**getCurrencyInstance**
()

Returns a currency format for the current default locale.

#### public static final [NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html)
**getInstance**
()

Returns a general-purpose number format for the current default locale.
This is the same as calling
`https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getNumberInstance()`.

#### public static [NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html)
**getInstance**
([Locale](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.html) inLocale)

Returns a general-purpose number format for the specified locale.
This is the same as calling
`https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getNumberInstance(java.util.Locale)`.

##### Parameters

| inLocale |   |
|---|---|

#### public static final [NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html)
**getIntegerInstance**
()

Returns an integer number format for the current default locale. The
returned number format is configured to round floating point numbers
to the nearest integer using half-even rounding (see `https://developers.google.com/j2objc/javadoc/jre/reference/java/math/RoundingMode.html#HALF_EVEN`) for formatting,
and to parse only the integer part of an input string (see `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#isParseIntegerOnly()`).

##### Returns

- a number format for integer values

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getRoundingMode()`

#### public static [NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html)
**getIntegerInstance**
([Locale](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.html) inLocale)

Returns an integer number format for the specified locale. The
returned number format is configured to round floating point numbers
to the nearest integer using half-even rounding (see `https://developers.google.com/j2objc/javadoc/jre/reference/java/math/RoundingMode.html#HALF_EVEN`) for formatting,
and to parse only the integer part of an input string (see `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#isParseIntegerOnly()`).

##### Parameters

| inLocale |   |
|---|---|

##### Returns

- a number format for integer values

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getRoundingMode()`

#### public int
**getMaximumFractionDigits**
()

Returns the maximum number of digits allowed in the fraction portion of a
number.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#setMaximumFractionDigits(int)`

#### public int
**getMaximumIntegerDigits**
()

Returns the maximum number of digits allowed in the integer portion of a
number.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#setMaximumIntegerDigits(int)`

#### public int
**getMinimumFractionDigits**
()

Returns the minimum number of digits allowed in the fraction portion of a
number.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#setMinimumFractionDigits(int)`

#### public int
**getMinimumIntegerDigits**
()

Returns the minimum number of digits allowed in the integer portion of a
number.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#setMinimumIntegerDigits(int)`

#### public static final [NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html)
**getNumberInstance**
()

Returns a general-purpose number format for the current default locale.

#### public static [NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html)
**getNumberInstance**
([Locale](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.html) inLocale)

Returns a general-purpose number format for the specified locale.

##### Parameters

| inLocale |   |
|---|---|

#### public static [NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html)
**getPercentInstance**
([Locale](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Locale.html) inLocale)

Returns a percentage format for the specified locale.

##### Parameters

| inLocale |   |
|---|---|

#### public static final [NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html)
**getPercentInstance**
()

Returns a percentage format for the current default locale.

#### public RoundingMode
**getRoundingMode**
()

Gets the `https://developers.google.com/j2objc/javadoc/jre/reference/java/math/RoundingMode.html` used in this NumberFormat.
The default implementation of this method in NumberFormat
always throws `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/UnsupportedOperationException.html`.
Subclasses which handle different rounding modes should override
this method.

##### Returns

- The `RoundingMode` used for this NumberFormat.

##### Throws

| [UnsupportedOperationException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/UnsupportedOperationException.html) | The default implementation always throws this exception |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#setRoundingMode(java.math.RoundingMode)`

#### public int
**hashCode**
()

Overrides hashCode

##### Returns

- this object's hash code.

#### public boolean
**isGroupingUsed**
()

Returns true if grouping is used in this format. For example, in the
English locale, with grouping on, the number 1234567 might be formatted
as "1,234,567". The grouping separator as well as the size of each group
is locale dependant and is determined by sub-classes of NumberFormat.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#setGroupingUsed(boolean)`

#### public boolean
**isParseIntegerOnly**
()

Returns true if this format will parse numbers as integers only.
For example in the English locale, with ParseIntegerOnly true, the
string "1234." would be parsed as the integer value 1234 and parsing
would stop at the "." character. Of course, the exact format accepted
by the parse operation is locale dependant and determined by sub-classes
of NumberFormat.

#### public [Number](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Number.html)
**parse**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) source)

Parses text from the beginning of the given string to produce a number.
The method may not use the entire text of the given string.


See the `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#parse(java.lang.String,%20java.text.ParsePosition)` method for more information
on number parsing.

##### Parameters

| source | A `String` whose beginning should be parsed. |
|---|---|

##### Returns

- A `Number` parsed from the string.

##### Throws

| [ParseException](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ParseException.html) | if the beginning of the specified string cannot be parsed. |
|---|---|

#### public abstract [Number](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Number.html)
**parse**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) source, [ParsePosition](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ParsePosition.html) parsePosition)

Returns a Long if possible (e.g., within the range \[Long.MIN_VALUE,
Long.MAX_VALUE\] and with no decimals), otherwise a Double.
If IntegerOnly is set, will stop at a decimal
point (or equivalent; e.g., for rational numbers "1 2/3", will stop
after the 1).
Does not throw an exception; if no object can be parsed, index is
unchanged!

##### Parameters

| source |   |
| parsePosition |   |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#isParseIntegerOnly()`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/Format.html#parseObject(java.lang.String)`

#### public final [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)
**parseObject**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) source, [ParsePosition](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ParsePosition.html) pos)

Parses text from a string to produce a `Number`.


The method attempts to parse text starting at the index given by
`pos`.
If parsing succeeds, then the index of `pos` 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 updated `pos` can be used to
indicate the starting point for the next call to this method.
If an error occurs, then the index of `pos` is not
changed, the error index of `pos` is set to the index of
the character where the error occurred, and null is returned.


See the `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#parse(java.lang.String,%20java.text.ParsePosition)` method for more information
on number parsing.

##### Parameters

| source | A `String`, part of which should be parsed. |
| pos | A `ParsePosition` object with index and error index information as described above. |
|---|---|

##### Returns

- A `Number` parsed from the string. In case of error, returns null.

##### Throws

| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if `pos` is null. |
|---|---|

#### public void
**setCurrency**
([Currency](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Currency.html) currency)

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 default implementation throws
`UnsupportedOperationException`.

##### Parameters

| currency | the new currency to be used by this number format |
|---|---|

##### Throws

| [UnsupportedOperationException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/UnsupportedOperationException.html) | if the number format class doesn't implement currency formatting |
| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if `currency` is null |
|---|---|

#### public void
**setGroupingUsed**
(boolean newValue)

Set whether or not grouping will be used in this format.

##### Parameters

| newValue |   |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#isGroupingUsed()`

#### public void
**setMaximumFractionDigits**
(int newValue)

Sets the maximum number of digits allowed in the fraction portion of a
number. maximumFractionDigits must be \>= minimumFractionDigits. If the
new value for maximumFractionDigits is less than the current value
of minimumFractionDigits, then minimumFractionDigits will also be set to
the new value.

##### 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

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getMaximumFractionDigits()`

#### public void
**setMaximumIntegerDigits**
(int newValue)

Sets the maximum number of digits allowed in the integer portion of a
number. maximumIntegerDigits must be \>= minimumIntegerDigits. If the
new value for maximumIntegerDigits is less than the current value
of minimumIntegerDigits, then minimumIntegerDigits will also be set to
the new value.

##### 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

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getMaximumIntegerDigits()`

#### public void
**setMinimumFractionDigits**
(int newValue)

Sets the minimum number of digits allowed in the fraction portion of a
number. minimumFractionDigits must be \<= maximumFractionDigits. If the
new value for minimumFractionDigits exceeds the current value
of maximumFractionDigits, then maximumIntegerDigits will also be set to
the new value

##### 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

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getMinimumFractionDigits()`

#### public void
**setMinimumIntegerDigits**
(int newValue)

Sets the minimum number of digits allowed in the integer portion of a
number. minimumIntegerDigits must be \<= maximumIntegerDigits. If the
new value for minimumIntegerDigits exceeds the current value
of maximumIntegerDigits, then maximumIntegerDigits will also be set to
the new value

##### 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

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getMinimumIntegerDigits()`

#### public void
**setParseIntegerOnly**
(boolean value)

Sets whether or not numbers should be parsed as integers only.

##### Parameters

| value |   |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#isParseIntegerOnly()`

#### public void
**setRoundingMode**
(RoundingMode roundingMode)

Sets the `https://developers.google.com/j2objc/javadoc/jre/reference/java/math/RoundingMode.html` used in this NumberFormat.
The default implementation of this method in NumberFormat always
throws `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/UnsupportedOperationException.html`.
Subclasses which handle different rounding modes should override
this method.

##### Parameters

| roundingMode | The `RoundingMode` to be used |
|---|---|

##### Throws

| [UnsupportedOperationException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/UnsupportedOperationException.html) | The default implementation always throws this exception |
| [NullPointerException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/NullPointerException.html) | if `roundingMode` is null |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html#getRoundingMode()`