|
||||||||||
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
public class 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/interfaces inherited from class java.text.Format |
---|
java.text.Format.Field |
Field Summary | |
---|---|
private java.text.NumberFormat |
denominatorFormat
The format used for the denominator. |
private java.text.NumberFormat |
numeratorFormat
The format used for the numerator. |
private static long |
serialVersionUID
Serializable version identifier |
Constructor Summary | |
---|---|
FractionFormat()
Create an improper formatting instance with the default number format for the numerator and denominator. |
|
FractionFormat(java.text.NumberFormat format)
Create an improper formatting instance with a custom number format for both the numerator and denominator. |
|
FractionFormat(java.text.NumberFormat numeratorFormat,
java.text.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 | |
---|---|
java.lang.StringBuffer |
format(Fraction fraction,
java.lang.StringBuffer toAppendTo,
java.text.FieldPosition pos)
Formats a Fraction object to produce a string. |
java.lang.StringBuffer |
format(java.lang.Object obj,
java.lang.StringBuffer toAppendTo,
java.text.FieldPosition pos)
Formats a object to produce a string. |
static java.lang.String |
formatFraction(Fraction f)
This static method calls formatFraction() on a default instance of FractionFormat. |
static java.util.Locale[] |
getAvailableLocales()
Get the set of locales for which complex formats are available. |
protected static java.text.NumberFormat |
getDefaultNumberFormat()
Create a default number format. |
private static java.text.NumberFormat |
getDefaultNumberFormat(java.util.Locale locale)
Create a default number format. |
java.text.NumberFormat |
getDenominatorFormat()
Access the denominator format. |
static FractionFormat |
getImproperInstance()
Returns the default complex format for the current locale. |
static FractionFormat |
getImproperInstance(java.util.Locale locale)
Returns the default complex format for the given locale. |
java.text.NumberFormat |
getNumeratorFormat()
Access the numerator format. |
static FractionFormat |
getProperInstance()
Returns the default complex format for the current locale. |
static FractionFormat |
getProperInstance(java.util.Locale locale)
Returns the default complex format for the given locale. |
Fraction |
parse(java.lang.String source)
Parses a string to produce a Fraction object. |
Fraction |
parse(java.lang.String source,
java.text.ParsePosition pos)
Parses a string to produce a Fraction object. |
protected static void |
parseAndIgnoreWhitespace(java.lang.String source,
java.text.ParsePosition pos)
Parses source until a non-whitespace character is found. |
protected static char |
parseNextCharacter(java.lang.String source,
java.text.ParsePosition pos)
Parses source until a non-whitespace character is found. |
java.lang.Object |
parseObject(java.lang.String source,
java.text.ParsePosition pos)
Parses a string to produce a object. |
void |
setDenominatorFormat(java.text.NumberFormat format)
Modify the denominator format. |
void |
setNumeratorFormat(java.text.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 |
Field Detail |
---|
private static final long serialVersionUID
private java.text.NumberFormat denominatorFormat
private java.text.NumberFormat numeratorFormat
Constructor Detail |
---|
public FractionFormat()
public FractionFormat(java.text.NumberFormat format)
format
- the custom format for both the numerator and denominator.public FractionFormat(java.text.NumberFormat numeratorFormat, java.text.NumberFormat denominatorFormat)
numeratorFormat
- the custom format for the numerator.denominatorFormat
- the custom format for the denominator.Method Detail |
---|
public static java.lang.String formatFraction(Fraction f)
f
- Fraction object to format
public static java.util.Locale[] getAvailableLocales()
NumberFormat
set.
public static FractionFormat getImproperInstance()
public static FractionFormat getImproperInstance(java.util.Locale locale)
locale
- the specific locale used by the format.
public static FractionFormat getProperInstance()
public static FractionFormat getProperInstance(java.util.Locale locale)
locale
- the specific locale used by the format.
protected static java.text.NumberFormat getDefaultNumberFormat()
NumberFormat.getNumberInstance(java.util.Locale)
with the only
customizing is the maximum number of fraction digits, which is set to 0.
private static java.text.NumberFormat getDefaultNumberFormat(java.util.Locale locale)
NumberFormat.getNumberInstance(java.util.Locale)
with the only
customizing is the maximum number of fraction digits, which is set to 0.
locale
- the specific locale used by the format.
public java.lang.StringBuffer format(Fraction fraction, java.lang.StringBuffer toAppendTo, java.text.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 java.lang.StringBuffer format(java.lang.Object obj, java.lang.StringBuffer toAppendTo, java.text.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.
format
in class java.text.Format
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
java.lang.IllegalArgumentException
- is obj
is not a valid type.Format.format(java.lang.Object, java.lang.StringBuffer, java.text.FieldPosition)
public java.text.NumberFormat getDenominatorFormat()
public java.text.NumberFormat getNumeratorFormat()
public Fraction parse(java.lang.String source) throws java.text.ParseException
Fraction
object.
source
- the string to parse
Fraction
object.
java.text.ParseException
- if the beginning of the specified string
cannot be parsed.public Fraction parse(java.lang.String source, java.text.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 java.lang.Object parseObject(java.lang.String source, java.text.ParsePosition pos)
parseObject
in class java.text.Format
source
- the string to parsepos
- input/ouput parsing parameter.
Format.parseObject(java.lang.String, java.text.ParsePosition)
public void setDenominatorFormat(java.text.NumberFormat format)
format
- the new denominator format value.
java.lang.IllegalArgumentException
- if format
is
null
.public void setNumeratorFormat(java.text.NumberFormat format)
format
- the new numerator format value.
java.lang.IllegalArgumentException
- if format
is
null
.protected static void parseAndIgnoreWhitespace(java.lang.String source, java.text.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(java.lang.String source, java.text.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 |