Package com.irurueta.units

Class WeightFormatter

java.lang.Object

com.irurueta.units.MeasureFormatter<Weight,WeightUnit>

com.irurueta.units.WeightFormatter

All Implemented Interfaces:

Cloneable

public class WeightFormatter
extends MeasureFormatter<Weight,WeightUnit>

Formats and parses weight value and unit.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GRAM	Gram symbol.
static final String	KILOGRAM	Kilogram symbol.
static final String	MEGATONNE	Megatonne symbol.
static final String	MICROGRAM	Microgram symbol.
static final String	MILLIGRAM	Milligram symbol.
static final String	NANOGRAM	Nanogram symbol.
static final String	OUNCE	Ounce symbol.
static final String	PICOGRAM	Picogram symbol.
static final String	POUND	Pound symbol.
static final String	TONNE	Metric tonne symbol.
static final String	US_UK_TON	U.S.

Fields inherited from class com.irurueta.units.MeasureFormatter

DEFAULT_VALUE_AND_UNIT_FORMAT_PATTERN, numberFormat

Constructor Summary

Constructors

Constructor	Description
WeightFormatter()	Constructor.
WeightFormatter(WeightFormatter formatter)	Copy constructor.
WeightFormatter(Locale locale)	Constructor with locale.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Determines if two weight formatters are equal by comparing all of their internal parameters.
WeightUnit	findUnit(String source)	Attempts to determine a weight unit within a measurement string representation.
String	formatAndConvert(Number value, WeightUnit unit, UnitSystem system)	Formats and converts provided weight value and unit using provided unit system.
String	formatAndConvertImperial(Number value, WeightUnit unit)	Formats and converts provided weight value and unit using imperial unit system.
String	formatAndConvertMetric(Number value, WeightUnit unit)	Formats and converts provided weight value and unit using metric unit system.
String	getUnitSymbol(WeightUnit unit)	Returns unit string representation.
UnitSystem	getUnitSystem(String source)	Gets unit system for detected unit into provided string representation of a measurement.
int	hashCode()	Hash code generated for this instance.
Weight	parse(String source)	Parses provided string and tries to determine a weight value and unit.

Methods inherited from class com.irurueta.units.MeasureFormatter

clone, format, format, format, format, format, format, formatAndConvert, formatAndConvert, formatAndConvert, formatAndConvert, formatAndConvert, getAvailableLocales, getLocale, getMaximumFractionDigits, getMaximumIntegerDigits, getMinimumFractionDigits, getMinimumIntegerDigits, getRoundingMode, getUnitSystem, getValueAndUnitFormatPattern, internalClone, internalParse, isGroupingUsed, isImperialUnit, isMetricUnit, isParseIntegerOnly, isValidMeasurement, isValidUnit, setGroupingUsed, setMaximumFractionDigits, setMaximumIntegerDigits, setMinimumFractionDigits, setMinimumIntegerDigits, setParseIntegerOnly, setRoundingMode, setValueAndUnitFormatPattern

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

PICOGRAM

public static final String PICOGRAM

Picogram symbol.

See Also:

• Constant Field Values

NANOGRAM

public static final String NANOGRAM

Nanogram symbol.

See Also:

• Constant Field Values

MICROGRAM

public static final String MICROGRAM

Microgram symbol.

See Also:

• Constant Field Values

MILLIGRAM

public static final String MILLIGRAM

Milligram symbol.

See Also:

• Constant Field Values

GRAM

public static final String GRAM

Gram symbol.

See Also:

• Constant Field Values

KILOGRAM

public static final String KILOGRAM

Kilogram symbol.

See Also:

• Constant Field Values

TONNE

public static final String TONNE

Metric tonne symbol.

See Also:

• Constant Field Values

MEGATONNE

public static final String MEGATONNE

Megatonne symbol.

See Also:

• Constant Field Values

US_UK_TON

public static final String US_UK_TON

U.S. OR U.K. ton symbol.

See Also:

• Constant Field Values

POUND

public static final String POUND

Pound symbol.

See Also:

• Constant Field Values

OUNCE

public static final String OUNCE

Ounce symbol.

See Also:

• Constant Field Values

Constructor Details

WeightFormatter

public WeightFormatter()

Constructor.

WeightFormatter

public WeightFormatter(Locale locale)

Constructor with locale.

Parameters:

locale - locale.

Throws:

IllegalArgumentException - if locale is null.

WeightFormatter

public WeightFormatter(WeightFormatter formatter)

Copy constructor.

Parameters:

formatter - input instance to copy from.

Throws:

NullPointerException - if provided formatter is null.

Method Details

equals

public boolean equals(Object obj)

Determines if two weight formatters are equal by comparing all of their internal parameters.

Overrides:

equals in class MeasureFormatter<Weight,WeightUnit>

Parameters:

obj - another object to compare.

Returns:

true if provided object is assumed to be equal to this instance.

hashCode

public int hashCode()

Hash code generated for this instance. Hash codes can be internally used by some collections to coarsely compare objects. This implementation only calls parent implementation to avoid static analyzer warning.

Overrides:

hashCode in class MeasureFormatter<Weight,WeightUnit>

Returns:

hash code.

getUnitSystem

public UnitSystem getUnitSystem(String source)

Gets unit system for detected unit into provided string representation of a measurement.

Specified by:

getUnitSystem in class MeasureFormatter<Weight,WeightUnit>

Parameters:

source - a measurement string representation to be checked.

Returns:

a unit system (either metric or imperial) or null if unit cannot be determined.

parse

public Weight parse(String source)
             throws ParseException,
UnknownUnitException

Parses provided string and tries to determine a weight value and unit.

Specified by:

parse in class MeasureFormatter<Weight,WeightUnit>

Parameters:

source - a string to be parsed.

Returns:

a weight containing a value and unit.

Throws:

ParseException - if provided string cannot be parsed.

UnknownUnitException - if unit cannot be determined.

findUnit

public WeightUnit findUnit(String source)

Attempts to determine a weight unit within a measurement string representation.

Specified by:

findUnit in class MeasureFormatter<Weight,WeightUnit>

Parameters:

source - a weight measurement string representation.

Returns:

a weight unit, or null if none can be determined.

formatAndConvert

public String formatAndConvert(Number value,
 WeightUnit unit,
 UnitSystem system)

Formats and converts provided weight value and unit using provided unit system. If provided value is too large for provided unit, this method will convert it to a more appropriate unit using provided unit system (either metric or imperial).

Specified by:

formatAndConvert in class MeasureFormatter<Weight,WeightUnit>

Parameters:

value - a weight value.

unit - a weight unit.

system - system unit to convert measurement to.

Returns:

a string representation of weight value and unit.

formatAndConvertMetric

public String formatAndConvertMetric(Number value,
 WeightUnit unit)

Formats and converts provided weight value and unit using metric unit system. If provided weight value is too large for provided weight unit, this method will convert to a more appropriate unit.

Parameters:

value - a weight value.

unit - a weight unit.

Returns:

a string representation of weight value and unit using metric unit system.

formatAndConvertImperial

public String formatAndConvertImperial(Number value,
 WeightUnit unit)

Formats and converts provided weight value and unit using imperial unit system. If provided weight value is too large for provided weight unit, this method will convert to a more appropriate unit.

Parameters:

value - a weight value.

unit - a weight unit.

Returns:

a string representation of weight value and unit using imperial unit system.

getUnitSymbol

public String getUnitSymbol(WeightUnit unit)

Returns unit string representation.

Specified by:

getUnitSymbol in class MeasureFormatter<Weight,WeightUnit>

Parameters:

unit - a weight unit.

Returns:

its string representation.