Summary: Inherited Constants | Ctors | Methods | Inherited Methods | [Expand All]

public class

ChoiceFormat

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

Class Overview

Returns a fixed string based on a numeric value. The class can be used in conjunction with the MessageFormat class to handle plurals in messages. ChoiceFormat enables users to attach a format to a range of numbers. The choice is specified with an ascending list of doubles, where each item specifies a half-open interval up to the next item as in the following: 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. The first or last index is used depending on whether the number is too low or too high. The length of the format array must be the same as the length of the limits array.

Examples:

 double[] limits = {1, 2, 3, 4, 5, 6, 7};
 String[] fmts = {"Sun", "Mon", "Tue", "Wed", "Thur", "Fri", "Sat"};
 double[] limits2 = {0, 1, ChoiceFormat.nextDouble(1)};
 String[] fmts2 = {"no files", "one file", "many files"};

ChoiceFormat.nextDouble(double) allows to get the double following the one passed to the method. This is used to create half open intervals.

ChoiceFormat objects also may be converted to and from patterns. The conversion can be done programmatically, as in the example above, or by using a pattern like the following:

 "1#Sun|2#Mon|3#Tue|4#Wed|5#Thur|6#Fri|7#Sat"
 "0#are no files|1#is one file|1<are many files"

where:

"#" specifies an inclusive limit value;
"<" specifies an exclusive limit value.

Summary

[Expand]

Inherited Constants

From class java.text.NumberFormat

Public Constructors
	ChoiceFormat(double[] limits, String[] formats) Constructs a new `ChoiceFormat` with the specified double values and associated strings.
	ChoiceFormat(String template) Constructs a new `ChoiceFormat` with the strings and limits parsed from the specified pattern.

Public Methods
void	applyPattern(String template) Parses the pattern to determine new strings and ranges for this `ChoiceFormat`.
Object	clone() Returns a new instance of `ChoiceFormat` with the same ranges and strings as this `ChoiceFormat`.
boolean	equals(Object object) Compares the specified object with this `ChoiceFormat`.
StringBuffer	format(long value, StringBuffer buffer, FieldPosition field) Appends the string associated with the range in which the specified long value fits to the specified string buffer.
StringBuffer	format(double value, StringBuffer buffer, FieldPosition field) Appends the string associated with the range in which the specified double value fits to the specified string buffer.
Object[]	getFormats() Returns the strings associated with the ranges of this `ChoiceFormat`.
double[]	getLimits() Returns the limits of this `ChoiceFormat`.
int	hashCode() Returns an integer hash code for the receiver.
static double	nextDouble(double value, boolean increment) Returns the double value which is closest to the specified double but either larger or smaller as specified.
final static double	nextDouble(double value) Returns the double value which is closest to the specified double but larger.
Number	parse(String string, ParsePosition position) Parses a double from the specified string starting at the index specified by `position`.
final static double	previousDouble(double value) Returns the double value which is closest to the specified double but smaller.
void	setChoices(double[] limits, String[] formats) Sets the double values and associated strings of this ChoiceFormat.
String	toPattern() Returns the pattern of this `ChoiceFormat` which specifies the ranges and their associated strings.

[Expand]

Inherited Methods

From class java.text.NumberFormat

Object	clone() Returns a new `NumberFormat` with the same properties as this `NumberFormat`.
boolean	equals(Object object) Compares the specified object to this number format and indicates if they are equal.
abstract StringBuffer	format(long value, StringBuffer buffer, FieldPosition field) Formats the specified long value as a string using the pattern of this number format and appends the string to the specified string buffer.
final String	format(long value) Formats the specified long using the rules of this number format.
abstract StringBuffer	format(double value, StringBuffer buffer, FieldPosition field) Formats the specified double value as a string using the pattern of this number format and appends the string to the specified string buffer.
StringBuffer	format(Object object, StringBuffer buffer, FieldPosition field) Formats a number into a supplied buffer.
final String	format(double value) Formats the specified double using the rules of this number format.
static Locale[]	getAvailableLocales() Returns an array of locales for which custom `NumberFormat` instances are available.
Currency	getCurrency() Returns the currency used by this number format.
final static NumberFormat	getCurrencyInstance() Returns a `NumberFormat` for formatting and parsing currency values for the user's default locale.
static NumberFormat	getCurrencyInstance(Locale locale) Returns a `NumberFormat` for formatting and parsing currency values for the specified locale.
static NumberFormat	getInstance(Locale locale) Returns a `NumberFormat` for formatting and parsing numbers for the specified locale.
final static NumberFormat	getInstance() Returns a `NumberFormat` for formatting and parsing numbers for the default locale.
static NumberFormat	getIntegerInstance(Locale locale) Returns a `NumberFormat` for formatting and parsing integers for the specified locale.
final static NumberFormat	getIntegerInstance() Returns a `NumberFormat` for formatting and parsing integers for the user's default locale.
int	getMaximumFractionDigits() Returns the maximum number of fraction digits that are printed when formatting.
int	getMaximumIntegerDigits() Returns the maximum number of integer digits that are printed when formatting.
int	getMinimumFractionDigits() Returns the minimum number of fraction digits that are printed when formatting.
int	getMinimumIntegerDigits() Returns the minimum number of integer digits that are printed when formatting.
final static NumberFormat	getNumberInstance() Returns a `NumberFormat` for formatting and parsing numbers for the user's default locale.
static NumberFormat	getNumberInstance(Locale locale) Returns a `NumberFormat` for formatting and parsing numbers for the specified locale.
final static NumberFormat	getPercentInstance() Returns a `NumberFormat` for formatting and parsing percentage values for the user's default locale.
static NumberFormat	getPercentInstance(Locale locale) Returns a `NumberFormat` for formatting and parsing percentage values for the given `locale`.
RoundingMode	getRoundingMode() Returns the `RoundingMode` used by this `NumberFormat`.
int	hashCode() Returns an integer hash code for this object.
boolean	isGroupingUsed() Indicates whether this number format formats and parses numbers using a grouping separator.
boolean	isParseIntegerOnly() Indicates whether this number format only parses integer numbers.
Number	parse(String string) Parses a `Number` from the specified string using the rules of this number format.
abstract Number	parse(String string, ParsePosition position) Parses a `Number` from the specified string starting at the index specified by `position`.
final Object	parseObject(String string, ParsePosition position) Parses the specified string starting at the index specified by `position`.
void	setCurrency(Currency currency) Sets the currency used by this number format when formatting currency values.
void	setGroupingUsed(boolean value) Sets whether this number format formats and parses numbers using a grouping separator.
void	setMaximumFractionDigits(int value) Sets the maximum number of fraction digits that are printed when formatting.
void	setMaximumIntegerDigits(int value) Sets the new maximum count of integer digits that are printed when formatting.
void	setMinimumFractionDigits(int value) Sets the minimum number of fraction digits that are printed when formatting.
void	setMinimumIntegerDigits(int value) Sets the minimum number of integer digits that are printed when formatting.
void	setParseIntegerOnly(boolean value) Specifies if this number format should parse numbers only as integers or else as any kind of number.
void	setRoundingMode(RoundingMode roundingMode) Sets the `RoundingMode` used by this `NumberFormat`.

From class java.text.Format

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	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() 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	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, 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(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

limits	an array of doubles in ascending order. The lowest and highest possible values are negative and positive infinity.
formats	the strings associated with the ranges defined through `limits`. The lower bound of the associated range is at the same index as the string.

value	the long to format.
buffer	the target string buffer to append the formatted value to.
field	a `FieldPosition` which is ignored.

value	the double to format.
buffer	the target string buffer to append the formatted value to.
field	a `FieldPosition` which is ignored.

value	a double value.
increment	`true` to get the next larger value, `false` to get the previous smaller value.

string	the source string to parse.
position	input/output parameter, specifies the start index in `string` from where to start parsing. See the Returns section for a description of the output values.

Interfaces

Classes

Enums

Exceptions

ChoiceFormat

Class Overview

Examples:

Summary

Public Constructors

public ChoiceFormat (double[] limits, String[] formats)

Parameters

public ChoiceFormat (String template)

Parameters

Throws

Public Methods

public void applyPattern (String template)

Parameters

Throws

public Object clone ()

Returns

See Also

public boolean equals (Object object)

Parameters

Returns

See Also

public StringBuffer format (long value, StringBuffer buffer, FieldPosition field)

Parameters

Returns

public StringBuffer format (double value, StringBuffer buffer, FieldPosition field)

Parameters

Returns

public Object[] getFormats ()

Returns

public double[] getLimits ()

Returns

public int hashCode ()

Returns

See Also

public static double nextDouble (double value, boolean increment)

Parameters

Returns

public static final double nextDouble (double value)

Parameters

Returns

public Number parse (String string, ParsePosition position)

Parameters

Returns

public static final double previousDouble (double value)

Parameters

Returns

public void setChoices (double[] limits, String[] formats)

Parameters

public String toPattern ()

Returns