|
||||||||||
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
org.apache.commons.math.fraction.ProperFractionFormat
public class ProperFractionFormat
Formats a Fraction 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.Format |
---|
java.text.Format.Field |
Field Summary | |
---|---|
private static long |
serialVersionUID
Serializable version identifier |
private java.text.NumberFormat |
wholeFormat
The format used for the whole number. |
Constructor Summary | |
---|---|
ProperFractionFormat()
Create a proper formatting instance with the default number format for the whole, numerator, and denominator. |
|
ProperFractionFormat(java.text.NumberFormat format)
Create a proper formatting instance with a custom number format for the whole, numerator, and denominator. |
|
ProperFractionFormat(java.text.NumberFormat wholeFormat,
java.text.NumberFormat numeratorFormat,
java.text.NumberFormat denominatorFormat)
Create a proper formatting instance with a custom number format for each of the whole, numerator, and 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.text.NumberFormat |
getWholeFormat()
Access the whole format. |
Fraction |
parse(java.lang.String source,
java.text.ParsePosition pos)
Parses a string to produce a Fraction object. |
void |
setWholeFormat(java.text.NumberFormat format)
Modify the whole format. |
Methods inherited from class org.apache.commons.math.fraction.FractionFormat |
---|
format, formatFraction, getAvailableLocales, getDefaultNumberFormat, getDenominatorFormat, getImproperInstance, getImproperInstance, getNumeratorFormat, getProperInstance, getProperInstance, parse, parseAndIgnoreWhitespace, parseNextCharacter, parseObject, setDenominatorFormat, setNumeratorFormat |
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 wholeFormat
Constructor Detail |
---|
public ProperFractionFormat()
public ProperFractionFormat(java.text.NumberFormat format)
format
- the custom format for the whole, numerator, and
denominator.public ProperFractionFormat(java.text.NumberFormat wholeFormat, java.text.NumberFormat numeratorFormat, java.text.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 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 proper format.
format
in class FractionFormat
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.text.NumberFormat getWholeFormat()
public Fraction parse(java.lang.String source, java.text.ParsePosition pos)
Fraction
object. This method
expects the string to be formatted as a proper fraction.
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 FractionFormat
source
- the string to parsepos
- input/ouput parsing parameter.
Fraction
object.public void setWholeFormat(java.text.NumberFormat format)
format
- The new whole format value.
java.lang.IllegalArgumentException
- if format
is
null
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |