Units of Measurement Reference Implementation 2.2.2 · tech.units.indriya.format.SimpleQuantityFormat

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

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`

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.

Field Summary

Modifier and Type	Field and Description
private static final SimpleQuantityFormat	DEFAULT Holds the default format instance.
private String	delimiter
private String	mixDelimiter
private static final String	NUM_PART
private final String	pattern The pattern string of this formatter.
private static final String	RADIX
private static final long	serialVersionUID Hides tech.units.indriya.format.AbstractQuantityFormat.serialVersionUID.
private static final String	UNIT_PART

Inherited from tech.units.indriya.format.AbstractQuantityFormat:: DEFAULT_DELIMITER

Constructor Summary

Access	Constructor and Description
public	SimpleQuantityFormat(String the pattern describing the quantity and unit format pattern) Constructs a `SimpleQuantityFormat` using the given pattern.
protected	SimpleQuantityFormat() Constructs a `SimpleQuantityFormat` using the default pattern.

Method Summary

Modifier and Type	Method and Description
public Appendable	format(Quantity<?> the quantity to format. quantity, Appendable the appendable destination. dest) Implements abstract tech.units.indriya.format.AbstractQuantityFormat.format. Implements javax.measure.format.QuantityFormat.format. Formats the specified quantity into an `Appendable`.
protected StringBuffer	formatMixed(MixedQuantity<?> the mixed quantity to format. mixed, StringBuffer the appendable destination. dest) Implements abstract tech.units.indriya.format.AbstractQuantityFormat.formatMixed. Convenience method equivalent to `format(MixedQuantity, Appendable)` except it does not raise an IOException.
public static SimpleQuantityFormat	Returns: a default `SimpleQuantityFormat` instance. getInstance() Returns the quantity format for the default locale.
public static SimpleQuantityFormat	Returns: `SimpleQuantityFormat.getInstance(a pattern)` getInstance(String the pattern describing the quantity and unit format pattern) Returns a `SimpleQuantityFormat` using the given pattern.
public String	Returns: a `pattern` getPattern() Returns the pattern of this format.
public Quantity<?>	parse(CharSequence the `CharSequence` to parse. csq, ParsePosition the cursor holding the current parsing index. cursor) Implements abstract tech.units.indriya.format.AbstractQuantityFormat.parse. Implements javax.measure.format.QuantityFormat.parse. Parses a portion of the specified `CharSequence` from the specified position to produce an object.
protected Quantity<?>	parse(CharSequence the `CharSequence` to parse. csq, int the current parsing index. index) Implements abstract tech.units.indriya.format.AbstractQuantityFormat.parse. Parses a portion of the specified `CharSequence` from the specified position to produce an object.
public Quantity<?>	parse(CharSequence the `CharSequence` to parse. csq) Implements abstract tech.units.indriya.format.AbstractQuantityFormat.parse. Implements javax.measure.format.QuantityFormat.parse, tech.uom.lib.common.function.Parser.parse. Parses a portion of the specified `CharSequence` from the specified position to produce an object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from tech.units.indriya.format.AbstractQuantityFormat:: format format format parseObject

Field Detail

DEFAULT	back to summary
private static final SimpleQuantityFormat DEFAULT Holds the default format instance.

delimiter	back to summary
private String delimiter

mixDelimiter	back to summary
private String mixDelimiter

NUM_PART	back to summary
private static final String NUM_PART

pattern	back to summary
private final String pattern The pattern string of this formatter. This is always a non-localized pattern. May not be null. See class documentation for details.

RADIX	back to summary
private static final String RADIX

serialVersionUID	back to summary
private static final long serialVersionUID Hides tech.units.indriya.format.AbstractQuantityFormat.serialVersionUID.

UNIT_PART	back to summary
private static final String UNIT_PART

Constructor Detail

SimpleQuantityFormat back to summary

SimpleQuantityFormat	back to summary
public SimpleQuantityFormat(String pattern) Constructs a `SimpleQuantityFormat` using the given pattern. Parameters pattern:String the pattern describing the quantity and unit format Exceptions NullPointerException: if the given pattern is null IllegalArgumentException: if the given pattern is invalid

public SimpleQuantityFormat(String pattern)

Constructs a SimpleQuantityFormat using the given pattern.

Parameters

pattern:String: the pattern describing the quantity and unit format

Exceptions

NullPointerException:: if the given pattern is null
IllegalArgumentException:: if the given pattern is invalid

SimpleQuantityFormat	back to summary
protected SimpleQuantityFormat() Constructs a `SimpleQuantityFormat` using the default pattern. For full coverage, use the factory methods.

Method Detail

format back to summary

format	back to summary
public Appendable format(Quantity<?> quantity, Appendable dest) throws IOException Implements abstract tech.units.indriya.format.AbstractQuantityFormat.format. Implements javax.measure.format.QuantityFormat.format. Doc from tech.units.indriya.format.AbstractQuantityFormat.format. Formats the specified quantity into an `Appendable`. Parameters quantity:Quantity<?> the quantity to format. dest:Appendable the appendable destination. Returns:Appendable the specified `Appendable`. Annotations @Override Exceptions IOException: if an I/O exception occurs.

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

Implements abstract tech.units.indriya.format.AbstractQuantityFormat.format.

Implements javax.measure.format.QuantityFormat.format.

Doc from tech.units.indriya.format.AbstractQuantityFormat.format.

Formats the specified quantity into an Appendable.

Parameters

quantity:Quantity<?>: the quantity to format.
dest:Appendable: the appendable destination.

Returns:Appendable

the specified Appendable.

Annotations

@Override

Exceptions

IOException:: if an I/O exception occurs.

formatMixed back to summary

formatMixed	back to summary
protected StringBuffer formatMixed(MixedQuantity<?> mixed, StringBuffer dest) Implements abstract tech.units.indriya.format.AbstractQuantityFormat.formatMixed. Doc from tech.units.indriya.format.AbstractQuantityFormat.formatMixed. Convenience method equivalent to `format(MixedQuantity, Appendable)` except it does not raise an IOException. Parameters mixed:MixedQuantity<?> the mixed quantity to format. dest:StringBuffer the appendable destination. Returns:StringBuffer the specified `StringBuilder`. Annotations @Override

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

Implements abstract tech.units.indriya.format.AbstractQuantityFormat.formatMixed.

Doc from tech.units.indriya.format.AbstractQuantityFormat.formatMixed.

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

Parameters

mixed:MixedQuantity<?>: the mixed quantity to format.
dest:StringBuffer: the appendable destination.

Returns:StringBuffer

the specified StringBuilder.

Annotations

@Override

getInstance back to summary

getInstance	back to summary
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:SimpleQuantityFormat a default `SimpleQuantityFormat` instance.

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:SimpleQuantityFormat: a default SimpleQuantityFormat instance.

getInstance back to summary

getInstance	back to summary
public static SimpleQuantityFormat getInstance(String pattern) Returns a `SimpleQuantityFormat` using the given pattern. Parameters pattern:String the pattern describing the quantity and unit format Returns:SimpleQuantityFormat `SimpleQuantityFormat.getInstance(a pattern)`

public static SimpleQuantityFormat getInstance(String pattern)

Returns a SimpleQuantityFormat using the given pattern.

Parameters

pattern:String: the pattern describing the quantity and unit format

Returns:SimpleQuantityFormat

SimpleQuantityFormat.getInstance(a pattern)

getPattern back to summary

getPattern	back to summary
public String getPattern() Returns the pattern of this format. Returns:String a `pattern`

public String getPattern()

Returns the pattern of this format.

Returns:String: a pattern

parse back to summary

parse	back to summary
public Quantity<?> parse(CharSequence csq, ParsePosition cursor) throws MeasurementParseException Implements abstract tech.units.indriya.format.AbstractQuantityFormat.parse. Implements javax.measure.format.QuantityFormat.parse. Doc from tech.units.indriya.format.AbstractQuantityFormat.parse. 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. Parameters csq:CharSequence the `CharSequence` to parse. cursor:ParsePosition the cursor holding the current parsing index. Returns:Quantity<?> the object parsed from the specified character sub-sequence. Annotations @SuppressWarnings:unchecked @Override Exceptions MeasurementParseException: Doc from javax.measure.format.QuantityFormat.parse. if any problem occurs while parsing the specified character sequence (e.g. illegal syntax).

public Quantity<?> parse(CharSequence csq, ParsePosition cursor) throws MeasurementParseException

Implements abstract tech.units.indriya.format.AbstractQuantityFormat.parse.

Implements javax.measure.format.QuantityFormat.parse.

Doc from tech.units.indriya.format.AbstractQuantityFormat.parse.

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.

Parameters

csq:CharSequence: the CharSequence to parse.
cursor:ParsePosition: the cursor holding the current parsing index.

Returns:Quantity<?>

the object parsed from the specified character sub-sequence.

Annotations

@SuppressWarnings:unchecked
@Override

Exceptions

MeasurementParseException:

Doc from javax.measure.format.QuantityFormat.parse.

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

parse back to summary

parse	back to summary
protected Quantity<?> parse(CharSequence csq, int index) throws MeasurementParseException Implements abstract tech.units.indriya.format.AbstractQuantityFormat.parse. Doc from tech.units.indriya.format.AbstractQuantityFormat.parse. 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. Parameters csq:CharSequence the `CharSequence` to parse. index:int the current parsing index. Returns:Quantity<?> the object parsed from the specified character sub-sequence. Annotations @Override

protected Quantity<?> parse(CharSequence csq, int index) throws MeasurementParseException

Implements abstract tech.units.indriya.format.AbstractQuantityFormat.parse.

Doc from tech.units.indriya.format.AbstractQuantityFormat.parse.

Parameters

csq:CharSequence: the CharSequence to parse.
index:int: the current parsing index.

Returns:Quantity<?>

the object parsed from the specified character sub-sequence.

Annotations

@Override

parse back to summary

parse	back to summary
public Quantity<?> parse(CharSequence csq) throws MeasurementParseException Implements abstract tech.units.indriya.format.AbstractQuantityFormat.parse. Implements javax.measure.format.QuantityFormat.parse, tech.uom.lib.common.function.Parser.parse. Doc from tech.units.indriya.format.AbstractQuantityFormat.parse. 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. Parameters csq:CharSequence the `CharSequence` to parse. Returns:Quantity<?> the object parsed from the specified character sub-sequence. Annotations @Override Exceptions MeasurementParseException: Doc from javax.measure.format.QuantityFormat.parse. if any problem occurs while parsing the specified character sequence (e.g. illegal syntax).

public Quantity<?> parse(CharSequence csq) throws MeasurementParseException

Implements abstract tech.units.indriya.format.AbstractQuantityFormat.parse.

Implements javax.measure.format.QuantityFormat.parse, tech.uom.lib.common.function.Parser.parse.

Doc from tech.units.indriya.format.AbstractQuantityFormat.parse.

Parameters

csq:CharSequence: the CharSequence to parse.

Returns:Quantity<?>

the object parsed from the specified character sub-sequence.

Annotations

@Override

Exceptions

MeasurementParseException:

Doc from javax.measure.format.QuantityFormat.parse.

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

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class SimpleQuantityFormat

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail