Module org.tquadrat.foundation.value

Package org.tquadrat.foundation.value

Class VolumeValue

java.lang.Object

org.tquadrat.foundation.value.api.ValueBase<Volume,VolumeValue>

org.tquadrat.foundation.value.VolumeValue

All Implemented Interfaces:

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

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

A value class for volumes.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.1.0

See Also:

• Serialized Form

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private static final BiPredicate<Volume,BigDecimal>	VOLUME_VALIDATOR	The validator for volumes.

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
VolumeValue(Volume dimension, String value)	Creates a new VolumeValue instance.
VolumeValue(Volume dimension, BigDecimal value)	Creates a new VolumeValue instance.
VolumeValue(Volume dimension, N value)	Creates a new VolumeValue instance.
VolumeValue(Volume dimension, AreaValue area, LengthValue height)	Creates a new VolumeValue instance.
VolumeValue(Volume dimension, LengthValue length, LengthValue width, LengthValue height)	Creates a new VolumeValue instance.

Method Summary

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

VOLUME_VALIDATOR

private static final BiPredicate<Volume,BigDecimal> VOLUME_VALIDATOR

The validator for volumes.

A volume may not be less than 0.

Constructor Details

VolumeValue

public VolumeValue(Volume dimension,
 BigDecimal value)

Creates a new VolumeValue instance.

Parameters:

dimension - The dimension.

value - The value.

VolumeValue

public VolumeValue(Volume dimension,
 String value)
            throws NumberFormatException

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

VolumeValue

public VolumeValue(Volume dimension,
 N value)

Creates a new VolumeValue instance.

Type Parameters:

N - The type of value.

Parameters:

dimension - The dimension.

value - The value.

VolumeValue

public VolumeValue(Volume dimension,
 LengthValue length,
 LengthValue width,
 LengthValue height)

Creates a new VolumeValue instance.

A volume can be determined by multiplication of length, width and height.

Parameters:

dimension - The dimension.

length - The length.

width - The width.

height - The height.

VolumeValue

public VolumeValue(Volume dimension,
 AreaValue area,
 LengthValue height)

Creates a new VolumeValue instance.

A volume can be determined by multiplication of ground area and height.

Parameters:

dimension - The dimension.

area - The ground area.

height - The height.

Method Details

clone

public final VolumeValue clone()

Creates a new copy of this value.

Specified by:

clone in interface DimensionedValue<Volume>

Overrides:

clone in class ValueBase<Volume,VolumeValue>

Returns:

The copy.