Quantity (Salespoint 6.4.2.RELEASE API)

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

```
@Embeddable
public final class Quantity
extends Object
```
A value object to represent a quantity.

Author:

Oliver Gierke

Constructor Summary

Constructors
Constructor and Description

Quantity()

Constructors
Constructor and Description
`Quantity()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Quantity`	`add(Quantity other)` Adds the given `Quantity` to the current one.
`boolean`	`equals(Object o)`
`BigDecimal`	`getAmount()` The amount of the Quantity.
`Metric`	`getMetric()` The metric of the Quantity.
`int`	`hashCode()`
`boolean`	`isCompatibleWith(Metric metric)` Returns whether the `Quantity` is compatible with the given `Metric`.
`boolean`	`isGreaterThan(Quantity other)` Returns whether the given `Quantity` is greater than the current one.
`boolean`	`isGreaterThanOrEqualTo(Quantity other)` Returns whether the given `Quantity` is greater than or equal to the current one.
`boolean`	`isLessThan(Quantity other)` Returns whether the given `Quantity` is less than the current one.
`boolean`	`isNegative()` Returns whether the current `Quantity` is negative.
`boolean`	`isZeroOrNegative()`
`static Quantity`	`of(BigDecimal amount, Metric metric)` Creates a new `Quantity` of the given amount and `Metric`.
`static Quantity`	`of(double amount)` Creates a new `Quantity` of the given amount.
`static Quantity`	`of(double amount, Metric metric)` Creates a new `Quantity` of the given amount and `Metric`.
`static Quantity`	`of(long amount)` Creates a new `Quantity` of the given amount.
`static Quantity`	`of(long amount, Metric metric)` Creates a new `Quantity` of the given amount and `Metric`.
`Quantity`	`subtract(Quantity other)` Subtracts the given Quantity from the current one.
`String`	`toString()`
`Quantity`	`toZero()` Returns a new `Quantity` of zero with the `Metric` of the current one.

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

- Constructor Detail
  - Quantity
```
@Generated(value="lombok")
Quantity()
```
- Method Detail
  - of
```
public static Quantity of(long amount)
```
    Creates a new Quantity of the given amount. Defaults the metric to .
    
    Parameters:
    
    amount - must not be null.
    
    Returns:
  - of
```
public static Quantity of(double amount)
```
    Creates a new Quantity of the given amount. Defaults the metric to .
    
    Parameters:
    
    amount - must not be null.
    
    Returns:
  - of
```
public static Quantity of(long amount,
                          Metric metric)
```
    Creates a new Quantity of the given amount and Metric.
    
    Parameters:
    
    amount - must not be null.
    
    metric - must not be null.
    
    Returns:
  - of
```
public static Quantity of(double amount,
                          Metric metric)
```
    Creates a new Quantity of the given amount and Metric.
    
    Parameters:
    
    amount - must not be null.
    
    metric - must not be null.
    
    Returns:
  - of
```
public static Quantity of(BigDecimal amount,
                          Metric metric)
```
    Creates a new Quantity of the given amount and Metric.
    
    Parameters:
    
    amount - must not be null.
    
    metric - must not be null.
    
    Returns:
  - isCompatibleWith
```
public boolean isCompatibleWith(Metric metric)
```
    Returns whether the Quantity is compatible with the given Metric.
    
    Parameters:
    
    metric - must not be null.
    
    Returns:
  - add
```
public Quantity add(Quantity other)
```
    Adds the given Quantity to the current one.
    
    Parameters:
    
    other - the Quantity to add. The given Quantity's Metric must be compatible with the current one.
    
    Returns:
    
    See Also:
    
    isCompatibleWith(Metric)
  - subtract
```
public Quantity subtract(Quantity other)
```
    Subtracts the given Quantity from the current one.
    
    Parameters:
    
    other - the Quantity to add. The given Quantity's Metric must be compatible with the current one.
    
    Returns:
    
    See Also:
    
    isCompatibleWith(Metric)
  - isLessThan
```
public boolean isLessThan(Quantity other)
```
    Returns whether the given Quantity is less than the current one.
    
    Parameters:
    
    other - must not be null. The given Quantity's Metric must be compatible with the current one.
    
    Returns:
    
    See Also:
    
    isCompatibleWith(Metric)
  - isGreaterThan
```
public boolean isGreaterThan(Quantity other)
```
    Returns whether the given Quantity is greater than the current one.
    
    Parameters:
    
    other - must not be null. The given Quantity's Metric must be compatible with the current one.
    
    Returns:
    
    See Also:
    
    isCompatibleWith(Metric)
  - isGreaterThanOrEqualTo
```
public boolean isGreaterThanOrEqualTo(Quantity other)
```
    Returns whether the given Quantity is greater than or equal to the current one.
    
    Parameters:
    
    other - must not be null. The given Quantity's Metric must be compatible with the current one.
    
    Returns:
    
    See Also:
    
    isCompatibleWith(Metric)
  - isNegative
```
public boolean isNegative()
```
    Returns whether the current Quantity is negative.
    
    Returns:
  - isZeroOrNegative
```
public boolean isZeroOrNegative()
```
  - toZero
```
public Quantity toZero()
```
    Returns a new Quantity of zero with the Metric of the current one.
    
    Returns:
    
    will never be null.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getAmount
```
@NonNull
 @Generated(value="lombok")
public BigDecimal getAmount()
```
    The amount of the Quantity.
  - getMetric
```
@NonNull
 @Generated(value="lombok")
public Metric getMetric()
```
    The metric of the Quantity.
  - equals
```
@Generated(value="lombok")
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
@Generated(value="lombok")
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Quantity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Quantity

Method Detail

of

of

of

of

of

isCompatibleWith

add

subtract

isLessThan

isGreaterThan

isGreaterThanOrEqualTo

isNegative

isZeroOrNegative

toZero

toString

getAmount

getMetric

equals

hashCode