Package tech.units.indriya.format

Class NumberDelimiterQuantityFormat

java.lang.Object

java.text.Format

tech.units.indriya.format.AbstractQuantityFormat

tech.units.indriya.format.NumberDelimiterQuantityFormat

All Implemented Interfaces:

Serializable, Cloneable, QuantityFormat, tech.uom.lib.common.function.Parser<CharSequence,Quantity>

public class NumberDelimiterQuantityFormat
extends AbstractQuantityFormat

An implementation of QuantityFormat combining NumberFormat and UnitFormat separated by a delimiter.

Since:

2.0

Version:

2.9, $Date: 2024-10-12 $

Author:

Werner Keil, Thodoris Bais

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NumberDelimiterQuantityFormat.Builder	A fluent Builder to easily create new instances of NumberDelimiterQuantityFormat.

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

Format.Field

Field Summary

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

DEFAULT_DELIMITER

Method Summary

Modifier and Type	Method	Description
static NumberDelimiterQuantityFormat.Builder	builder()	Returns a new instance of NumberDelimiterQuantityFormat.Builder.
Appendable	format(Quantity<?> quantity, Appendable dest)	Formats the specified quantity into an Appendable.
protected StringBuffer	formatMixed(MixedQuantity<?> comp, StringBuffer dest)	Convenience method equivalent to #format(MixedQuantity, Appendable) except it does not raise an IOException.
static NumberDelimiterQuantityFormat	getInstance()	Returns the default format.
static NumberDelimiterQuantityFormat	getInstance(NumberFormat numberFormat, UnitFormat unitFormat)	Returns the quantity format using the specified number format and unit format (the number and unit are separated by one space).
static NumberDelimiterQuantityFormat	getInstance(FormatBehavior behavior)	Returns an instance of NumberDelimiterQuantityFormat with a particular FormatBehavior, either locale-sensitive or locale-neutral.
static NumberDelimiterQuantityFormat	getInstance(FormatBehavior behavior, int numberStyle)	Returns an instance of NumberDelimiterQuantityFormat with a particular FormatBehavior, either locale-sensitive or locale-neutral, and a desired number style. For example: NumberDelimiterQuantityFormat.getInstance(LOCALE_NEUTRAL)) returns new NumberDelimiterQuantityFormat.Builder().setNumberFormat(NumberFormat.getInstance(Locale.ROOT)).setUnitFormat(SimpleUnitFormat.getInstance()).build();
boolean	isLocaleSensitive()
Quantity<?>	parse(CharSequence csq)	Parses a portion of the specified CharSequence from the specified position to produce an object.
protected Quantity<?>	parse(CharSequence csq, int index)	Parses a portion of the specified CharSequence from the specified position to produce an object.
Quantity<?>	parse(CharSequence csq, ParsePosition cursor)	Parses a portion of the specified CharSequence from the specified position to produce an object.
MixedQuantity<?>	parseMixed(CharSequence csq)
protected MixedQuantity<?>	parseMixed(CharSequence csq, int index)
MixedQuantity<?>	parseMixed(CharSequence csq, ParsePosition cursor)
String	toString()

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

format, 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, wait, wait, wait

Method Detail

getInstance

public static NumberDelimiterQuantityFormat getInstance(FormatBehavior behavior)

Returns an instance of NumberDelimiterQuantityFormat with a particular FormatBehavior, either locale-sensitive or locale-neutral. For example: NumberDelimiterQuantityFormat.getInstance(LOCALE_NEUTRAL)) returns
new NumberDelimiterQuantityFormat.Builder() .setNumberFormat(NumberFormat.getInstance(Locale.ROOT)).setUnitFormat(SimpleUnitFormat.getInstance()).build();

Parameters:

behavior - the format behavior to apply.

Returns:

NumberDelimiterQuantityFormat.getInstance(NumberFormat.getInstance(), UnitFormat.getInstance())

getInstance

public static NumberDelimiterQuantityFormat getInstance(FormatBehavior behavior,
                                                        int numberStyle)

Returns an instance of NumberDelimiterQuantityFormat with a particular FormatBehavior, either locale-sensitive or locale-neutral, and a desired number style.
For example: NumberDelimiterQuantityFormat.getInstance(LOCALE_NEUTRAL)) returns
new NumberDelimiterQuantityFormat.Builder().setNumberFormat(NumberFormat.getInstance(Locale.ROOT)).setUnitFormat(SimpleUnitFormat.getInstance()).build();

Parameters:

behavior - the format behavior to apply.

numberStyle - the number format style to apply.

Returns:

NumberDelimiterQuantityFormat.getInstance(NumberFormat.getInstance(), UnitFormat.getInstance())

Since:

2.9

builder

public static final NumberDelimiterQuantityFormat.Builder builder()

Returns a new instance of NumberDelimiterQuantityFormat.Builder.

Returns:

a new NumberDelimiterQuantityFormat.Builder.

getInstance

public static NumberDelimiterQuantityFormat getInstance()

Returns the default format.

Returns:

the desired format.

getInstance

public static NumberDelimiterQuantityFormat getInstance(NumberFormat numberFormat,
                                                        UnitFormat unitFormat)

Returns the quantity format using the specified number format and unit format (the number and unit are separated by one space).

Parameters:

numberFormat - the number format.

unitFormat - the unit format.

Returns:

the corresponding format.

format

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

Description copied from class: AbstractQuantityFormat

Formats the specified quantity into an Appendable.

Specified by:

format in interface 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 Quantity<?> parse(CharSequence csq,
                         ParsePosition cursor)
                  throws IllegalArgumentException,
                         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 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:

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

MeasurementParseException

parse

protected Quantity<?> parse(CharSequence csq,
                            int index)
                     throws IllegalArgumentException,
                            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 class AbstractQuantityFormat

Parameters:

csq - the CharSequence to parse.

index - the current parsing index.

Returns:

the object 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

public Quantity<?> parse(CharSequence csq)
                  throws IllegalArgumentException,
                         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 tech.uom.lib.common.function.Parser<CharSequence,Quantity>

Specified by:

parse in interface QuantityFormat

Specified by:

parse in class AbstractQuantityFormat

Parameters:

csq - the CharSequence to parse.

Returns:

the object parsed from the specified character sub-sequence.

Throws:

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

MeasurementParseException

toString

public String toString()

Overrides:

toString in class Object

isLocaleSensitive

public boolean isLocaleSensitive()

formatMixed

protected StringBuffer formatMixed(MixedQuantity<?> comp,
                                   StringBuffer dest)

Description copied from class: AbstractQuantityFormat

Convenience method equivalent to #format(MixedQuantity, Appendable) except it does not raise an IOException.

Specified by:

formatMixed in class AbstractQuantityFormat

Parameters:

comp - the mixed quantity to format.

dest - the appendable destination.

Returns:

the specified StringBuilder.

parseMixed

public MixedQuantity<?> parseMixed(CharSequence csq,
                                   ParsePosition cursor)
                            throws IllegalArgumentException,
                                   MeasurementParseException

Throws:

IllegalArgumentException

MeasurementParseException

parseMixed

protected MixedQuantity<?> parseMixed(CharSequence csq,
                                      int index)
                               throws IllegalArgumentException,
                                      MeasurementParseException

Throws:

IllegalArgumentException

MeasurementParseException

parseMixed

public MixedQuantity<?> parseMixed(CharSequence csq)
                            throws IllegalArgumentException,
                                   MeasurementParseException

Throws:

IllegalArgumentException

MeasurementParseException