no.petroware.uom

Class Quantity

java.lang.Object

no.petroware.uom.Quantity

public final class Quantity
extends Object

Model a quantity (such as length or acceleration) and its associated units.

This class is thread-safe.

Author:

Petroware AS

Constructor Summary

Constructors

Constructor and Description
Quantity(String name, String description) Create a new quantity instance.

Method Summary

Modifier and Type	Method and Description
void	addUnit(Unit unit, boolean isBaseUnit) Associate the specified unit with this quantity.
Unit	getBaseUnit() Return the base unit of this quantity.
String	getDescription() Return description of this quantity.
String	getName() Return name of this quantity.
List<Unit>	getUnits() Return the units of this quantity.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Quantity

public Quantity(String name,
                String description)

Create a new quantity instance.

Parameters:

name - Name of quantity, such as "length". Non-null.

description - Optional description. Null if none provided.

Throws:

IllegalArgumentException - If name is null.

Method Detail

getName

public String getName()

Return name of this quantity.

Returns:

Name of this quantity. Never null.

getDescription

public String getDescription()

Return description of this quantity.

Returns:

Description of this quantity. Null if none provided.

getUnits

public List<Unit> getUnits()

Return the units of this quantity. The first unit in the list is always the base unit.

Returns:

Units of this quantity. Never null.

getBaseUnit

public Unit getBaseUnit()

Return the base unit of this quantity. Equivalent to getUnits().get(0).

Returns:

Base unit of this quantity, or null if no units has been added.

addUnit

public void addUnit(Unit unit,
                    boolean isBaseUnit)

Associate the specified unit with this quantity.

Parameters:

unit - Unit to add. Non-null.

isBaseUnit - True if this is the base unit, false otherwise. If more than one unit is added as base unit, the last one added will have this role. If no units are added as base unit, the first unit added will have this role.

Throws:

IllegalArgumentException - If unit is null.

toString

public String toString()

Overrides:

toString in class Object