|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.text.Format
java.text.NumberFormat
org.apache.commons.math.fraction.AbstractFormat
org.apache.commons.math.fraction.BigFractionFormat
org.apache.commons.math.fraction.ProperBigFractionFormat
public class ProperBigFractionFormat
Formats a BigFraction number in proper format. The number format for each of the whole number, numerator and, denominator can be configured.
Minus signs are only allowed in the whole number part - i.e.,
"-3 1/2" is legitimate and denotes -7/2, but "-3 -1/2" is invalid and
will result in a ParseException.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class java.text.NumberFormat |
|---|
NumberFormat.Field |
| Field Summary |
|---|
| Fields inherited from class org.apache.commons.math.fraction.AbstractFormat |
|---|
denominatorFormat, numeratorFormat |
| Fields inherited from class java.text.NumberFormat |
|---|
FRACTION_FIELD, INTEGER_FIELD |
| Constructor Summary | |
|---|---|
ProperBigFractionFormat()
Create a proper formatting instance with the default number format for the whole, numerator, and denominator. |
|
ProperBigFractionFormat(NumberFormat format)
Create a proper formatting instance with a custom number format for the whole, numerator, and denominator. |
|
ProperBigFractionFormat(NumberFormat wholeFormat,
NumberFormat numeratorFormat,
NumberFormat denominatorFormat)
Create a proper formatting instance with a custom number format for each of the whole, numerator, and denominator. |
|
| Method Summary | |
|---|---|
StringBuffer |
format(BigFraction fraction,
StringBuffer toAppendTo,
FieldPosition pos)
Formats a BigFraction object to produce a string. |
NumberFormat |
getWholeFormat()
Access the whole format. |
BigFraction |
parse(String source,
ParsePosition pos)
Parses a string to produce a BigFraction object. |
void |
setWholeFormat(NumberFormat format)
Modify the whole format. |
| Methods inherited from class org.apache.commons.math.fraction.BigFractionFormat |
|---|
format, formatBigFraction, getAvailableLocales, getImproperInstance, getImproperInstance, getProperInstance, getProperInstance, parse, parseNextBigInteger |
| Methods inherited from class org.apache.commons.math.fraction.AbstractFormat |
|---|
format, format, getDefaultNumberFormat, getDefaultNumberFormat, getDenominatorFormat, getNumeratorFormat, parseAndIgnoreWhitespace, parseNextCharacter, setDenominatorFormat, setNumeratorFormat |
| Methods inherited from class java.text.Format |
|---|
format, formatToCharacterIterator, parseObject |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ProperBigFractionFormat()
public ProperBigFractionFormat(NumberFormat format)
format - the custom format for the whole, numerator, and
denominator.
public ProperBigFractionFormat(NumberFormat wholeFormat,
NumberFormat numeratorFormat,
NumberFormat denominatorFormat)
wholeFormat - the custom format for the whole.numeratorFormat - the custom format for the numerator.denominatorFormat - the custom format for the denominator.| Method Detail |
|---|
public StringBuffer format(BigFraction fraction,
StringBuffer toAppendTo,
FieldPosition pos)
BigFraction object to produce a string. The BigFraction
is output in proper format.
format in class BigFractionFormatfraction - 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 NumberFormat getWholeFormat()
public BigFraction parse(String source,
ParsePosition pos)
BigFraction object. This method
expects the string to be formatted as a proper BigFraction.
Minus signs are only allowed in the whole number part - i.e.,
"-3 1/2" is legitimate and denotes -7/2, but "-3 -1/2" is invalid and
will result in a ParseException.
parse in class BigFractionFormatsource - the string to parsepos - input/ouput parsing parameter.
BigFraction object.public void setWholeFormat(NumberFormat format)
format - The new whole format value.
NullArgumentException - if format is null.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||