Module org.tquadrat.foundation.value

Package org.tquadrat.foundation.value

Class EnergyValue

java.lang.Object

org.tquadrat.foundation.value.api.ValueBase<Energy,EnergyValue>

org.tquadrat.foundation.value.EnergyValue

All Implemented Interfaces:

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

@ClassVersion(sourceVersion="$Id: EnergyValue.java 1073 2023-10-01 11:08:51Z tquadrat $")
@API(status=STABLE,
     since="0.3.0")
public final class EnergyValue
extends ValueBase<Energy,EnergyValue>

A value class for energy values.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: EnergyValue.java 1073 2023-10-01 11:08:51Z tquadrat $

Since:

0.3.0

See Also:

• Serialized Form

UML Diagram

⁠

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

⁠

Field Summary

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
EnergyValue(Energy dimension, String value)	Creates a new EnergyValue instance.
EnergyValue(Energy dimension, BigDecimal value)	Creates a new EnergyValue instance.
EnergyValue(Energy dimension, N value)	Creates a new EnergyValue instance.

Method Summary

Modifier and Type	Method	Description
final EnergyValue	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

Constructor Details

EnergyValue

public EnergyValue(Energy dimension,
 BigDecimal value)

Creates a new EnergyValue instance.

Parameters:

dimension - The dimension.

value - The value.

EnergyValue

public EnergyValue(Energy dimension,
 String value)
            throws NumberFormatException

Creates a new EnergyValue 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.

EnergyValue

public EnergyValue(Energy dimension,
 N value)

Creates a new EnergyValue instance.

Type Parameters:

N - The type of value.

Parameters:

dimension - The dimension.

value - The value.

Method Details

clone

public final EnergyValue clone()

Creates a new copy of this value.

Specified by:

clone in interface DimensionedValue<Energy>

Overrides:

clone in class ValueBase<Energy,EnergyValue>

Returns:

The copy.