tec.units.ri.format

Class QuantityFormat

java.lang.Object

tec.units.ri.format.QuantityFormat

All Implemented Interfaces:

tec.uom.lib.common.function.Parser<CharSequence,javax.measure.Quantity>

public abstract class QuantityFormat
extends Object
implements tec.uom.lib.common.function.Parser<CharSequence,javax.measure.Quantity>

This class provides the interface for formatting and parsing quantities.

Instances of this class should be able to format quantities stated in CompoundUnit. See formatCompound(...).

Version:

0.8.4, $Date: 2016-04-20 $

Author:

Jean-Marie Dautelle, Werner Keil

Constructor Summary

Constructors

Constructor and Description
QuantityFormat()

Method Summary

Methods

Modifier and Type	Method and Description
String	format(javax.measure.Quantity q) Formats an object to produce a string.
abstract Appendable	format(javax.measure.Quantity<?> quantity, Appendable dest) Formats the specified quantity into an Appendable.
StringBuilder	format(javax.measure.Quantity<?> q, StringBuilder dest) Convenience method equivalent to #format(AbstractQuantity, Appendable) except it does not raise an IOException.
static QuantityFormat	getInstance() Returns the quantity format for the default locale.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface tec.uom.lib.common.function.Parser

parse

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

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.

format

public final StringBuilder format(javax.measure.Quantity<?> q,
                   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.

format

public final String format(javax.measure.Quantity q)

Formats an object to produce a string. This is equivalent to

format(unit, new StringBuilder()).toString();

Parameters:

obj - The object to format

Returns:

Formatted string.

Throws:

IllegalArgumentException - if the Format cannot format the given object