tec.uom.se.format

Class QuantityFormat

java.lang.Object

java.text.Format

tec.uom.se.format.QuantityFormat

All Implemented Interfaces:

Serializable, Cloneable, tec.uom.lib.common.function.Parser<CharSequence,ComparableQuantity>

public abstract class QuantityFormat
extends Format
implements tec.uom.lib.common.function.Parser<CharSequence,ComparableQuantity>

This class provides the interface for formatting and parsing quantities.

Since:

1.0

Version:

1.0.1, $Date: 2017-07-10 $

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
QuantityFormat()

Method Summary

Modifier and Type	Method and Description
StringBuilder	format(AbstractQuantity<?> quantity, StringBuilder dest) Convenience method equivalent to #format(AbstractQuantity, Appendable) except it does not raise an IOException.
StringBuffer	format(Object obj, StringBuffer toAppendTo, FieldPosition pos)
abstract Appendable	format(javax.measure.Quantity<?> quantity, Appendable dest) Formats the specified quantity into an Appendable.
static QuantityFormat	getInstance() Returns the quantity format for the default locale.
static QuantityFormat	getInstance(FormatBehavior style) Returns the culture invariant format based upon BigDecimal canonical format and the standard unit format.
static QuantityFormat	getInstance(NumberFormat numberFormat, javax.measure.format.UnitFormat unitFormat) Returns the quantity format using the specified number format and unit format (the number and unit are separated by one space).
abstract ComparableQuantity<?>	parse(CharSequence csq) Parses a portion of the specified CharSequence from the specified position to produce an object.
abstract ComparableQuantity<?>	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

Constructor Detail

QuantityFormat

public QuantityFormat()

Method Detail

getInstance

public static QuantityFormat getInstance()

Returns the quantity format for the default locale. The default format assumes the quantity is composed of a decimal number and a Unit separated by whitespace(s).

Returns:

MeasureFormat.getInstance(NumberFormat.getInstance(), UnitFormat.getInstance())

getInstance

public static QuantityFormat getInstance(NumberFormat numberFormat,
                                         javax.measure.format.UnitFormat unitFormat)

Returns the quantity format using the specified number format and unit format (the number and unit are separated by one space).

Parameters:

numberFormat - the number format.

unitFormat - the unit format.

Returns:

the corresponding format.

getInstance

public static QuantityFormat getInstance(FormatBehavior style)

Returns the culture invariant format based upon BigDecimal canonical format and the standard unit format. This format is not locale-sensitive and can be used for unambiguous electronic communication of quantities together with their units without loss of information. For example: "1.23456789 kg.m/s2" returns Quantities.getQuantity(new BigDecimal("1.23456789"), AbstractUnit.parse("kg.m/s2")));

Parameters:

style - the format style to apply.

Returns:

the desired format.

format

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

Formats the specified quantity into an Appendable.

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 ComparableQuantity<?> parse(CharSequence csq,
                                            ParsePosition cursor)
                                     throws IllegalArgumentException,
                                            javax.measure.format.ParserException

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.

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.ParserException

parse

public abstract ComparableQuantity<?> parse(CharSequence csq)
                                     throws IllegalArgumentException,
                                            javax.measure.format.ParserException

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 tec.uom.lib.common.function.Parser<CharSequence,ComparableQuantity>

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.ParserException

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

public final StringBuilder format(AbstractQuantity<?> quantity,
                                  StringBuilder dest)

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

Parameters:

quantity - the quantity to format.

dest - the appendable destination.

Returns:

the specified StringBuilder.