javax.measure.format

Interface UnitFormat

All Superinterfaces:

Parser<CharSequence,Unit<?>>

public interface UnitFormat
extends Parser<CharSequence,Unit<?>>

Formats instances of Unit to a String or an Appendable and parses a CharSequence to a Unit.

Version:

0.5, Dec 3, 2014

Author:

Jean-Marie Dautelle, Werner Keil

See Also:

Unit, Parser

Method Summary

Methods

Modifier and Type	Method and Description
Appendable	format(Unit<?> unit, Appendable appendable) Formats the specified unit.
Unit<?>	parse(CharSequence csq) Parses a portion of the specified CharSequence from the specified position to produce a unit.

Method Detail

format

Appendable format(Unit<?> unit,
                Appendable appendable)
                  throws IOException

Formats the specified unit.

Parameters:

unit - the unit to format.

appendable - the appendable destination.

Returns:

the appendable destination passed in with formatted text appended.

Throws:

IOException - if an error occurs while writing to the destination.

parse

Unit<?> parse(CharSequence csq)
              throws ParserException

Parses a portion of the specified CharSequence from the specified position to produce a unit. If there is no unit to parse the unitary unit (dimensionless) is returned.

Specified by:

parse in interface Parser<CharSequence,Unit<?>>

Parameters:

csq - the CharSequence to parse.

Returns:

the unit parsed from the specified character sub-sequence.

Throws:

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