Module org.tquadrat.foundation.value

Package org.tquadrat.foundation.value

Class TemperatureValue

java.lang.Object

org.tquadrat.foundation.value.api.ValueBase<Temperature,TemperatureValue>

org.tquadrat.foundation.value.TemperatureValue

All Implemented Interfaces:

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

@ClassVersion(sourceVersion="$Id: TemperatureValue.java 1072 2023-09-30 20:44:38Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public final class TemperatureValue
extends ValueBase<Temperature,TemperatureValue>

A value class for temperatures.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: TemperatureValue.java 1072 2023-09-30 20:44:38Z tquadrat $

Since:

0.1.0

See Also:

• Serialized Form

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.value.TemperatureValue"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private static final BiPredicate<Temperature,BigDecimal>	TEMPERATURE_VALIDATOR	The validator for temperatures.

Fields inherited from class org.tquadrat.foundation.value.api.ValueBase

DEFAULT_VALIDATOR

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

MATH_CONTEXT

Constructor Summary

Constructors

Constructor	Description
TemperatureValue(Temperature dimension, String value)	Creates a new TemperatureValue instance.
TemperatureValue(Temperature dimension, BigDecimal value)	Creates a new TemperatureValue instance.
TemperatureValue(Temperature dimension, N value)	Creates a new LengthValue instance.

Method Summary

Modifier and Type	Method	Description
final TemperatureValue	clone()	Creates a new copy of this value.

Methods inherited from class org.tquadrat.foundation.value.api.ValueBase

baseValue, copy, copy, equals, getUnit, hashCode, setUnit, toString

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

TEMPERATURE_VALIDATOR

private static final BiPredicate<Temperature,BigDecimal> TEMPERATURE_VALIDATOR

The validator for temperatures.

A temperature in Kelvin may not be less than 0.

Constructor Details

TemperatureValue

public TemperatureValue(Temperature dimension,
 BigDecimal value)

Creates a new TemperatureValue instance.

Parameters:

dimension - The dimension.

value - The value.

TemperatureValue

public TemperatureValue(Temperature dimension,
 String value)
                 throws NumberFormatException

Creates a new TemperatureValue instance.

Parameters:

dimension - The dimension.

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

Throws:

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

TemperatureValue

public TemperatureValue(Temperature dimension,
 N value)

Creates a new LengthValue instance.

Type Parameters:

N - The type of value.

Parameters:

dimension - The dimension.

value - The value.

Method Details

clone

public final TemperatureValue clone()

Creates a new copy of this value.

Specified by:

clone in interface DimensionedValue<Temperature>

Overrides:

clone in class ValueBase<Temperature,TemperatureValue>

Returns:

The copy.