tech.uom.impl.enums.format

Class SimpleUnitFormat

java.lang.Object

tech.uom.impl.enums.format.SimpleUnitFormat

All Implemented Interfaces:

javax.measure.format.UnitFormat

public class SimpleUnitFormat
extends Object

This class provides a simple interface for formatting and parsing units.

Version:

2.0, $Date: 2020-12-06 $

Author:

Werner Keil

Method Summary

Modifier and Type	Method and Description
StringBuffer	format(Object obj, StringBuffer toAppendTo)
String	format(javax.measure.Unit<?> unit) Formats an object to produce a string.
Appendable	format(javax.measure.Unit<?> unit, Appendable appendable) Formats the specified unit.
static javax.measure.format.UnitFormat	getInstance() Returns the default instance for formatting
boolean	isLocaleSensitive()
void	label(javax.measure.Unit<?> unit, String label)
javax.measure.Unit<?>	parse(CharSequence csq) Parses the specified character sequence to produce a unit (convenience method).
protected javax.measure.Unit<?>	parse(CharSequence csq, int index)
javax.measure.Unit<?>	parse(CharSequence csq, ParsePosition pos) Parses the specified character sequence to produce a unit (convenience method).
javax.measure.Unit<?>	parseObject(String source)

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static javax.measure.format.UnitFormat getInstance()

Returns the default instance for formatting

format

public Appendable format(javax.measure.Unit<?> unit,
                         Appendable appendable)
                  throws IOException

Formats the specified unit.

Specified by:

format in interface javax.measure.format.UnitFormat

Parameters:

unit - the unit to format.

appendable - the appendable destination.

Returns:

The appendable destination passed in as appendable, with formatted text appended.

Throws:

IOException - if an error occurs.

label

public void label(javax.measure.Unit<?> unit,
                  String label)

isLocaleSensitive

public boolean isLocaleSensitive()

parse

protected javax.measure.Unit<?> parse(CharSequence csq,
                                      int index)
                               throws javax.measure.format.MeasurementParseException

Throws:

javax.measure.format.MeasurementParseException

parse

public final javax.measure.Unit<?> parse(CharSequence csq,
                                         ParsePosition pos)
                                  throws javax.measure.format.MeasurementParseException

Parses the specified character sequence to produce a unit (convenience method). If the specified sequence is empty, the unitary unit (dimensionless) is returned.

Parameters:

csq - the CharSequence to parse.

Returns:

the unit parsed from the specified character sub-sequence.

Throws:

javax.measure.format.MeasurementParseException - if any problem occurs while parsing the specified character sequence (e.g. illegal syntax).

format

public final String format(javax.measure.Unit<?> unit)

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

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

Specified by:

format in interface javax.measure.format.UnitFormat

Parameters:

obj - The object to format

Returns:

Formatted string.

Throws:

IllegalArgumentException - if the Format cannot format the given object

parse

public final javax.measure.Unit<?> parse(CharSequence csq)
                                  throws IllegalArgumentException

Parses the specified character sequence to produce a unit (convenience method). If the specified sequence is empty, the unitary unit (dimensionless) is returned.

Specified by:

parse in interface javax.measure.format.UnitFormat

Parameters:

csq - the CharSequence to parse.

Returns:

the unit parsed from the specified character sub-sequence.

Throws:

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

format

public final StringBuffer format(Object obj,
                                 StringBuffer toAppendTo)

parseObject

public final javax.measure.Unit<?> parseObject(String source)