|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.text.Format
org.apache.commons.math.fraction.FractionFormat
Formats a Fraction number in proper format or improper format. The number format for each of the whole number, numerator and, denominator can be configured.
Nested Class Summary |
Nested classes inherited from class java.text.Format |
Format.Field |
Constructor Summary | |
FractionFormat()
Create an improper formatting instance with the default number format for the numerator and denominator. |
|
FractionFormat(NumberFormat format)
Create an improper formatting instance with a custom number format for both the numerator and denominator. |
|
FractionFormat(NumberFormat numeratorFormat,
NumberFormat denominatorFormat)
Create an improper formatting instance with a custom number format for the numerator and a custom number format for the denominator. |
Method Summary | |
StringBuffer |
format(Fraction fraction,
StringBuffer toAppendTo,
FieldPosition pos)
Formats a Fraction object to produce a string. |
StringBuffer |
format(Object obj,
StringBuffer toAppendTo,
FieldPosition pos)
Formats a object to produce a string. |
static String |
formatFraction(Fraction f)
This static method calls formatFraction() on a default instance of FractionFormat. |
static Locale[] |
getAvailableLocales()
Get the set of locales for which complex formats are available. |
protected static NumberFormat |
getDefaultNumberFormat()
Create a default number format. |
NumberFormat |
getDenominatorFormat()
Access the denominator format. |
static FractionFormat |
getImproperInstance()
Returns the default complex format for the current locale. |
static FractionFormat |
getImproperInstance(Locale locale)
Returns the default complex format for the given locale. |
NumberFormat |
getNumeratorFormat()
Access the numerator format. |
static FractionFormat |
getProperInstance()
Returns the default complex format for the current locale. |
static FractionFormat |
getProperInstance(Locale locale)
Returns the default complex format for the given locale. |
Fraction |
parse(String source)
Parses a string to produce a Fraction object. |
Fraction |
parse(String source,
ParsePosition pos)
Parses a string to produce a Fraction object. |
protected static void |
parseAndIgnoreWhitespace(String source,
ParsePosition pos)
Parses source until a non-whitespace character is found. |
protected static char |
parseNextCharacter(String source,
ParsePosition pos)
Parses source until a non-whitespace character is found. |
Object |
parseObject(String source,
ParsePosition pos)
Parses a string to produce a object. |
void |
setDenominatorFormat(NumberFormat format)
Modify the denominator format. |
void |
setNumeratorFormat(NumberFormat format)
Modify the numerator format. |
Methods inherited from class java.text.Format |
clone, format, formatToCharacterIterator, parseObject |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public FractionFormat()
public FractionFormat(NumberFormat format)
format
- the custom format for both the numerator and denominator.public FractionFormat(NumberFormat numeratorFormat, NumberFormat denominatorFormat)
numeratorFormat
- the custom format for the numerator.denominatorFormat
- the custom format for the denominator.Method Detail |
public static String formatFraction(Fraction f)
f
- Fraction object to format
public static Locale[] getAvailableLocales()
NumberFormat
set.
public static FractionFormat getImproperInstance()
public static FractionFormat getImproperInstance(Locale locale)
locale
- the specific locale used by the format.
public static FractionFormat getProperInstance()
public static FractionFormat getProperInstance(Locale locale)
locale
- the specific locale used by the format.
protected static NumberFormat getDefaultNumberFormat()
NumberFormat.getNumberInstance(java.util.Locale)
with the only
customizing is the maximum number of fraction digits, which is set to 0.
public StringBuffer format(Fraction fraction, StringBuffer toAppendTo, FieldPosition pos)
Fraction
object to produce a string. The fraction is
output in improper format.
fraction
- the object to format.toAppendTo
- where the text is to be appendedpos
- On input: an alignment field, if desired. On output: the
offsets of the alignment field
public StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition pos)
obj
must be either a
Fraction
object or a Number
object. Any other type of
object will result in an IllegalArgumentException
being thrown.
obj
- the object to format.toAppendTo
- where the text is to be appendedpos
- On input: an alignment field, if desired. On output: the
offsets of the alignment field
IllegalArgumentException
- is obj
is not a valid type.Format.format(java.lang.Object, java.lang.StringBuffer, java.text.FieldPosition)
public NumberFormat getDenominatorFormat()
public NumberFormat getNumeratorFormat()
public Fraction parse(String source) throws ParseException
Fraction
object.
source
- the string to parse
Fraction
object.
ParseException
- if the beginning of the specified string
cannot be parsed.public Fraction parse(String source, ParsePosition pos)
Fraction
object. This method
expects the string to be formatted as an improper fraction.
source
- the string to parsepos
- input/ouput parsing parameter.
Fraction
object.public Object parseObject(String source, ParsePosition pos)
source
- the string to parsepos
- input/ouput parsing parameter.
Format.parseObject(java.lang.String, java.text.ParsePosition)
public void setDenominatorFormat(NumberFormat format)
format
- the new denominator format value.
IllegalArgumentException
- if format
is
null
.public void setNumeratorFormat(NumberFormat format)
format
- the new numerator format value.
IllegalArgumentException
- if format
is
null
.protected static void parseAndIgnoreWhitespace(String source, ParsePosition pos)
source
until a non-whitespace character is found.
source
- the string to parsepos
- input/ouput parsing parameter. On output, pos
holds the index of the next non-whitespace character.protected static char parseNextCharacter(String source, ParsePosition pos)
source
until a non-whitespace character is found.
source
- the string to parsepos
- input/ouput parsing parameter.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |