Package 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, QuantityFormat, tech.uom.lib.common.function.Parser<CharSequence,Quantity>

public class SimpleQuantityFormat
extends AbstractQuantityFormat

A simple implementation of QuantityFormat
The following pattern letters are defined:

Chart shows pattern letters, date/time component, presentation, and examples.

Letter	Quantity Component	Presentation	Examples
n	Numeric value	Number	27
u	Unit	Text	m
~	Mixed radix	Text	1 m; 27 cm
rc	Range	Compact	min=1 m, max=5 m

Pattern letters are usually repeated, as their number determines the exact presentation:

• Text: For formatting, if the number of pattern letters is 4 or more, the full form is used; otherwise a short or abbreviated form is used if available. For parsing, both forms are accepted, independent of the number of pattern letters.
  
  
• Number: For formatting, the number of pattern letters is the minimum number of digits, and shorter numbers are zero-padded to this amount. For parsing, the number of pattern letters is ignored unless it's needed to separate two adjacent fields.
  
  
• Mixed Radix: The Mixed radix marker "~" is followed by a character sequence acting as mixed radix delimiter. This character sequence must not contain "~" itself or any numeric values.
  
  
• Range: The Range compact part "rc" only applies to formatting instances of Range via formatRange(). It may be combined with the others. If set alone, then the default number and unit formatting is assumed.
  

Since:

2.0

Version:

2.3.2, Apr 23, 2025

See Also:

Serialized Form

Nested Class Summary

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

Format.Field

Field Summary

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

DEFAULT_DELIMITER

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Appendable	format(Quantity<?> quantity, Appendable dest)	Formats the specified quantity into an Appendable.
protected StringBuffer	formatMixed(MixedQuantity<?> mixed, StringBuffer dest)	Convenience method equivalent to #format(MixedQuantity, Appendable) except it does not raise an IOException.
String	formatRange(Range<?> range)	Formats a Range. If the special pattern part "rc" is applied, the compact format like "min=", "max=" is used, otherwise the full words like "minimum", "maximum", "resolution".
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()	Returns the pattern of this format.
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.
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

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 empty or invalid

SimpleQuantityFormat

protected SimpleQuantityFormat()

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

Method Detail

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.

formatRange

public String formatRange(Range<?> range)

Formats a Range.
If the special pattern part "rc" is applied, the compact format like "min=", "max=" is used, otherwise the full words like "minimum", "maximum", "resolution".

Parameters:

range - the range to format.

Returns:

the formatted range.

Since:

2.3

parse

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

MeasurementParseException

parse

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

MeasurementParseException

parse

public Quantity<?> parse(CharSequence csq)
                  throws 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:

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:

a default SimpleQuantityFormat instance.

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:

SimpleQuantityFormat.getInstance(a pattern)

toString

public String toString()

Overrides:

toString in class Object

getPattern

public String getPattern()

Returns the pattern of this format.

Returns:

a pattern

formatMixed

protected StringBuffer formatMixed(MixedQuantity<?> mixed,
                                   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:

mixed - the mixed quantity to format.

dest - the appendable destination.

Returns:

the specified StringBuilder.