tech.uom.impl.enums.format

Class AbstractQuantityFormat

java.lang.Object

java.text.Format

tech.uom.impl.enums.format.AbstractQuantityFormat

All Implemented Interfaces:

Serializable, Cloneable, javax.measure.format.QuantityFormat, tech.uom.lib.common.function.Parser<CharSequence,javax.measure.Quantity>

Direct Known Subclasses:

SimpleQuantityFormat

public abstract class AbstractQuantityFormat
extends Format
implements javax.measure.format.QuantityFormat, tech.uom.lib.common.function.Parser<CharSequence,javax.measure.Quantity>

This class provides the interface for formatting and parsing quantities.

Since:

2.0

Version:

1.1, $Date: 2019-03-11 $

Author:

Jean-Marie Dautelle, Werner Keil

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.text.Format

Format.Field

Constructor Summary

Constructors

Constructor and Description
AbstractQuantityFormat()

Method Summary

Modifier and Type	Method and Description
StringBuffer	format(Object obj, StringBuffer toAppendTo, FieldPosition pos)
String	format(javax.measure.Quantity<?> quantity)
abstract Appendable	format(javax.measure.Quantity<?> quantity, Appendable dest) Formats the specified quantity into an Appendable.
protected StringBuffer	format(javax.measure.Quantity<?> quantity, StringBuffer dest) Convenience method equivalent to format(Quantity, Appendable) except it does not raise an IOException.
abstract javax.measure.Quantity<?>	parse(CharSequence csq) Parses a portion of the specified CharSequence from the specified position to produce an object.
abstract javax.measure.Quantity<?>	parse(CharSequence csq, ParsePosition cursor) Parses a portion of the specified CharSequence from the specified position to produce an object.
javax.measure.Quantity<?>	parseObject(String source, ParsePosition pos)

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

Methods inherited from interface javax.measure.format.QuantityFormat

isLocaleSensitive

Constructor Detail

AbstractQuantityFormat

public AbstractQuantityFormat()

Method Detail

format

public abstract Appendable format(javax.measure.Quantity<?> quantity,
                                  Appendable dest)
                           throws IOException

Formats the specified quantity into an Appendable.

Specified by:

format in interface javax.measure.format.QuantityFormat

Parameters:

quantity - the quantity to format.

dest - the appendable destination.

Returns:

the specified Appendable.

Throws:

IOException - if an I/O exception occurs.

parse

public abstract javax.measure.Quantity<?> parse(CharSequence csq,
                                                ParsePosition cursor)
                                         throws IllegalArgumentException,
                                                javax.measure.format.MeasurementParseException

Parses a portion of the specified CharSequence from the specified position to produce an object. If parsing succeeds, then the index of the cursor argument is updated to the index after the last character used.

Specified by:

parse in interface javax.measure.format.QuantityFormat

Parameters:

csq - the CharSequence to parse.

cursor - the cursor holding the current parsing index.

Returns:

the object parsed from the specified character sub-sequence.

Throws:

IllegalArgumentException - if any problem occurs while parsing the specified character sequence (e.g. illegal syntax).

javax.measure.format.MeasurementParseException

parse

public abstract javax.measure.Quantity<?> parse(CharSequence csq)
                                         throws javax.measure.format.MeasurementParseException

Parses a portion of the specified CharSequence from the specified position to produce an object. If parsing succeeds, then the index of the cursor argument is updated to the index after the last character used.

Specified by:

parse in interface javax.measure.format.QuantityFormat

Specified by:

parse in interface tech.uom.lib.common.function.Parser<CharSequence,javax.measure.Quantity>

Parameters:

csq - the CharSequence to parse.

cursor - the cursor holding the current parsing index.

Returns:

the object parsed from the specified character sub-sequence.

Throws:

IllegalArgumentException - if any problem occurs while parsing the specified character sequence (e.g. illegal syntax).

javax.measure.format.MeasurementParseException

format

public final StringBuffer format(Object obj,
                                 StringBuffer toAppendTo,
                                 FieldPosition pos)

Specified by:

format in class Format

parseObject

public final javax.measure.Quantity<?> parseObject(String source,
                                                   ParsePosition pos)

Specified by:

parseObject in class Format

format

protected final StringBuffer format(javax.measure.Quantity<?> quantity,
                                    StringBuffer dest)

Convenience method equivalent to format(Quantity, Appendable) except it does not raise an IOException.

Parameters:

quantity - the quantity to format.

dest - the appendable destination.

Returns:

the specified StringBuilder.

format

public final String format(javax.measure.Quantity<?> quantity)

Specified by:

format in interface javax.measure.format.QuantityFormat