com.hfg.units

Class Unit

java.lang.Object

com.hfg.units.Unit

All Implemented Interfaces:

Comparable

Direct Known Subclasses:

AmountOfSubstanceUnit, AreaUnit, BiologicalPotencyUnit, CatalyticActivityUnit, ConcentrationUnit, ElectricCurrentUnit, LengthUnit, LuminousIntensityUnit, MassUnit, TemperatureUnit, TimeUnit, VolumeUnit

public class Unit
extends Object
implements Comparable

Container for units.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Unit(List<SubUnit> inSubUnits)
protected	Unit(MeasurementSystem inSystem, QuantityType inQuantityType, String inName, String inAbbrev, Integer inPow)
protected	Unit(MeasurementSystem inSystem, QuantityType inQuantityType, String inName, String inAbbrev, Integer inPow, BaseSIUnitConverter inConversionToBaseSIUnit)
protected	Unit(MeasurementSystem inSystem, QuantityType inQuantityType, String inName, String inAbbrev, Integer inPow, BaseSIUnitConverter inConversionToBaseSIUnit, SubUnit[] inSubUnits)
protected	Unit(MeasurementSystem inSystem, QuantityType inQuantityType, String inName, String inAbbrev, List<SubUnit> inSubUnits)
protected	Unit(MeasurementSystem inSystem, QuantityType inQuantityType, String inName, String inAbbrev, SubUnit... inSubUnits)
protected	Unit(MeasurementSystem inSystem, QuantityType inQuantityType, SubUnit inSubUnit)
protected	Unit(QuantityType inQuantityType, String inName, String inAbbrev, Integer inPow)
protected	Unit(QuantityType inQuantityType, String inName, String inAbbrev, Integer inPow, BaseSIUnitConverter inConversionToBaseSIUnit)
protected	Unit(SubUnit... inSubUnits)
protected	Unit(Unit inSubUnit, SI_ScalingFactor inScalingFactor)

Method Summary

Modifier and Type	Method and Description
Unit	addAlternateName(String inValue)
int	compareTo(List<SubUnit> inSubUnits)
int	compareTo(Object inObj2)
double	computeBaseSIValue(double inValue)
double	computeScaledValue(double inValue, Map<QuantityType,SI_ScalingFactor> inScalingFactorMap)
String	computeUnitLabel(Map<QuantityType,SI_ScalingFactor> inScalingFactorMap, boolean isPlural)
double	computeValueFromBaseSIValue(double inValue)
boolean	equals(Object inObj2)
String	getAbbrev()
Set<String>	getAlternateNames()
Unit	getDenominator()
MathContext	getMathContext()
MeasurementSystem	getMeasurementSystem()
Unit	getNumerator()
String	getPlural()
String	getPluralAbbrev()
Integer	getPow()
QuantityType	getQuantityType()
List<SubUnit>	getSubUnits()
int	hashCode()
boolean	hasSubUnits()
String	name()
static void	setDefaultMathContext(MathContext inValue) Sets the default MathContext to specify precision and rounding during operations.
Unit	setMathContext(MathContext inValue) Sets the MathContext to specify precision and rounding during operations with this Unit.
Unit	setMeasurementSystem(MeasurementSystem inValue)
Unit	setPlural(String inValue)
Unit	setPluralAbbrev(String inValue)
String	toString()
static Unit	valueOf(List<SubUnit> inSubUnits)
static Unit	valueOf(String inString)
static Unit	valueOf(SubUnit inSubUnit)
static Collection<? extends Unit>	values()

Methods inherited from class java.lang.Object

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

Constructor Detail

Unit

protected Unit(QuantityType inQuantityType,
               String inName,
               String inAbbrev,
               Integer inPow)

Unit

protected Unit(MeasurementSystem inSystem,
               QuantityType inQuantityType,
               String inName,
               String inAbbrev,
               Integer inPow)

Unit

protected Unit(QuantityType inQuantityType,
               String inName,
               String inAbbrev,
               Integer inPow,
               BaseSIUnitConverter inConversionToBaseSIUnit)

Unit

protected Unit(MeasurementSystem inSystem,
               QuantityType inQuantityType,
               String inName,
               String inAbbrev,
               Integer inPow,
               BaseSIUnitConverter inConversionToBaseSIUnit)

Unit

protected Unit(MeasurementSystem inSystem,
               QuantityType inQuantityType,
               String inName,
               String inAbbrev,
               Integer inPow,
               BaseSIUnitConverter inConversionToBaseSIUnit,
               SubUnit[] inSubUnits)

Unit

protected Unit(MeasurementSystem inSystem,
               QuantityType inQuantityType,
               SubUnit inSubUnit)

Unit

protected Unit(Unit inSubUnit,
               SI_ScalingFactor inScalingFactor)

Unit

protected Unit(SubUnit... inSubUnits)

Unit

protected Unit(List<SubUnit> inSubUnits)

Unit

protected Unit(MeasurementSystem inSystem,
               QuantityType inQuantityType,
               String inName,
               String inAbbrev,
               List<SubUnit> inSubUnits)

Unit

protected Unit(MeasurementSystem inSystem,
               QuantityType inQuantityType,
               String inName,
               String inAbbrev,
               SubUnit... inSubUnits)

Method Detail

setDefaultMathContext

public static void setDefaultMathContext(MathContext inValue)

Sets the default MathContext to specify precision and rounding during operations.

Parameters:

inValue - the MathContext to use

setMathContext

public Unit setMathContext(MathContext inValue)

Sets the MathContext to specify precision and rounding during operations with this Unit.

Parameters:

inValue - the MathContext to use

getMathContext

public MathContext getMathContext()

values

public static Collection<? extends Unit> values()

valueOf

public static Unit valueOf(SubUnit inSubUnit)

valueOf

public static Unit valueOf(List<SubUnit> inSubUnits)

valueOf

public static Unit valueOf(String inString)

toString

public String toString()

Overrides:

toString in class Object

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

compareTo

public int compareTo(List<SubUnit> inSubUnits)

name

public String name()

getAbbrev

public String getAbbrev()

addAlternateName

public Unit addAlternateName(String inValue)

getAlternateNames

public Set<String> getAlternateNames()

setPlural

public Unit setPlural(String inValue)

getPlural

public String getPlural()

setPluralAbbrev

public Unit setPluralAbbrev(String inValue)

getPluralAbbrev

public String getPluralAbbrev()

setMeasurementSystem

public Unit setMeasurementSystem(MeasurementSystem inValue)

getMeasurementSystem

public MeasurementSystem getMeasurementSystem()

getQuantityType

public QuantityType getQuantityType()

getPow

public Integer getPow()

hasSubUnits

public boolean hasSubUnits()

getSubUnits

public List<SubUnit> getSubUnits()

computeBaseSIValue

public double computeBaseSIValue(double inValue)

computeValueFromBaseSIValue

public double computeValueFromBaseSIValue(double inValue)

computeScaledValue

public double computeScaledValue(double inValue,
                                 Map<QuantityType,SI_ScalingFactor> inScalingFactorMap)

computeUnitLabel

public String computeUnitLabel(Map<QuantityType,SI_ScalingFactor> inScalingFactorMap,
                               boolean isPlural)

getNumerator

public Unit getNumerator()

getDenominator

public Unit getDenominator()