Quantity (Salespoint 6.1.1.RELEASE API)

java.lang.Object
- org.salespointframework.quantity.Quantity

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Quantity>

Direct Known Subclasses:

Units
```
public class Quantity
extends Object
implements Comparable<Quantity>, Serializable, Cloneable
```
The Quantity class represents an amount of something. 'Something' is specified using a Metric. A RoundingStrategy accommodates amounts that do not fit the value set of a given metric (Think of money: 0.0001€ has no meaning in the real world). The roundingStrategy is applied to amount in the class constructor. This way, every instance has a valid amount. To allow arithmetic operations on Quantity objects and instances of subclasses of Quantity to return the correct type (and thus avoiding casts), Quantity instances are immutable and all subclasses of Quantity have to be immutable or implement a suitable clone()-method.

Author:

Hannes Weisbach

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected BigDecimal amount
BigDecimal object, holding the value of this Quantity.

Fields
Modifier and Type	Field and Description
`protected BigDecimal`	`amount` `BigDecimal` object, holding the value of this `Quantity`.

Constructor Summary

Constructors
Constructor and Description
`Quantity(BigDecimal amount, Metric metric, RoundingStrategy roundingStrategy)` Parameterized class constructor.
`Quantity(double amount, Metric metric, RoundingStrategy roundingStrategy)` Translates a `double` to a `Quantity`.
`Quantity(float amount, Metric metric, RoundingStrategy roundingStrategy)` Translates a `float` to a `Quantity`.
`Quantity(int amount, Metric metric, RoundingStrategy roundingStrategy)` Translates an `int` to a `Quantity`.
`Quantity(long amount, Metric metric, RoundingStrategy roundingStrategy)` Translates a `long` to a `Quantity`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends Quantity> T`	`add(T quantity)` Sums two quantities up.
`Object`	`clone()`
`int`	`compareTo(Quantity o)`
`<T extends Quantity> T`	`divide(T quantity)` Divides this by another quantity.
`boolean`	`equals(Object obj)`
`BigDecimal`	`getAmount()` Returns the `amount` of this as `float`.
`Metric`	`getMetric()` Returns the `metric` associated with this `Quantity`.
`RoundingStrategy`	`getRoundingStrategy()` Returns the `RoundingStrategy` of this `Quantity`.
`int`	`hashCode()`
`boolean`	`isGreaterThan(Quantity other)` Compares Quantities.
`boolean`	`isGreaterThanOrEqualTo(Quantity other)` Compares Quantities.
`boolean`	`isLessThan(Quantity other)` Compares Quantities
`boolean`	`isNegative()` Check if this quantity is negative
`<T extends Quantity> T`	`multiply(T quantity)` Multiplies two quantities.
`<T extends Quantity> T`	`subtract(T quantity)` Subtracts a quantity from this.
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - amount
```
protected BigDecimal amount
```
    BigDecimal object, holding the value of this Quantity.
- Constructor Detail
  - Quantity
```
public Quantity(BigDecimal amount,
                Metric metric,
                RoundingStrategy roundingStrategy)
```
    Parameterized class constructor. amount is immediately rounded using the supplied roundingStrategy.
    
    Parameters:
    
    amount - amount represented by this Quantity
    
    metric - metric used for this Quantity
    
    roundingStrategy - roundingStrategy to be used with this Quantity
  - Quantity
```
public Quantity(int amount,
                Metric metric,
                RoundingStrategy roundingStrategy)
```
    Translates an int to a Quantity. The Integer is rounded according to the supplied RoudingStrategy.
    
    Parameters:
    
    amount - int value to be converted to Quantity
    
    metric - metric to be used with this Quantity
    
    roundingStrategy - roudingStrategy to be used with this Quantity
  - Quantity
```
public Quantity(long amount,
                Metric metric,
                RoundingStrategy roundingStrategy)
```
    Translates a long to a Quantity.
    
    Parameters:
    
    amount - long value to be converted to a Quantity
    
    metric - metric to be used with this Quantity
    
    roundingStrategy - roundingStrategy to be used with this Quantity
  - Quantity
```
public Quantity(float amount,
                Metric metric,
                RoundingStrategy roundingStrategy)
```
    Translates a float to a Quantity.
    
    Parameters:
    
    amount - float value to be converted to a Quantity
    
    metric - metric to be used with this Quantity
    
    roundingStrategy - roundingStrategy to be used with this Quantity
  - Quantity
```
public Quantity(double amount,
                Metric metric,
                RoundingStrategy roundingStrategy)
```
    Translates a double to a Quantity.
    
    Parameters:
    
    amount - double value to be converted to a Quantity
    
    metric - metric to be used with this Quantity
    
    roundingStrategy - roundingStrategy to be used with this Quantity
- Method Detail
  - getMetric
```
public Metric getMetric()
```
    Returns the metric associated with this Quantity.
    
    Returns:
    
    Metric of this Quantity.
  - getRoundingStrategy
```
public RoundingStrategy getRoundingStrategy()
```
    Returns the RoundingStrategy of this Quantity.
    
    Returns:
    
    RoundingStrategy of this Quantity.
  - getAmount
```
public BigDecimal getAmount()
```
    Returns the amount of this as float.
    
    Returns:
    
    the amount of this as float.
  - compareTo
```
public int compareTo(Quantity o)
```
    Specified by:
    
    compareTo in interface Comparable<Quantity>
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - isNegative
```
public boolean isNegative()
```
    Check if this quantity is negative
    
    Returns:
    
    true if the quantity is negative
  - isLessThan
```
public boolean isLessThan(Quantity other)
```
    Compares Quantities
    
    Parameters:
    
    other - Quantity to which this Quantity is to be compared.
    
    Returns:
    
    true if this quantity is less than the other quantity.
  - isGreaterThan
```
public boolean isGreaterThan(Quantity other)
```
    Compares Quantities.
    
    Parameters:
    
    other - Quantity to which this Quantity is to be compared.
    
    Returns:
    
    true if this quantity is greater than the other quantity.
  - isGreaterThanOrEqualTo
```
public boolean isGreaterThanOrEqualTo(Quantity other)
```
    Compares Quantities.
    
    Parameters:
    
    other - Quantity to which this Quantity is to be compared.
    
    Returns:
    
    true if this quantity is greater than the other quantity or equal to it.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class Object
  - add
```
public <T extends Quantity> T add(T quantity)
```
    Sums two quantities up. The amount of this and quantity are added, and a new Quantity-instance is returned, representing the sum. The metric and rounding strategy of quantity are used for the new instance. No check is performed, whether the metrics of both quantities are compatible, i.e. it is possible to combine, say kg and s.
    To avoid casting, arithmetic methods are generic. If a sub class of Quantity is passed as parameter, the result will have the same type, as the parameter.
    
    Type Parameters:
    
    T - type of the parameter and returned object
    
    Parameters:
    
    quantity - Quantity to be added to this.
    
    Returns:
    
    a new Quantity object representing the sum of this and quantity.
  - subtract
```
public <T extends Quantity> T subtract(T quantity)
```
    Subtracts a quantity from this. The amount of this is subtracted by that of quantity, and a new Quantity-instance is returned, representing the difference. The metric and rounding strategy of quantity are used for the new instance. No check is performed, whether the metrics of both quantities are compatible, i.e. it is possible to combine, say kg and s.
    To avoid casting, arithmetic methods are generic. If a sub class of Quantity is passed as parameter, the result will have the same type, as the parameter.
    
    Type Parameters:
    
    T - type of the parameter and returned object
    
    Parameters:
    
    quantity - Quantity to be subtracted from this.
    
    Returns:
    
    a new Quantity object representing the difference of this and quantity.
  - multiply
```
public <T extends Quantity> T multiply(T quantity)
```
    Multiplies two quantities. The amount of this and quantity are multiplied, and a new Quantity -instance is returned, representing the product. The metric and rounding Strategy of this are used for the new instance. No check is performed, whether the metrics of both quantities are compatible, i.e. it is possible to combine, say kg and s.
    To avoid casting, arithmetic methods are generic. If a sub class of Quantity is passed as parameter, the result will have the same type, as the parameter.
    
    Type Parameters:
    
    T - type of the parameter and returned object
    
    Parameters:
    
    quantity - Quantity to be multiplied with this.
    
    Returns:
    
    a new Quantity object representing the product of this and quantity.
  - divide
```
public <T extends Quantity> T divide(T quantity)
```
    Divides this by another quantity. The amount of this the dividend, quantity the divisor, and a new Quantity-instance is returned as quotient. The metric and rounding Strategy of this are used for the new instance. No check is performed, whether the metrics of both quantities are compatible, i.e. it is possible to combine, say kg and s.
    To avoid casting, arithmetic methods are generic. If a sub class of Quantity is passed as parameter, the result will have the same type, as the parameter.
    
    Type Parameters:
    
    T - type of the parameter and returned object
    
    Parameters:
    
    quantity - Quantity to be used as divisor.
    
    Returns:
    
    a new Quantity object representing the quotient.

Class Quantity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

amount

Constructor Detail

Quantity

Quantity

Quantity

Quantity

Quantity

Method Detail

getMetric

getRoundingStrategy

getAmount

compareTo

equals

isNegative

isLessThan

isGreaterThan

isGreaterThanOrEqualTo

toString

hashCode

clone

add

subtract

multiply

divide