Module org.tquadrat.foundation.value

Package org.tquadrat.foundation.value

Class AreaValue

java.lang.Object

org.tquadrat.foundation.value.api.ValueBase<Area,AreaValue>

org.tquadrat.foundation.value.AreaValue

All Implemented Interfaces:

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

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

A value class for areas.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: AreaValue.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.AreaValue"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private static final BiPredicate<Area,BigDecimal>	AREA_VALIDATOR	The validator for areas.

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

Method Summary

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

AREA_VALIDATOR

private static final BiPredicate<Area,BigDecimal> AREA_VALIDATOR

The validator for areas.

An area may not be less than 0.

Constructor Details

AreaValue

public AreaValue(Area dimension,
 BigDecimal value)

Creates a new AreaValue instance.

Parameters:

dimension - The dimension.

value - The value.

AreaValue

public AreaValue(Area dimension,
 String value)
          throws NumberFormatException

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

AreaValue

public AreaValue(Area dimension,
 N value)

Creates a new AreaValue instance.

Type Parameters:

N - The type of value.

Parameters:

dimension - The dimension.

value - The value.

AreaValue

public AreaValue(Area dimension,
 LengthValue length,
 LengthValue width)

Creates a new AreaValue instance. An area can be determined by multiplication of length and width.

Parameters:

dimension - The dimension.

length - The length.

width - The width.

Method Details

clone

public final AreaValue clone()

Creates a new copy of this value.

Specified by:

clone in interface DimensionedValue<Area>

Overrides:

clone in class ValueBase<Area,AreaValue>

Returns:

The copy.