Quantity (com.hfg API Documentation)

java.lang.Object
- com.hfg.units.Quantity

All Implemented Interfaces:

Comparable

Direct Known Subclasses:

Length, TimeSpan
```
public class Quantity
extends Object
implements Comparable
```
Quantifiable amount. Amount plus units.

Constructor Summary

Constructors
Constructor and Description
`Quantity(Double inValue, String inUnit)` Convenience constructor that will call Unit.valueOf() on the specified unit string.
`Quantity(Double inValue, Unit inUnit)`
`Quantity(Float inValue, String inUnit)` Convenience constructor that will call Unit.valueOf() on the specified unit string.
`Quantity(Float inValue, Unit inUnit)`
`Quantity(Integer inValue, String inUnit)` Convenience constructor that will call Unit.valueOf() on the specified unit string.
`Quantity(Integer inValue, Unit inUnit)`
`Quantity(Long inValue, String inUnit)` Convenience constructor that will call Unit.valueOf() on the specified unit string.
`Quantity(Long inValue, Unit inUnit)`
`Quantity(String inValue)` Convenience constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Quantity`	`add(Quantity inValue)`
`Quantity`	`autoScale()`
`Quantity`	`autoScale(SI_ScalingFactor[] inScalingValues)`
`int`	`compareTo(Object inObj2)`
`Quantity`	`convertTo(Unit inUnit)`
`Quantity`	`divideBy(double inValue)`
`Double`	`doubleValue()`
`boolean`	`equals(Object inObj2)`
`Float`	`floatValue()`
`Unit`	`getUnit()`
`boolean`	`greaterThan(Quantity inValue)`
`boolean`	`greaterThanOrEqualTo(Quantity inValue)`
`int`	`hashCode()`
`Integer`	`intValue()`
`Quantity`	`invert()`
`boolean`	`lessThan(Quantity inValue)`
`boolean`	`lessThanOrEqualTo(Quantity inValue)`
`Long`	`longValue()`
`Quantity`	`multiplyBy(double inValue)`
`void`	`scale(QuantityType inQuantityType, SI_ScalingFactor inScalingFactor)`
`Quantity`	`subtract(Quantity inValue)`
`String`	`toString()`
`String`	`toString(DecimalFormat inFormat)` Outputs the Quantity as a numeric value followed by the units where the numeric portion is formatted according to the specified DecimalFormat object.
`String`	`toString(String inFmtString)` Outputs the Quantity as a numeric value followed by the units where the numeric portion is formatted according to the specified sprintf string.
`void`	`verifyQuantityType(QuantityType inExpectedQuantityType)` Performs a validation test to ensure that the unit is of the expected quantity type.

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

- Constructor Detail
  - Quantity
```
public Quantity(Double inValue,
                String inUnit)
```
    Convenience constructor that will call Unit.valueOf() on the specified unit string.
    
    Parameters:
    
    inValue - the numeric amount as a double
    
    inUnit - the volume unit of the specified amount
  - Quantity
```
public Quantity(Float inValue,
                String inUnit)
```
    Convenience constructor that will call Unit.valueOf() on the specified unit string.
    
    Parameters:
    
    inValue - the numeric amount as a float
    
    inUnit - the volume unit of the specified amount
  - Quantity
```
public Quantity(Integer inValue,
                String inUnit)
```
    Convenience constructor that will call Unit.valueOf() on the specified unit string.
    
    Parameters:
    
    inValue - the numeric amount as an integer
    
    inUnit - the volume unit of the specified amount
  - Quantity
```
public Quantity(Long inValue,
                String inUnit)
```
    Convenience constructor that will call Unit.valueOf() on the specified unit string.
    
    Parameters:
    
    inValue - the numeric amount as an integer
    
    inUnit - the volume unit of the specified amount
  - Quantity
```
public Quantity(String inValue)
```
    Convenience constructor.
    
    Parameters:
    
    inValue - the string value
  - Quantity
```
public Quantity(Double inValue,
                Unit inUnit)
```
  - Quantity
```
public Quantity(Float inValue,
                Unit inUnit)
```
  - Quantity
```
public Quantity(Integer inValue,
                Unit inUnit)
```
  - Quantity
```
public Quantity(Long inValue,
                Unit inUnit)
```
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toString
```
public String toString(String inFmtString)
```
    Outputs the Quantity as a numeric value followed by the units where the numeric portion is formatted according to the specified sprintf string.
    
    Parameters:
    
    inFmtString - a sprintf format specification
    
    Returns:
    
    the formatted Quantity value
  - toString
```
public String toString(DecimalFormat inFormat)
```
    Outputs the Quantity as a numeric value followed by the units where the numeric portion is formatted according to the specified DecimalFormat object.
    
    Parameters:
    
    inFormat - a DecimalFormat format specification
    
    Returns:
    
    the formatted Quantity value
  - equals
```
public boolean equals(Object inObj2)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(Object inObj2)
```
    Specified by:
    
    compareTo in interface Comparable
  - scale
```
public void scale(QuantityType inQuantityType,
                  SI_ScalingFactor inScalingFactor)
```
  - convertTo
```
public Quantity convertTo(Unit inUnit)
```
  - invert
```
public Quantity invert()
```
  - multiplyBy
```
public Quantity multiplyBy(double inValue)
```
  - divideBy
```
public Quantity divideBy(double inValue)
```
  - add
```
public Quantity add(Quantity inValue)
```
  - subtract
```
public Quantity subtract(Quantity inValue)
```
  - lessThan
```
public boolean lessThan(Quantity inValue)
```
  - lessThanOrEqualTo
```
public boolean lessThanOrEqualTo(Quantity inValue)
```
  - greaterThan
```
public boolean greaterThan(Quantity inValue)
```
  - greaterThanOrEqualTo
```
public boolean greaterThanOrEqualTo(Quantity inValue)
```
  - getUnit
```
public Unit getUnit()
```
  - doubleValue
```
public Double doubleValue()
```
  - floatValue
```
public Float floatValue()
```
  - intValue
```
public Integer intValue()
```
  - longValue
```
public Long longValue()
```
  - autoScale
```
public Quantity autoScale()
```
  - autoScale
```
public Quantity autoScale(SI_ScalingFactor[] inScalingValues)
```
  - verifyQuantityType
```
public void verifyQuantityType(QuantityType inExpectedQuantityType)
```
    Performs a validation test to ensure that the unit is of the expected quantity type.
    
    Parameters:
    
    inExpectedQuantityType - the quantity type that is expected.
    
    Throws:
    
    InvalidValueException - if the unit isn't set or is not of the expected type.

Class Quantity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Quantity

Quantity

Quantity

Quantity

Quantity

Quantity

Quantity

Quantity

Quantity

Method Detail

toString

toString

toString

equals

hashCode

compareTo

scale

convertTo

invert

multiplyBy

divideBy

add

subtract

lessThan

lessThanOrEqualTo

greaterThan

greaterThanOrEqualTo

getUnit

doubleValue

floatValue

intValue

longValue

autoScale

autoScale

verifyQuantityType