Package javax.measure.format

Interface QuantityFormat

public interface QuantityFormat

Formats instances of Quantity.

Synchronization

Instances of this class are not required to be thread-safe. It is recommended to use separate format instances for each thread. If multiple threads access a format concurrently, it must be synchronized externally.

Since:

2.0

Version:

0.9, 22 Feb, 2019

Author:

Werner Keil, Thodoris Bais

See Also:

Quantity

Method Summary

Modifier and Type	Method	Description
String	format(Quantity<?> quantity)	Formats the specified Quantity.
Appendable	format(Quantity<?> quantity, Appendable destination)	Formats the specified quantity into an Appendable.
default boolean	isLocaleSensitive()	Returns true if this QuantityFormat depends on a Locale to perform its tasks.
Quantity<?>	parse(CharSequence csq)	Parses a portion of the specified CharSequence from the specified position to produce a Quantity.
Quantity<?>	parse(CharSequence csq, ParsePosition pos)	Parses a portion of the specified CharSequence from the specified position to produce a Quantity.

Method Detail

format

Appendable format(Quantity<?> quantity,
                  Appendable destination)
           throws IOException

Formats the specified quantity into an Appendable.

Parameters:

quantity - the quantity to format.

destination - the appendable destination.

Returns:

the specified Appendable.

Throws:

IOException - if an I/O exception occurs.

format

String format(Quantity<?> quantity)

Formats the specified Quantity.

Parameters:

quantity - the Quantity to format, not null

Returns:

the string representation using the settings of this QuantityFormat.

parse

Quantity<?> parse(CharSequence csq,
                  ParsePosition pos)
           throws IllegalArgumentException,
                  MeasurementParseException

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

Parameters:

csq - the CharSequence to parse.

pos - a ParsePosition object holding the current parsing index and error parsing index information as described above.

Returns:

the quantity parsed from the specified character sub-sequence.

Throws:

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

MeasurementParseException

parse

Quantity<?> parse(CharSequence csq)
           throws MeasurementParseException

Parses a portion of the specified CharSequence from the specified position to produce a Quantity.

Parameters:

csq - the CharSequence to parse.

Returns:

the quantity parsed from the specified character sub-sequence.

Throws:

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

MeasurementParseException

isLocaleSensitive

default boolean isLocaleSensitive()

Returns true if this QuantityFormat depends on a Locale to perform its tasks.

In environments that do not support a Locale, e.g. Java ME, this usually returns false.

Returns:

whether this format depends on the locale.