tech.units.indriya.format

Class SimpleQuantityFormat

java.lang.Object

java.text.Format

tech.units.indriya.format.AbstractQuantityFormat

tech.units.indriya.format.SimpleQuantityFormat

All Implemented Interfaces:

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

public class SimpleQuantityFormat
extends AbstractQuantityFormat

A simple implementation of QuantityFormat

Since:

2.0

Version:

0.9

See Also:

Serialized Form

Nested Class Summary

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

Format.Field

Constructor Summary

Constructors

Constructor and Description
SimpleQuantityFormat() Constructs a SimpleQuantityFormat using the default pattern.
SimpleQuantityFormat(String pattern) Constructs a SimpleQuantityFormat using the given pattern.

Method Summary

Modifier and Type	Method and Description
Appendable	format(javax.measure.Quantity quantity, Appendable dest) Formats the specified quantity into an Appendable.
static SimpleQuantityFormat	getInstance() Returns the quantity format for the default locale.
static SimpleQuantityFormat	getInstance(String pattern) Returns a SimpleQuantityFormat using the given pattern.
String	getPattern()
ComparableQuantity<?>	parse(CharSequence csq) Parses a portion of the specified CharSequence from the specified position to produce an object.
ComparableQuantity<?>	parse(CharSequence csq, ParsePosition cursor) Parses a portion of the specified CharSequence from the specified position to produce an object.

Methods inherited from class tech.units.indriya.format.AbstractQuantityFormat

format, format, parseObject

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

SimpleQuantityFormat

public SimpleQuantityFormat(String pattern)

Constructs a SimpleQuantityFormat using the given pattern.

Parameters:

pattern - the pattern describing the quantity and unit format

Throws:

NullPointerException - if the given pattern is null

IllegalArgumentException - if the given pattern is invalid

SimpleQuantityFormat

public SimpleQuantityFormat()

Constructs a SimpleQuantityFormat using the default pattern. For full coverage, use the factory methods.

Method Detail

format

public Appendable format(javax.measure.Quantity quantity,
                         Appendable dest)
                  throws IOException

Description copied from class: AbstractQuantityFormat

Formats the specified quantity into an Appendable.

Specified by:

format in interface javax.measure.format.QuantityFormat

Specified by:

format in class AbstractQuantityFormat

Parameters:

quantity - the quantity to format.

dest - the appendable destination.

Returns:

the specified Appendable.

Throws:

IOException - if an I/O exception occurs.

parse

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

Description copied from class: AbstractQuantityFormat

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 class AbstractQuantityFormat

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:

javax.measure.format.MeasurementParseException

parse

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

Description copied from class: AbstractQuantityFormat

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,ComparableQuantity>

Specified by:

parse in class AbstractQuantityFormat

Parameters:

csq - the CharSequence to parse.

Returns:

the object parsed from the specified character sub-sequence.

Throws:

javax.measure.format.MeasurementParseException

getInstance

public static SimpleQuantityFormat 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 SimpleQuantityFormat getInstance(String pattern)

Returns a SimpleQuantityFormat using the given pattern.

Parameters:

pattern - the pattern describing the quantity and unit format

Returns:

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

getPattern

public String getPattern()