Module org.tquadrat.foundation.value

Package org.tquadrat.foundation.value.api

Class ValueBase<D extends Dimension,I extends DimensionedValue<D>>

java.lang.Object

org.tquadrat.foundation.value.api.ValueBase<D,I>

Type Parameters:

D - The dimension.

I - The implementing type.

All Implemented Interfaces:

Serializable, Cloneable, Comparable<DimensionedValue<D>>, Formattable, DimensionedValue<D>

Direct Known Subclasses:

AreaValue, DataSizeValue, EnergyValue, ForceValue, LengthValue, MassValue, PowerValue, PressureValue, SpeedValue, TemperatureValue, TimeValue, VolumeValue

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

An abstract base implementation for the interface DimensionedValue that is intended as the base for concrete implementations of value types.

The validator argument of the constructors is an instance of BiPredicate that takes the unit with that the instance is initialised, and the value, converted to the base unit. It returns true if the given combination is valid, otherwise it returns false.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.0.4

See Also:

• Serialized Form

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
protected static final BiPredicate	DEFAULT_VALIDATOR	The default validator.
private D	m_Unit	The unit for the value.
private final BiPredicate<D,BigDecimal>	m_Validator	The validation function.
private final BigDecimal	m_Value	The numerical value for this instance.
private static final long	serialVersionUID	The serial version UID for objects of this class: -2075489505691464486L.

Fields inherited from interface org.tquadrat.foundation.value.api.DimensionedValue

MATH_CONTEXT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ValueBase(D unit, String value, BiPredicate<D,BigDecimal> validator)	Creates a new ValueBase instance.
protected	ValueBase(D unit, BigDecimal value, BiPredicate<D,BigDecimal> validator)	Creates a new ValueBase instance.
protected	ValueBase(D unit, N value, BiPredicate<D,BigDecimal> validator)	Creates a new ValueBase instance.

Method Summary

Modifier and Type	Method	Description
final BigDecimal	baseValue()	Returns the base value (this value, converted to the base unit).
I	clone()	Creates a new copy of this value.
final I	copy()	Creates a new copy of this value.
final I	copy(D unit)	Creates a new copy of this value.
final boolean	equals(Object obj)
final D	getUnit()	Returns the unit for the value.
final int	hashCode()
final void	setUnit(D dimension)	Applies another unit for the value.
final String	toString()	Returns the String representation for this value
private final BigDecimal	validate(BigDecimal value)	Validates the given value, based on the type of the dimension.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.tquadrat.foundation.value.api.DimensionedValue

baseUnit, compareTo, convert, divide, divide, divide, formatTo, multiply, multiply, multiply, newInstance, sum, sum, toString, toString, toString, toString, value

Field Details

DEFAULT_VALIDATOR

protected static final BiPredicate DEFAULT_VALIDATOR

The default validator.

m_Unit

private D extends Dimension m_Unit

The unit for the value.

m_Validator

private final BiPredicate<D extends Dimension,BigDecimal> m_Validator

The validation function.

m_Value

private final BigDecimal m_Value

The numerical value for this instance.

serialVersionUID

private static final long serialVersionUID

The serial version UID for objects of this class: -2075489505691464486L.

See Also:

• Constant Field Values

Constructor Details

ValueBase

protected ValueBase(D unit,
 BigDecimal value,
 BiPredicate<D,BigDecimal> validator)

Creates a new ValueBase instance.

Parameters:

unit - The unit.

value - The value; only absolute (positive) values are allowed, a sign will be stripped.

validator - The validator function; can be null.

ValueBase

protected ValueBase(D unit,
 String value,
 BiPredicate<D,BigDecimal> validator)
             throws NumberFormatException

Creates a new ValueBase instance.

Parameters:

unit - The unit.

value - The value; it must be possible to parse the given String into a BigDecimal.

validator - The validator function.

Throws:

NumberFormatException - The provided value cannot be converted into a BigDecimal.

ValueBase

protected ValueBase(D unit,
 N value,
 BiPredicate<D,BigDecimal> validator)

Creates a new ValueBase instance.

Type Parameters:

N - The type of value.

Parameters:

unit - The unit.

value - The value.

validator - The validator function.

Method Details

baseValue

public final BigDecimal baseValue()

Returns the base value (this value, converted to the base unit).

According to the result, this is the same as calling

convert( baseUnit() );

.

Specified by:

baseValue in interface DimensionedValue<D extends Dimension>

Returns:

The numerical value as for the base unit.

See Also:

• DimensionedValue.convert(Dimension)

clone

public I clone()

Creates a new copy of this value.

Specified by:

clone in interface DimensionedValue<D extends Dimension>

Overrides:

clone in class Object

Returns:

The copy.

copy

public final I copy()

Creates a new copy of this value.

Specified by:

copy in interface DimensionedValue<D extends Dimension>

Returns:

The copy.

See Also:

• Object.clone()

copy

public final I copy(D unit)

Creates a new copy of this value.

Specified by:

copy in interface DimensionedValue<D extends Dimension>

Parameters:

unit - The unit for the new copy.

Returns:

The copy.

See Also:

• Object.clone()

equals

public final boolean equals(Object obj)

Two instances of a class implementing this interface are equals if they are of the same class and if their values, converted to the base dimension, are equals.

Specified by:

equals in interface DimensionedValue<D extends Dimension>

Overrides:

equals in class Object

Parameters:

obj - The other value.

Returns:

true if they are equal, false if not.

See Also:

• Dimension.baseUnit()

getUnit

public final D getUnit()

Returns the unit for the value.

Specified by:

getUnit in interface DimensionedValue<D extends Dimension>

Returns:

The unit.

hashCode

public final int hashCode()

The hash code is based on the base value and base unit only.

Specified by:

hashCode in interface DimensionedValue<D extends Dimension>

Overrides:

hashCode in class Object

setUnit

public final void setUnit(D dimension)

Applies another unit for the value. This does not affect the results of DimensionedValue.equals(Object), DimensionedValue.hashCode()} and DimensionedValue.compareTo(DimensionedValue), nor that of DimensionedValue.baseValue().

Specified by:

setUnit in interface DimensionedValue<D extends Dimension>

Parameters:

dimension - The new unit.

toString

public final String toString()

Returns the String representation for this value; usually, this is in the format

<numerical value> <unit symbol>

like "4.5 m".

The precision for the mantissa is provided by the unit.

If more control over the output format is required, see DimensionedValue.toString(int, int).

Specified by:

toString in interface DimensionedValue<D extends Dimension>

Overrides:

toString in class Object

validate

private final BigDecimal validate(BigDecimal value)
                           throws IllegalArgumentException

Validates the given value, based on the type of the dimension.

This method will be called by the constructors always with the base unit value just before the value will be initialised.

Parameters:

value - The value in base units.

Returns:

The value.

Throws:

IllegalArgumentException - The validation failed.