# ChoiceFormat

public class **ChoiceFormat** extends [NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.html)  
A `ChoiceFormat` allows you to attach a format to a range of numbers.
It is generally used in a `MessageFormat` for handling plurals.
The choice is specified with an ascending list of doubles, where each item
specifies a half-open interval up to the next item:
>
> ```
>  X matches j if and only if limit[j] ≤ X < limit[j+1]
>  
> ```
If there is no match, then either the first or last index is used, depending on whether the number (X) is too low or too high. If the limit array is not in ascending order, the results of formatting will be incorrect. ChoiceFormat also accepts `\u221E` as equivalent to infinity(INF).


**Note:**
`ChoiceFormat` differs from the other `Format`
classes in that you create a `ChoiceFormat` object with a
constructor (not with a `getInstance` style factory
method). The factory methods aren't necessary because `ChoiceFormat`
doesn't require any complex setup for a given locale. In fact,
`ChoiceFormat` doesn't implement any locale specific behavior.


When creating a `ChoiceFormat`, you must specify an array of formats
and an array of limits. The length of these arrays must be the same.
For example,

- *limits* = {1,2,3,4,5,6,7}  
  *formats* = {"Sun","Mon","Tue","Wed","Thur","Fri","Sat"}
- *limits* = {0, 1, ChoiceFormat.nextDouble(1)}  
  *formats* = {"no files", "one file", "many files"}  
  (`nextDouble` can be used to get the next higher double, to make the half-open interval.)


Here is a simple example that shows formatting and parsing:
>
>     double[] limits = {1,2,3,4,5,6,7};
>      String[] dayOfWeekNames = {"Sun","Mon","Tue","Wed","Thur","Fri","Sat"};
>      ChoiceFormat form = new ChoiceFormat(limits, dayOfWeekNames);
>      ParsePosition status = new ParsePosition(0);
>      for (double i = 0.0; i <= 8.0; ++i) {
>          status.setIndex(0);
>          System.out.println(i + " -> " + form.format(i) + " -> "
>                                   + form.parse(form.format(i),status));
>      }
>      
Here is a more complex example, with a pattern format:
>
>     double[] filelimits = {0,1,2};
>      String[] filepart = {"are no files","is one file","are {2} files"};
>      ChoiceFormat fileform = new ChoiceFormat(filelimits, filepart);
>      Format[] testFormats = {fileform, null, NumberFormat.getInstance()};
>      MessageFormat pattform = new MessageFormat("There {0} on {1}");
>      pattform.setFormats(testFormats);
>      Object[] testArgs = {null, "ADisk", null};
>      for (int i = 0; i < 4; ++i) {
>          testArgs[0] = new Integer(i);
>          testArgs[2] = testArgs[0];
>          System.out.println(pattform.format(testArgs));
>      }
>      

Specifying a pattern for ChoiceFormat objects is fairly straightforward.
For example:
>
>     ChoiceFormat fmt = new ChoiceFormat(
>           "-1#is negative| 0#is zero or fraction | 1#is one |1.0<is 1+ |2#is two |2<is more than 2.");
>      System.out.println("Formatter Pattern : " + fmt.toPattern());
>
>      System.out.println("Format with -INF : " + fmt.format(Double.NEGATIVE_INFINITY));
>      System.out.println("Format with -1.0 : " + fmt.format(-1.0));
>      System.out.println("Format with 0 : " + fmt.format(0));
>      System.out.println("Format with 0.9 : " + fmt.format(0.9));
>      System.out.println("Format with 1.0 : " + fmt.format(1));
>      System.out.println("Format with 1.5 : " + fmt.format(1.5));
>      System.out.println("Format with 2 : " + fmt.format(2));
>      System.out.println("Format with 2.1 : " + fmt.format(2.1));
>      System.out.println("Format with NaN : " + fmt.format(Double.NaN));
>      System.out.println("Format with +INF : " + fmt.format(Double.POSITIVE_INFINITY));
>      
And the output result would be like the following:
>
>     Format with -INF : is negative
>      Format with -1.0 : is negative
>      Format with 0 : is zero or fraction
>      Format with 0.9 : is zero or fraction
>      Format with 1.0 : is one
>      Format with 1.5 : is 1+
>      Format with 2 : is two
>      Format with 2.1 : is more than 2.
>      Format with NaN : is negative
>      Format with +INF : is more than 2.
>      
### Synchronization


Choice formats are 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/MessageFormat.html`

### Inherited Constant Summary

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

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

### Public Constructor Summary

|---|---|
|   | [ChoiceFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html#ChoiceFormat(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) newPattern) Constructs with limits and corresponding formats based on the pattern. |
|   | [ChoiceFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html#ChoiceFormat(double[],%20java.lang.String[]))(double\[\] limits, [String\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) formats) Constructs with the limits and the corresponding formats. |

### Public Method Summary

|---|---|
| void | [applyPattern](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html#applyPattern(java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) newPattern) Sets the pattern. |
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html#clone())() Overrides Cloneable |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Equality comparision between two |
| [StringBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/StringBuffer.html) | [format](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.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) status) Returns pattern with formatted double. |
| [StringBuffer](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/StringBuffer.html) | [format](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.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) status) Specialization of format. |
| [Object\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [getFormats](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html#getFormats())() |
| double\[\] | [getLimits](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html#getLimits())() |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html#hashCode())() Generates a hash code for the message format object. |
| final static double | [nextDouble](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html#nextDouble(double))(double d) Finds the least double greater than `d`. |
| static double | [nextDouble](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html#nextDouble(double,%20boolean))(double d, boolean positive) Finds the least double greater than `d` (if `positive` is `true`), or the greatest double less than `d` (if `positive` is `false`). |
| [Number](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Number.html) | [parse](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html#parse(java.lang.String,%20java.text.ParsePosition))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) text, [ParsePosition](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ParsePosition.html) status) Parses a Number from the input text. |
| final static double | [previousDouble](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html#previousDouble(double))(double d) Finds the greatest double less than `d`. |
| void | [setChoices](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html#setChoices(double[],%20java.lang.String[]))(double\[\] limits, [String\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) formats) Set the choices to be used in formatting. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toPattern](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html#toPattern())() Gets the pattern. |

### Inherited Method Summary

From class [java.text.NumberFormat](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/NumberFormat.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/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. |

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

## Public Constructors

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

Constructs with limits and corresponding formats based on the pattern.

##### Parameters

| newPattern | the new pattern string |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html#applyPattern(java.lang.String)`

#### public
**ChoiceFormat**
(double\[\] limits, [String\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) formats)

Constructs with the limits and the corresponding formats.

##### Parameters

| limits | limits in ascending order |
| formats | corresponding format strings |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html#setChoices(double[],%20java.lang.String[])`

## Public Methods

#### public void
**applyPattern**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) newPattern)

Sets the pattern.

##### Parameters

| newPattern | See the class description. |
|---|---|

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

Equality comparision between two

##### 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**
(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) status)

Returns pattern with formatted double.

##### Parameters

| number | number to be formatted and substituted. |
| toAppendTo | where text is appended. |
| status | ignore no useful status is returned. |
|---|---|

#### public [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) status)

Specialization of format. This method really calls
`format(double, StringBuffer, FieldPosition)`
thus the range of longs that are supported is only equal to
the range that can be stored by double. This will never be
a practical limitation.

##### Parameters

| number |   |
| toAppendTo |   |
| status |   |
|---|---|

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

<br />

##### Returns

- a copy of the `String[]` array supplied to the constructor or the most recent call to `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html#setChoices(double[],%20java.lang.String[])`.

#### public double\[\]
**getLimits**
()

<br />

##### Returns

- a copy of the `double[]` array supplied to the constructor or the most recent call to `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html#setChoices(double[],%20java.lang.String[])`.

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

Generates a hash code for the message format object.

##### Returns

- this object's hash code.

#### public static final double
**nextDouble**
(double d)

Finds the least double greater than `d`.
If `NaN`, returns same value.

Used to make half-open intervals.

##### Parameters

| d | the reference value |
|---|---|

##### Returns

- the least double value greather than `d`

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html#previousDouble(double)`

#### public static double
**nextDouble**
(double d, boolean positive)

Finds the least double greater than `d` (if `positive` is
`true`), or the greatest double less than `d` (if
`positive` is `false`).
If `NaN`, returns same value.

Does not affect floating-point flags,
provided these member functions do not:
Double.longBitsToDouble(long)
Double.doubleToLongBits(double)
Double.isNaN(double)

##### Parameters

| d | the reference value |
| positive | `true` if the least double is desired; `false` otherwise |
|---|---|

##### Returns

- the least or greater double value

#### 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) text, [ParsePosition](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ParsePosition.html) status)

Parses a Number from the input text.

##### Parameters

| text | the source text. |
| status | an input-output parameter. On input, the status.index field indicates the first character of the source text that should be parsed. On exit, if no error occurred, status.index is set to the first unparsed character in the source text. On exit, if an error did occur, status.index is unchanged and status.errorIndex is set to the first index of the character that caused the parse to fail. |
|---|---|

##### Returns

- A Number representing the value of the number parsed.

#### public static final double
**previousDouble**
(double d)

Finds the greatest double less than `d`.
If `NaN`, returns same value.

##### Parameters

| d | the reference value |
|---|---|

##### Returns

- the greatest double value less than `d`

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ChoiceFormat.html#nextDouble(double)`

#### public void
**setChoices**
(double\[\] limits, [String\[\]](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) formats)

Set the choices to be used in formatting.

##### Parameters

| limits | contains the top value that you want parsed with that format, and should be in ascending sorted order. When formatting X, the choice will be the i, where limit\[i\] ≤ X \< limit\[i+1\]. If the limit array is not in ascending order, the results of formatting will be incorrect. |
| formats | are the formats you want to use for each limit. They can be either Format objects or Strings. When formatting with object Y, if the object is a NumberFormat, then ((NumberFormat) Y).format(X) is called. Otherwise Y.toString() is called. |
|---|---|

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

Gets the pattern.

##### Returns

- the pattern string