Module org.tquadrat.foundation.value

Package org.tquadrat.foundation.value.api

Class DimensionedValueStringConverter<D extends Dimension,V extends DimensionedValue<D>>

java.lang.Object

org.tquadrat.foundation.value.api.DimensionedValueStringConverter<D,V>

Type Parameters:

D - The type for the dimension.

V - The type for the dimensioned value.

All Implemented Interfaces:

Serializable, StringConverter<V>

Direct Known Subclasses:

AreaValueStringConverter, DataSizeValueStringConverter, EnergyValueStringConverter, ForceValueStringConverter, LengthValueStringConverter, MassValueStringConverter, PowerValueStringConverter, PressureValueStringConverter, SpeedValueStringConverter, TemperatureValueStringConverter, TimeValueStringConverter, VolumeValueStringConverter

@ClassVersion(sourceVersion="$Id: DimensionedValueStringConverter.java 1105 2024-02-28 12:58:46Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public abstract class DimensionedValueStringConverter<D extends Dimension,V extends DimensionedValue<D>>
extends Object
implements StringConverter<V>

The abstract base class for implementations of StringConverter for dimensioned values.

The String representations for all dimensioned values have the same format: a numeric part followed by the unit for the dimension, separated by whitespace (one or more blanks). For example: 15 m or 16.0 t.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: DimensionedValueStringConverter.java 1105 2024-02-28 12:58:46Z tquadrat $

Since:

0.1.0

See Also:

• Serialized Form

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.value.api.DimensionedValueStringConverter"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final Class<V>	m_SubjectClass	The subject class for this converter.
static final String	MSG_InvalidValue	The error message for an invalid value "\'%s\' cannot be parsed as a dimensioned value".

Fields inherited from interface org.tquadrat.foundation.lang.StringConverter

METHOD_NAME_GetSubjectClass, METHOD_NAME_Provider

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DimensionedValueStringConverter(Class<V> subjectClass)	Creates a new instance of DimensionedValueStringConverter.

Method Summary

Modifier and Type	Method	Description
protected abstract V	createValue(BigDecimal number, D dimension)	Creates an instance of DimensionedValue from the given arguments.
final V	fromString(CharSequence source)
final Collection<Class<V>>	getSubjectClass()	Provides the subject class for this converter.
String	toString(V source)
String	toString(V source, int width, int precision)	Returns a String representation of given value. The precision is applied to the numerical part only.
protected abstract D	unitFromSymbol(String symbol)	Determines the unit instance from the given unit symbol.

Methods inherited from class java.lang.Object

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

Field Details

MSG_InvalidValue

public static final String MSG_InvalidValue

The error message for an invalid value "\'%s\' cannot be parsed as a dimensioned value".

See Also:

• Constant Field Values

m_SubjectClass

private final Class<V extends DimensionedValue<D>> m_SubjectClass

The subject class for this converter.

Constructor Details

DimensionedValueStringConverter

protected DimensionedValueStringConverter(Class<V> subjectClass)

Creates a new instance of DimensionedValueStringConverter.

Parameters:

subjectClass - The subject class.

Method Details

createValue

protected abstract V createValue(BigDecimal number,
 D dimension)

Creates an instance of DimensionedValue from the given arguments.

Parameters:

number - The value.

dimension - The dimension.

Returns:

The dimensioned value.

fromString

public final V fromString(CharSequence source)
                   throws IllegalArgumentException

Specified by:

fromString in interface StringConverter<D extends Dimension>

Throws:

IllegalArgumentException

getSubjectClass

public final Collection<Class<V>> getSubjectClass()

Provides the subject class for this converter.

Returns:

The subject class.

toString

public String toString(V source)

Specified by:

toString in interface StringConverter<D extends Dimension>

toString

public String toString(V source,
 int width,
 int precision)

Returns a String representation of given value.

The precision is applied to the numerical part only. The width includes the unit symbol, too.

Parameters:

source - The object to convert; can be null.

width - The minimum number of characters to be written to the output. If the length of the converted value is less than the width then the output will be padded by ' ' until the total number of characters equals width. The padding is at the beginning, as numerical values are usually right justified. If width is -1 then there is no minimum.

precision - – The number of digits for the mantissa of the value. If precision is -1 then there is no explicit limit on the size of the mantissa.

Returns:

The String representation for this value.

unitFromSymbol

protected abstract D unitFromSymbol(String symbol)
                             throws IllegalArgumentException

Determines the unit instance from the given unit symbol.

Parameters:

symbol - The unit symbol.

Returns:

The unit instance.

Throws:

IllegalArgumentException - The given unit symbol is unknown for the respective dimension.