Package com.storedobject.core

Class Volume

java.lang.Object

com.storedobject.core.Quantity

com.storedobject.core.Volume

All Implemented Interfaces:

Storable, Comparable<Quantity>

public class Volume
extends Quantity

Field Summary

Fields

Modifier and Type	Field	Description
static final MeasurementUnit	defaultUnit

Fields inherited from class com.storedobject.core.Quantity

PI, PRECISION

Constructor Summary

Constructors

Constructor	Description
Volume()
Volume(double value, MeasurementUnit unit)
Volume(double value, String unit)
Volume(BigDecimal value, MeasurementUnit unit)
Volume(BigDecimal value, String unit)

Method Summary

Modifier and Type	Method	Description
Volume	absolute()	Absolute value of this quantity.
Volume	add(Quantity quantity)	Add quantity
Volume	add(String quantity)	Add quantity value
Volume	add(BigDecimal quantity)	Add quantity
static Volume	box(Distance length, Distance width, Distance height)	Box.
static Volume	cone(Distance radius, Distance height)	Cone.
static Volume	cube(Distance side)	Cube.
Volume	divide(double divisor)	Divide the quantity with a value
Volume	divide(BigDecimal divisor)	Divide the quantity with a value
Weight	getWeight()	Get the volumetric weight of this volume.
Volume	multiply(double multiplicand)	Multiply
Volume	multiply(BigDecimal multiplicand)	Multiply
Volume	negate()	Reverses the sign of this quantity
static Volume	prism(Area base, Distance height)	Prism.
Volume	subtract(Quantity quantity)	Subtract quantity
Volume	subtract(String quantity)	Subtract quantity
Volume	subtract(BigDecimal quantity)	Subtract quantity
Volume	zero()	Create a quantity of this type with zero value.

Methods inherited from class com.storedobject.core.Quantity

canConvert, canConvert, canConvert, canConvert, compareTo, convert, convert, convert, convert, convertValue, create, create, create, create, create, create, create, create, create, create, create, create, divide, equals, equalsWhenZero, getClass, getStorableValue, getType, getTypeName, getUnit, getUnit, getUnit, getValue, hashCode, isCompatible, isConvertible, isConvertible, isGreaterThan, isGreaterThan, isGreaterThanOrEqual, isGreaterThanOrEqual, isLessThan, isLessThan, isLessThanOrEqual, isLessThanOrEqual, isNegative, isPositive, isZero, multiply, quantityTypes, round, setUnit, setUnit, sum, toString, toString, toString, toString, types

Methods inherited from class java.lang.Object

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

Field Details

defaultUnit

public static final MeasurementUnit defaultUnit

Constructor Details

Volume

public Volume()

Volume

public Volume(double value,
 String unit)

Volume

public Volume(double value,
 MeasurementUnit unit)

Volume

public Volume(BigDecimal value,
 String unit)

Volume

public Volume(BigDecimal value,
 MeasurementUnit unit)

Method Details

box

public static Volume box(Distance length,
 Distance width,
 Distance height)

Box.

Parameters:

length - Length.

width - Width.

height - Height.

Returns:

Box volume.

cube

public static Volume cube(Distance side)

Cube.

Parameters:

side - Side of the cube.

Returns:

Cubic volume.

prism

public static Volume prism(Area base,
 Distance height)

Prism.

Parameters:

base - Base area of the prism.

height - Height of the prism.

Returns:

Prism volume.

cone

public static Volume cone(Distance radius,
 Distance height)

Cone.

Parameters:

radius - Radius of the base area of the cone.

height - Height of the cone.

Returns:

Cone volume.

getWeight

public Weight getWeight()

Get the volumetric weight of this volume. By default, volumetric weight factor of 4000 is used unless a GlobalProperty with the name "VOLUMETRIC-WEIGHT-FACTOR" is defined.

Returns:

Volumetric weight.

zero

public Volume zero()

Create a quantity of this type with zero value.

Overrides:

zero in class Quantity

Returns:

Result

add

public Volume add(String quantity)

Add quantity value

Overrides:

add in class Quantity

Parameters:

quantity - The quantity value to add

Returns:

Result

add

public Volume add(BigDecimal quantity)

Add quantity

Overrides:

add in class Quantity

Parameters:

quantity - The quantity value to add

Returns:

Result

add

public Volume add(Quantity quantity)

Add quantity

Overrides:

add in class Quantity

Parameters:

quantity - The quantity value to add

Returns:

Result

subtract

public Volume subtract(String quantity)

Subtract quantity

Overrides:

subtract in class Quantity

Parameters:

quantity - The quantity value to subtract

Returns:

Result

subtract

public Volume subtract(BigDecimal quantity)

Subtract quantity

Overrides:

subtract in class Quantity

Parameters:

quantity - The quantity value to subtract

Returns:

Result

subtract

public Volume subtract(Quantity quantity)

Subtract quantity

Overrides:

subtract in class Quantity

Parameters:

quantity - The quantity value to subtract

Returns:

Result

multiply

public Volume multiply(BigDecimal multiplicand)

Multiply

Overrides:

multiply in class Quantity

Parameters:

multiplicand - Multiplicand

Returns:

Result

multiply

public Volume multiply(double multiplicand)

Multiply

Overrides:

multiply in class Quantity

Parameters:

multiplicand - Multiplicand

Returns:

Result

divide

public Volume divide(double divisor)

Divide the quantity with a value

Overrides:

divide in class Quantity

Parameters:

divisor - Divisor

Returns:

Result

divide

public Volume divide(BigDecimal divisor)

Divide the quantity with a value

Overrides:

divide in class Quantity

Parameters:

divisor - Divisor

Returns:

Result

negate

public Volume negate()

Reverses the sign of this quantity

Overrides:

negate in class Quantity

Returns:

Negated value

absolute

public Volume absolute()

Absolute value of this quantity.

Overrides:

absolute in class Quantity

Returns:

Absolute value