Package tech.units.indriya.format
Class AbstractQuantityFormat
java.lang.Object
java.text.Format
tech.units.indriya.format.AbstractQuantityFormat
- All Implemented Interfaces:
Serializable
,Cloneable
,QuantityFormat
,tech.uom.lib.common.function.Parser<CharSequence,
ComparableQuantity>
- Direct Known Subclasses:
NumberSpaceQuantityFormat
,SimpleQuantityFormat
public abstract class AbstractQuantityFormat
extends Format
implements QuantityFormat, tech.uom.lib.common.function.Parser<CharSequence,ComparableQuantity>
This class provides the interface for formatting and parsing quantities
.
- Since:
- 1.0
- Version:
- 1.1, $Date: 2018-04-06 $
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.text.Format
Format.Field
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal StringBuffer
format
(Object obj, StringBuffer toAppendTo, FieldPosition pos) abstract Appendable
format
(javax.measure.Quantity<?> quantity, Appendable dest) Formats the specified quantity into anAppendable
.final StringBuilder
format
(AbstractQuantity<?> quantity, StringBuilder dest) Convenience method equivalent toinvalid reference
#format(AbstractQuantity, Appendable)
abstract ComparableQuantity
<?> parse
(CharSequence csq) Parses a portion of the specifiedCharSequence
from the specified position to produce an object.(package private) abstract ComparableQuantity
<?> parse
(CharSequence csq, int index) Parses a portion of the specifiedCharSequence
from the specified position to produce an object.abstract ComparableQuantity
<?> parse
(CharSequence csq, ParsePosition cursor) Parses a portion of the specifiedCharSequence
from the specified position to produce an object.final javax.measure.Quantity
<?> parseObject
(String source, ParsePosition pos) Methods inherited from class java.text.Format
clone, format, formatToCharacterIterator, parseObject
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface tech.units.indriya.format.QuantityFormat
isLocaleSensitive
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
-
Constructor Details
-
AbstractQuantityFormat
public AbstractQuantityFormat()
-
-
Method Details
-
format
public abstract Appendable format(javax.measure.Quantity<?> quantity, Appendable dest) throws IOException Formats the specified quantity into anAppendable
.- Specified by:
format
in interfaceQuantityFormat
- Parameters:
quantity
- the quantity to format.dest
- the appendable destination.- Returns:
- the specified
Appendable
. - Throws:
IOException
- if an I/O exception occurs.
-
parse
public abstract ComparableQuantity<?> parse(CharSequence csq, ParsePosition cursor) throws IllegalArgumentException, javax.measure.format.ParserException Parses a portion of the specifiedCharSequence
from the specified position to produce an object. If parsing succeeds, then the index of thecursor
argument is updated to the index after the last character used.- Specified by:
parse
in interfaceQuantityFormat
- Parameters:
csq
- theCharSequence
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).javax.measure.format.ParserException
-
parse
public abstract ComparableQuantity<?> parse(CharSequence csq) throws javax.measure.format.ParserException Parses a portion of the specifiedCharSequence
from the specified position to produce an object. If parsing succeeds, then the index of thecursor
argument is updated to the index after the last character used.- Specified by:
parse
in interfacetech.uom.lib.common.function.Parser<CharSequence,
ComparableQuantity> - Specified by:
parse
in interfaceQuantityFormat
- Parameters:
csq
- theCharSequence
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).javax.measure.format.ParserException
-
parse
abstract ComparableQuantity<?> parse(CharSequence csq, int index) throws IllegalArgumentException, javax.measure.format.ParserException Parses a portion of the specifiedCharSequence
from the specified position to produce an object. If parsing succeeds, then the index of thecursor
argument is updated to the index after the last character used.- Parameters:
csq
- theCharSequence
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).javax.measure.format.ParserException
-
format
-
parseObject
- Specified by:
parseObject
in classFormat
-
format
Convenience method equivalent toinvalid reference
#format(AbstractQuantity, Appendable)
- Parameters:
quantity
- the quantity to format.dest
- the appendable destination.- Returns:
- the specified
StringBuilder
.
-