Package org.djunits.quantity

Class Area

java.lang.Object

java.lang.Number

org.djunits.quantity.def.Quantity<Area,Area.Unit>

org.djunits.quantity.Area

All Implemented Interfaces:

Serializable, Comparable<Area>, Additive<Area>, Scalable<Area>, Value<Area.Unit,Area>

public class Area
extends Quantity<Area,Area.Unit>

Area is a measure of a two-dimensional surface, expressed in square meters (m2).

Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://djunits.org. The DJUNITS project is distributed under a three-clause BSD-style license.

Author:

Alexander Verbraeck

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Area.Unit	Area.Unit encodes the area unit (length x length).

Field Summary

Fields

Modifier and Type	Field	Description
static final Area	NaN	Constant with value NaN.
static final Area	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static final Area	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static final Area	ONE	Constant with value one.
static final Area	POS_MAXVALUE	Constant with value MAX_VALUE.
static final Area	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static final Area	ZERO	Constant with value zero.

Constructor Summary

Constructors

Constructor	Description
Area(double value, String abbreviation)	Instantiate a Area quantity with a unit, expressed as a String.
Area(double value, Area.Unit unit)	Instantiate a Area quantity with a unit.
Area(Area value)	Construct Area quantity.

Method Summary

Modifier and Type	Method	Description
final Dimensionless	divide(Area v)	Calculate the division of Area and Area, which results in a Dimensionless scalar.
final Length	divide(Length v)	Calculate the division of Area and Length, which results in a Length scalar.
final Volume	divide(LinearObjectDensity v)	Calculate the division of Area and LinearObjectDensity, which results in a Volume scalar.
final LinearObjectDensity	divide(Volume v)	Calculate the division of Area and Volume, which results in a LinearObjectDensity scalar.
Area	instantiate(double si)	Instantiate a quantity with an SI or base value.
final Dimensionless	multiply(ArealObjectDensity v)	Calculate the multiplication of Area and ArealObjectDensity, which results in a Dimensionless scalar.
final LuminousFlux	multiply(Illuminance v)	Calculate the multiplication of Area and Illuminance, which results in a LuminousFlux scalar.
final Volume	multiply(Length v)	Calculate the multiplication of Area and Length, which results in a Volume scalar.
final Length	multiply(LinearObjectDensity v)	Calculate the multiplication of Area and LinearObjectDensity, which results in a Length scalar.
final Force	multiply(Pressure v)	Calculate the multiplication of Area and Pressure, which results in a Force scalar.
final FlowVolume	multiply(Speed v)	Calculate the multiplication of Area and Speed, which results in a FlowVolume scalar.
static Area	of(double value, String unitString)	Returns a Area based on a value and the textual representation of the unit, which can be localized.
static Area	ofSi(double si)	Return a Area instance based on an SI value.
ArealObjectDensity	reciprocal()	Return the reciprocal of this quantity (1/q).
SIUnit	siUnit()	Return the SI unit of this quantity.
static Area	valueOf(String text)	Returns a Area representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.quantity.def.Quantity

abs, add, as, compareTo, divide, doubleValue, eq, eq0, equals, floatValue, format, format, ge, ge0, getDisplayUnit, getInUnit, getInUnit, getName, gt, gt0, hashCode, instantiate, interpolate, intValue, isRelative, le, le0, longValue, lt, lt0, max, mean, min, multiply, ne, ne0, negate, of, product, scaleBy, setDisplayUnit, si, subtract, sum, toDisplayString, toDisplayString, toString, toString, toString, toString, toStringSIPrefixed, toStringSIPrefixed, toTextualString, toTextualString, valueOf

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.djunits.value.Scalable

divideBy

Methods inherited from interface org.djunits.value.Value

isAbsolute, setDisplayUnit

Field Details

ZERO

public static final Area ZERO

Constant with value zero.

ONE

public static final Area ONE

Constant with value one.

NaN

public static final Area NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final Area POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final Area NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final Area POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final Area NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

Area

public Area(double value,
 Area.Unit unit)

Instantiate a Area quantity with a unit.

Parameters:

value - the value, expressed in the unit

unit - the unit in which the value is expressed

Area

public Area(double value,
 String abbreviation)

Instantiate a Area quantity with a unit, expressed as a String.

Parameters:

value - the value, expressed in the unit

abbreviation - the String abbreviation of the unit in which the value is expressed

Area

public Area(Area value)

Construct Area quantity.

Parameters:

value - Scalar from which to construct this instance

Method Details

ofSi

public static Area ofSi(double si)

Return a Area instance based on an SI value.

Parameters:

si - the si value

Returns:

the Area instance based on an SI value

instantiate

public Area instantiate(double si)

Description copied from class: Quantity

Instantiate a quantity with an SI or base value.

Specified by:

instantiate in class Quantity<Area,Area.Unit>

Parameters:

si - the value expressed in the base (SI) unit

Returns:

a quantity with the given SI-value and base (SI) unit

siUnit

public SIUnit siUnit()

Description copied from class: Quantity

Return the SI unit of this quantity.

Overrides:

siUnit in class Quantity<Area,Area.Unit>

Returns:

the SI unit of this quantity

valueOf

public static Area valueOf(String text)

Returns a Area representation of a textual representation of a value with a unit. The String representation that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces are allowed, but not required, between the value and the unit.

Parameters:

text - the textual representation to parse into a Area

Returns:

the Scalar representation of the value in its unit

Throws:

IllegalArgumentException - when the text cannot be parsed

NullPointerException - when the text argument is null

of

public static Area of(double value,
 String unitString)

Returns a Area based on a value and the textual representation of the unit, which can be localized.

Parameters:

value - the value to use

unitString - the textual representation of the unit

Returns:

the Scalar representation of the value in its unit

Throws:

IllegalArgumentException - when the unit cannot be parsed or is incorrect

NullPointerException - when the unitString argument is null

divide

public final Dimensionless divide(Area v)

Calculate the division of Area and Area, which results in a Dimensionless scalar.

Parameters:

v - scalar

Returns:

scalar as a division of Area and Area

multiply

public final Dimensionless multiply(ArealObjectDensity v)

Calculate the multiplication of Area and ArealObjectDensity, which results in a Dimensionless scalar.

Parameters:

v - scalar

Returns:

scalar as a multiplication of Area and ArealObjectDensity

multiply

public final Volume multiply(Length v)

Calculate the multiplication of Area and Length, which results in a Volume scalar.

Parameters:

v - scalar

Returns:

scalar as a multiplication of Area and Length

divide

public final Volume divide(LinearObjectDensity v)

Calculate the division of Area and LinearObjectDensity, which results in a Volume scalar.

Parameters:

v - scalar

Returns:

scalar as a division of Area and LinearObjectDensity

divide

public final LinearObjectDensity divide(Volume v)

Calculate the division of Area and Volume, which results in a LinearObjectDensity scalar.

Parameters:

v - scalar

Returns:

scalar as a division of Area and Volume

divide

public final Length divide(Length v)

Calculate the division of Area and Length, which results in a Length scalar.

Parameters:

v - scalar

Returns:

scalar as a division of Area and Length

multiply

public final Length multiply(LinearObjectDensity v)

Calculate the multiplication of Area and LinearObjectDensity, which results in a Length scalar.

Parameters:

v - scalar

Returns:

scalar as a multiplication of Area and LinearObjectDensity

multiply

public final FlowVolume multiply(Speed v)

Calculate the multiplication of Area and Speed, which results in a FlowVolume scalar.

Parameters:

v - scalar

Returns:

scalar as a multiplication of Area and Speed

multiply

public final Force multiply(Pressure v)

Calculate the multiplication of Area and Pressure, which results in a Force scalar.

Parameters:

v - scalar

Returns:

scalar as a multiplication of Area and Pressure

multiply

public final LuminousFlux multiply(Illuminance v)

Calculate the multiplication of Area and Illuminance, which results in a LuminousFlux scalar.

Parameters:

v - scalar

Returns:

scalar as a multiplication of Area and Illuminance

reciprocal

public ArealObjectDensity reciprocal()

Description copied from class: Quantity

Return the reciprocal of this quantity (1/q).

Overrides:

reciprocal in class Quantity<Area,Area.Unit>

Returns:

the reciprocal of this quantity, with the correct SI units