Package com.storedobject.core

Class Quantity

java.lang.Object

com.storedobject.core.Quantity

All Implemented Interfaces:

Storable, Comparable<Quantity>

Direct Known Subclasses:

Angle, Area, Count, Distance, FractionalCount, Percentage, Pressure, Speed, Temperature, TimeDuration, Volume, VolumeRate, Weight, WeightOrVolume, WeightRate

public class Quantity
extends Object
implements Storable, Comparable<Quantity>

Class that represents a quantity. This class and its descendants are immutable.

Author:

Syam

Field Summary

Fields

Modifier and Type	Field	Description
static MeasurementUnit	defaultUnit
static final BigDecimal	PI
static final MathContext	PRECISION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Quantity(BigDecimal value, MeasurementUnit unit)	Create a quantity from the quantity specified in a particular unit.

Method Summary

Modifier and Type	Method	Description
Quantity	absolute()	Absolute value of this quantity.
Quantity	add(Quantity quantity)	Add quantity
Quantity	add(String quantity)	Add quantity value
Quantity	add(BigDecimal quantity)	Add quantity
boolean	canConvert(MeasurementUnit toUnit)
boolean	canConvert(MeasurementUnit toUnit, String message)
boolean	canConvert(Quantity another)
boolean	canConvert(Quantity another, String message)
int	compareTo(Quantity quantity)
Quantity	convert(MeasurementUnit u)	Convert the quantity to another unit.
Quantity	convert(MeasurementUnit u, int decimals)	Convert the quantity to another unit rounded to the given number of decimals.
<Q extends Quantity> Q	convert(Q quantity)	Convert the quantity to another unit.
<Q extends Quantity> Q	convert(Q quantity, int decimals)	Convert the quantity to another unit.
BigDecimal	convertValue(MeasurementUnit u)	Get the value of this quantity if converted to the given unit.
static Quantity	create(double quantity, MeasurementUnit unit)
static <Q extends Quantity> Q	create(double quantity, Class<Q> qClass)
static <Q extends Quantity> Q	create(double quantity, Class<Q> qClass, String unit)
static Quantity	create(MeasurementUnit unit)
static <Q extends Quantity> Q	create(Class<Q> qClass)
static <Q extends Quantity> Q	create(Class<Q> qClass, String unit)
static Quantity	create(Object value)	Construct a quantity from a string representation.
static <Q extends Quantity> Q	create(Object value, Class<Q> qClass)
static <Q extends Quantity> Q	create(String value, Class<Q> qClass, boolean returnNull)
static Quantity	create(BigDecimal quantity, MeasurementUnit unit)
static <Q extends Quantity> Q	create(BigDecimal quantity, Class<Q> qClass)
static <Q extends Quantity> Q	create(BigDecimal quantity, Class<Q> qClass, String unit)
Quantity	divide(double divisor)	Divide the quantity with a value
Money	divide(Money amount)	Divide the money with this quantity (To get the unit price)
Quantity	divide(BigDecimal divisor)	Divide the quantity with a value
final boolean	equals(Object another)
protected boolean	equalsWhenZero(Quantity another)	Check if this quantity is equal to another quantity when both are zero, but their units are different.
static Class<? extends Quantity>	getClass(MeasurementUnit unit)
String	getStorableValue()	Get the storable value.
static int	getType(Class<? extends Quantity> quantityClass)
String	getTypeName()
MeasurementUnit	getUnit()
static MeasurementUnit	getUnit(String unit)
static MeasurementUnit	getUnit(String unit, Class<? extends Quantity> quantityClass)
BigDecimal	getValue()	Get the quantity as BigDecimal.
int	hashCode()
boolean	isCompatible(Quantity another)
boolean	isConvertible(MeasurementUnit toUnit)
boolean	isConvertible(Quantity another)
boolean	isGreaterThan(long value)	Check if this is greater than 'value'.
boolean	isGreaterThan(Quantity another)	Check if this is greater than 'another'.
boolean	isGreaterThanOrEqual(long value)	Check if this is greater than or equal to 'value'.
boolean	isGreaterThanOrEqual(Quantity another)	Check if this is greater than or equal to 'another'.
boolean	isLessThan(long value)	Check if this is less than 'value'.
boolean	isLessThan(Quantity another)	Check if this is less than 'another'.
boolean	isLessThanOrEqual(long value)	Check if this is less than or equal to 'value'.
boolean	isLessThanOrEqual(Quantity another)	Check if this is less than or equal to 'another'.
boolean	isNegative()	Checks if this is a negative quantity or not.
boolean	isPositive()	Checks if this is a positive non-zero quantity or not.
boolean	isZero()	Checks if this is zero or not.
Quantity	multiply(double multiplicand)	Multiply
Money	multiply(Money amount)	Multiply the money with this quantity (Given the unit price, find out the total amount)
Quantity	multiply(BigDecimal multiplicand)	Multiply
Quantity	negate()	Reverses the sign of this quantity
static <Q extends Quantity> Stream<Class<Q>>	quantityTypes()
Quantity	round(int decimals)	Round the quantity to the specified number of decimals.
void	setUnit(MeasurementUnit unit)
void	setUnit(String unit)
Quantity	subtract(Quantity quantity)	Subtract quantity
Quantity	subtract(String quantity)	Subtract quantity
Quantity	subtract(BigDecimal quantity)	Subtract quantity
static Quantity	sum(Quantity... quantities)	Sum quantities.
String	toString()	Create the formatted representation of the quantity value with appropriate decimals places.
String	toString(boolean showSymbol)	Create the formatted representation of the quantity value with appropriate decimals places.
String	toString(boolean showSymbol, int decimals)	Create the formatted representation of the quantity value with appropriate decimals places.
String	toString(int decimals)	Create the formatted representation of the quantity value with appropriate decimals places.
static <Q extends Quantity> Stream<Class<Q>>	types()
Quantity	zero()	Create a quantity of this type with zero value.

Methods inherited from class java.lang.Object

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

Field Details

PRECISION

public static final MathContext PRECISION

PI

public static final BigDecimal PI

defaultUnit

public static MeasurementUnit defaultUnit

Constructor Details

Quantity

protected Quantity(BigDecimal value,
 MeasurementUnit unit)

Create a quantity from the quantity specified in a particular unit.

Parameters:

value - The BigDecimal value.

unit - MeasurementUnit

Method Details

create

public static Quantity create(Object value)

Construct a quantity from a string representation.

Parameters:

value - An object whose toString() representation provides (quantity, unit code). Example: (145.45,KG), (17.50,C).

Returns:

Quantity

create

public static <Q extends Quantity> Q create(Object value,
 Class<Q> qClass)

create

public static <Q extends Quantity> Q create(String value,
 Class<Q> qClass,
 boolean returnNull)

create

public static Quantity create(BigDecimal quantity,
 MeasurementUnit unit)

create

public static Quantity create(MeasurementUnit unit)

create

public static Quantity create(double quantity,
 MeasurementUnit unit)

create

public static <Q extends Quantity> Q create(Class<Q> qClass)

create

public static <Q extends Quantity> Q create(double quantity,
 Class<Q> qClass)

create

public static <Q extends Quantity> Q create(BigDecimal quantity,
 Class<Q> qClass)

create

public static <Q extends Quantity> Q create(Class<Q> qClass,
 String unit)

create

public static <Q extends Quantity> Q create(double quantity,
 Class<Q> qClass,
 String unit)

create

public static <Q extends Quantity> Q create(BigDecimal quantity,
 Class<Q> qClass,
 String unit)

getClass

public static Class<? extends Quantity> getClass(MeasurementUnit unit)

getValue

public BigDecimal getValue()

Get the quantity as BigDecimal.

Returns:

The value.

getUnit

public MeasurementUnit getUnit()

setUnit

public void setUnit(String unit)

setUnit

public void setUnit(MeasurementUnit unit)

getUnit

public static MeasurementUnit getUnit(String unit)

getUnit

public static MeasurementUnit getUnit(String unit,
 Class<? extends Quantity> quantityClass)

getTypeName

public String getTypeName()

getType

public static int getType(Class<? extends Quantity> quantityClass)

isCompatible

public boolean isCompatible(Quantity another)

isConvertible

public boolean isConvertible(Quantity another)

isConvertible

public boolean isConvertible(MeasurementUnit toUnit)

canConvert

public boolean canConvert(Quantity another)
                   throws Invalid_State

Throws:

Invalid_State

canConvert

public boolean canConvert(Quantity another,
 String message)
                   throws Invalid_State

Throws:

Invalid_State

canConvert

public boolean canConvert(MeasurementUnit toUnit)
                   throws Invalid_State

Throws:

Invalid_State

canConvert

public boolean canConvert(MeasurementUnit toUnit,
 String message)
                   throws Invalid_State

Throws:

Invalid_State

zero

public Quantity zero()

Create a quantity of this type with zero value.

Returns:

Result

add

public Quantity add(String quantity)

Add quantity value

Parameters:

quantity - The quantity value to add

Returns:

Result

add

public Quantity add(BigDecimal quantity)

Add quantity

Parameters:

quantity - The quantity value to add

Returns:

Result

add

public Quantity add(Quantity quantity)

Add quantity

Parameters:

quantity - The quantity value to add

Returns:

Result

sum

public static Quantity sum(Quantity... quantities)

Sum quantities. Quantities should be compatible. Null and zero values are ignored.

Parameters:

quantities - Quantities to sum together.

Returns:

Result.

subtract

public Quantity subtract(String quantity)

Subtract quantity

Parameters:

quantity - The quantity value to subtract

Returns:

Result

subtract

public Quantity subtract(BigDecimal quantity)

Subtract quantity

Parameters:

quantity - The quantity value to subtract

Returns:

Result

subtract

public Quantity subtract(Quantity quantity)

Subtract quantity

Parameters:

quantity - The quantity value to subtract

Returns:

Result

multiply

public Quantity multiply(BigDecimal multiplicand)

Multiply

Parameters:

multiplicand - Multiplicand

Returns:

Result

multiply

public Quantity multiply(double multiplicand)

Multiply

Parameters:

multiplicand - Multiplicand

Returns:

Result

multiply

public Money multiply(Money amount)

Multiply the money with this quantity (Given the unit price, find out the total amount)

Parameters:

amount - Amount

Returns:

Result

divide

public Quantity divide(double divisor)

Divide the quantity with a value

Parameters:

divisor - Divisor

Returns:

Result

divide

public Quantity divide(BigDecimal divisor)

Divide the quantity with a value

Parameters:

divisor - Divisor

Returns:

Result

divide

public Money divide(Money amount)

Divide the money with this quantity (To get the unit price)

Parameters:

amount - Amount

Returns:

Result

negate

public Quantity negate()

Reverses the sign of this quantity

Returns:

Negated value

absolute

public Quantity absolute()

Absolute value of this quantity.

Returns:

Absolute value

convert

public <Q extends Quantity> Q convert(Q quantity)

Convert the quantity to another unit.

Parameters:

quantity - Unit of this quantity to convert to.

Returns:

Converted quantity.

convert

public <Q extends Quantity> Q convert(Q quantity,
 int decimals)

Convert the quantity to another unit.

Parameters:

quantity - Unit of this quantity to convert to.

decimals - Number of decimals to be used in the final result (Negative numbers will be ignored).

Returns:

Converted quantity.

convert

public Quantity convert(MeasurementUnit u)

Convert the quantity to another unit.

Parameters:

u - Unit.

Returns:

Converted quantity.

convertValue

public BigDecimal convertValue(MeasurementUnit u)

Get the value of this quantity if converted to the given unit.

Parameters:

u - Unit.

Returns:

Value.

convert

public Quantity convert(MeasurementUnit u,
 int decimals)

Convert the quantity to another unit rounded to the given number of decimals.

Parameters:

u - Unit.

decimals - Number of decimals to be used in the final result (Negative numbers will be ignored).

Returns:

Converted quantity.

round

public Quantity round(int decimals)

Round the quantity to the specified number of decimals.

Parameters:

decimals - Number of decimals (Negative numbers will be ignored).

Returns:

Converted quantity.

equals

public final boolean equals(Object another)

Overrides:

equals in class Object

equalsWhenZero

protected boolean equalsWhenZero(Quantity another)

Check if this quantity is equal to another quantity when both are zero, but their units are different.

Note: Some measurements such as Temperature are not equal when units are different.

Parameters:

another - Another quantity.

Returns:

True if equal.

isGreaterThan

public boolean isGreaterThan(Quantity another)

Check if this is greater than 'another'.

Parameters:

another - Value to compare.

Returns:

True if this is greater.

isGreaterThan

public boolean isGreaterThan(long value)

Check if this is greater than 'value'.

Parameters:

value - Value to compare.

Returns:

True if this is greater.

isLessThan

public boolean isLessThan(Quantity another)

Check if this is less than 'another'.

Parameters:

another - Value to compare.

Returns:

True if this is less.

isLessThan

public boolean isLessThan(long value)

Check if this is less than 'value'.

Parameters:

value - Value to compare.

Returns:

True if this is less.

isGreaterThanOrEqual

public boolean isGreaterThanOrEqual(Quantity another)

Check if this is greater than or equal to 'another'.

Parameters:

another - Value to compare.

Returns:

True if this is greater than or equal.

isGreaterThanOrEqual

public boolean isGreaterThanOrEqual(long value)

Check if this is greater than or equal to 'value'.

Parameters:

value - Value to compare.

Returns:

True if this is greater or equal.

isLessThanOrEqual

public boolean isLessThanOrEqual(Quantity another)

Check if this is less than or equal to 'another'.

Parameters:

another - Value to compare.

Returns:

True if this is less than or equal.

isLessThanOrEqual

public boolean isLessThanOrEqual(long value)

Check if this is less than or equal to 'value'.

Parameters:

value - Value to compare.

Returns:

True if this is less than or equal.

isZero

public boolean isZero()

Checks if this is zero or not.

Returns:

True if zero.

isPositive

public boolean isPositive()

Checks if this is a positive non-zero quantity or not.

Returns:

True if non-zero and positive.

isNegative

public boolean isNegative()

Checks if this is a negative quantity or not.

Returns:

True if negative.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Create the formatted representation of the quantity value with appropriate decimals places.

Overrides:

toString in class Object

Returns:

The formatted string representation of the quantity.

toString

public String toString(int decimals)

Create the formatted representation of the quantity value with appropriate decimals places.

Parameters:

decimals - Number of decimals.

Returns:

The formatted string representation of the quantity.

toString

public String toString(boolean showSymbol)

Create the formatted representation of the quantity value with appropriate decimals places.

Parameters:

showSymbol - Determines whether unit symbol should be included or not.

Returns:

The formatted string representation of the quantity.

toString

public String toString(boolean showSymbol,
 int decimals)

Create the formatted representation of the quantity value with appropriate decimals places.

Parameters:

showSymbol - Determines whether unit symbol should be included or not.

decimals - Number of decimals.

Returns:

The formatted string representation of the quantity.

getStorableValue

public String getStorableValue()

Description copied from interface: Storable

Get the storable value. By default, Object.toString() is returned.

Specified by:

getStorableValue in interface Storable

Returns:

Storable value as a string.

compareTo

public int compareTo(Quantity quantity)

Specified by:

compareTo in interface Comparable<Quantity>

types

public static <Q extends Quantity> Stream<Class<Q>> types()

quantityTypes

public static <Q extends Quantity> Stream<Class<Q>> quantityTypes()