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

public class

ChoiceFormat

extends NumberFormat

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

Class Overview

ChoiceFormat is used to associate strings with ranges of double values. The strings and ranges are either specified using arrays or with a pattern which is parsed to determine the Strings and ranges.

Summary

[Expand]

Inherited Constants

From class java.text.NumberFormat

Public Constructors
	ChoiceFormat(double[] limits, String[] formats) Constructs a new ChoiceFormat with the specified ranges and associated strings.
	ChoiceFormat(String template) Constructs a new ChoiceFormat with the strings and ranges 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 to this ChoiceFormat and answer if they are equal.
StringBuffer	format(double value, StringBuffer buffer, FieldPosition field) Appends to the specified StringBuffer the string associated with the range in which the specified double value fits.
StringBuffer	format(long value, StringBuffer buffer, FieldPosition field) Appends to the specified StringBuffer the string associated with the range in which the specified long value fits.
Object[]	getFormats() Returns the Strings associated with the ranges of this ChoiceFormat.
double[]	getLimits() Returns the ranges of this ChoiceFormat.
int	hashCode() Returns an integer hash code for the receiver.
final static double	nextDouble(double value) Returns the double value which is closest to the specified double but larger.
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.
Number	parse(String string, ParsePosition position) Parse a Double from the specified String starting at the index specified by the ParsePosition.
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 ranges and associated strings of this ChoiceFormat.
String	toPattern() Returns the pattern of this ChoiceFormat which specified 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 NumberFormat and answer if they are equal.
final String	format(long value) Formats the specified long using the rules of this NumberFormat.
final String	format(double value) Formats the specified double using the rules of this NumberFormat.
StringBuffer	format(Object object, StringBuffer buffer, FieldPosition field) Formats the specified object into the specified StringBuffer using the rules of this DateFormat.
abstract StringBuffer	format(double value, StringBuffer buffer, FieldPosition field) Formats the double value into the specified StringBuffer using the rules of this NumberFormat.
abstract StringBuffer	format(long value, StringBuffer buffer, FieldPosition field) Formats the long value into the specified StringBuffer using the rules of this NumberFormat.
static Locale[]	getAvailableLocales() Gets the list of installed Locales which support NumberFormat.
Currency	getCurrency() Returns the currency used by this number format This implementation throws UnsupportedOperationException, concrete sub classes should override if they support currency formatting.
final static NumberFormat	getCurrencyInstance() Returns a NumberFormat for formatting and parsing currency for the default Locale.
static NumberFormat	getCurrencyInstance(Locale locale) Returns a NumberFormat for formatting and parsing currency for the specified Locale.
final static NumberFormat	getInstance() Returns a NumberFormat for formatting and parsing numbers for the default Locale.
static NumberFormat	getInstance(Locale locale) Returns a NumberFormat for formatting and parsing numbers for the specified 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 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.
static NumberFormat	getNumberInstance(Locale locale) Returns a NumberFormat for formatting and parsing numbers for the specified Locale.
final static NumberFormat	getNumberInstance() Returns a NumberFormat for formatting and parsing numbers for the default Locale.
final static NumberFormat	getPercentInstance() Returns a NumberFormat for formatting and parsing percentages for the default Locale.
static NumberFormat	getPercentInstance(Locale locale) Returns a NumberFormat for formatting and parsing percentages for the specified Locale.
int	hashCode() Returns an integer hash code for the receiver.
boolean	isGroupingUsed() Returns whether this NumberFormat formats and parses numbers using a grouping separator.
boolean	isParseIntegerOnly() Returns whether this NumberFormat only parses integer numbers.
Number	parse(String string) Parse a Number from the specified String using the rules of this NumberFormat.
abstract Number	parse(String string, ParsePosition position) Parse a Number from the specified String starting at the index specified by the ParsePosition.
final Object	parseObject(String string, ParsePosition position) Parse a Number from the specified String starting at the index specified by the ParsePosition.
void	setCurrency(Currency currency) Sets the currency used by this number format when formatting currency values.
void	setGroupingUsed(boolean value) Sets whether this NumberFormat 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) Used to specify 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 NumberFormat should only parse numbers as integers or else as any kind of number.

From class java.text.Format

From class java.lang.Object

Object	clone() Returns a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o) Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
void	finalize() Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final Class<? extends Object>	getClass() Returns the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode() Returns an integer hash code for the receiver.
final void	notify() Causes one thread which is `wait` ing on the receiver to be made ready to run.
final void	notifyAll() Causes all threads which are `wait` ing on the receiver to be made ready to run.
String	toString() Returns a string containing a concise, human-readable description of the receiver.
final void	wait(long time, int frac) Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final void	wait(long time) Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final void	wait() Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Public Constructors

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

Constructs a new ChoiceFormat with the specified ranges and associated strings.

Parameters

limits	an array of double, the ranges are greater or equal to the value in lower index up to less than the value in the next higher index. The bounds of the lowest and highest indexes are negative and positive infinity.
formats	the strings associated with the ranges. The lower bound of the associated range is at the same index as the string.

public ChoiceFormat (String template)

Constructs a new ChoiceFormat with the strings and ranges parsed from the specified pattern.

Parameters

template	the pattern of strings and ranges

Throws

IllegalArgumentException	then an error occurs parsing the pattern

Public Methods

public void applyPattern (String template)

Parses the pattern to determine new strings and ranges for this ChoiceFormat.

Parameters

template	the pattern of strings and ranges

Throws

IllegalArgumentException	then an error occurs parsing the pattern

public Object clone ()

Returns a new instance of ChoiceFormat with the same ranges and strings as this ChoiceFormat.

Returns

a shallow copy of this ChoiceFormat

public boolean equals (Object object)

Compares the specified object to this ChoiceFormat and answer if they are equal. The object must be an instance of ChoiceFormat and have the same limits and formats.

Parameters

object	the object to compare with this object

Returns

true if the specified object is equal to this ChoiceFormat, false otherwise

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

Appends to the specified StringBuffer the string associated with the range in which the specified double value fits.

Parameters

value	the double to format
buffer	the StringBuffer
field	a FieldPosition which is ignored

Returns

the StringBuffer parameter buffer

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

Appends to the specified StringBuffer the string associated with the range in which the specified long value fits.

Parameters

value	the long to format
buffer	the StringBuffer
field	a FieldPosition which is ignored

Returns

the StringBuffer parameter buffer

public Object[] getFormats ()

Returns the Strings associated with the ranges of this ChoiceFormat.

Returns

an array of String

public double[] getLimits ()

Returns the ranges of this ChoiceFormat.

Returns

an array of double, the ranges are greater or equal to the value in lower index up to less than the value in the next higher index. The bounds of the lowest and highest indexes are negative and positive infinity.

public int hashCode ()

Returns an integer hash code for the receiver. Objects which are equal answer the same value for this method.

Returns

the receiver's hash

public static final double nextDouble (double value)

Returns the double value which is closest to the specified double but larger.

Parameters

value	a double value

Returns

the next larger double value

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

Parameters

value	a double value
increment	true to get a larger value, false to get a smaller value

Returns

the next larger or smaller double value

public Number parse (String string, ParsePosition position)

Parse a Double from the specified String starting at the index specified by the ParsePosition. The String is compared to the strings of this ChoiceFormat and if a match occurs, the answer is the lower bound of the corresponding range. If the string is successfully parsed, the index of the ParsePosition is updated to the index following the parsed text.

Parameters

string	the String to parse
position	the ParsePosition, updated on return with the index following the parsed text, or on error the index is unchanged and the error index is set to the index where the error occurred

Returns

a Double resulting from the parse, or Double.NaN if there is an error

public static final double previousDouble (double value)

Returns the double value which is closest to the specified double but smaller.

Parameters

value	a double value

Returns

the next smaller double value

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

Sets the ranges and associated strings of this ChoiceFormat.

Parameters

limits	an array of double, the ranges are greater or equal to the value in lower index up to less than the value in the next higher index. The bounds of the lowest and highest indexes are negative and positive infinity.
formats	the strings associated with the ranges. The lower bound of the range is at the same index as the string.

public String toPattern ()

Returns the pattern of this ChoiceFormat which specified the ranges and their associated strings.

Returns

the pattern

Jan	FEB	Mar
	26
2008	2009	2010

Interfaces

Classes

Exceptions

ChoiceFormat

Class Overview

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 (double value, StringBuffer buffer, FieldPosition field)

Parameters

Returns

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

Parameters

Returns

public Object[] getFormats ()

Returns

public double[] getLimits ()

Returns

public int hashCode ()

Returns

See Also

public static final double nextDouble (double value)

Parameters

Returns

public static double nextDouble (double value, boolean increment)

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