Package com.irurueta.units

Class VolumeFormatter

java.lang.Object

com.irurueta.units.MeasureFormatter<Volume,VolumeUnit>

com.irurueta.units.VolumeFormatter

All Implemented Interfaces:

Cloneable

public class VolumeFormatter
extends MeasureFormatter<Volume,VolumeUnit>

Formats and parses volume value and unit.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BARREL	Barrel symbol.
static final String	CUBIC_CENTIMETER	Cubic centimeter symbol.
static final String	CUBIC_DECIMETER	Cubic decimeter symbol.
static final String	CUBIC_FOOT	Cubic foot symbol.
static final String	CUBIC_INCH	Cubic inch symbol.
static final String	CUBIC_METER	Cubic meter symbol.
static final String	GALLON	Gallon symbol.
static final String	HECTOLITER	Hectoliter symbol.
static final String	LITER	Liter symbol.
static final String	MILLILITER	Milliliter symbol.
static final String	PINT	Pint symbol.

Fields inherited from class com.irurueta.units.MeasureFormatter

DEFAULT_VALUE_AND_UNIT_FORMAT_PATTERN, numberFormat

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Determines if two volume formatters are equal by comparing all of their internal parameters.
VolumeUnit	findUnit(String source)	Attempts to determine a volume unit within a measurement string representation.
String	formatAndConvert(Number value, VolumeUnit unit, UnitSystem system)	Formats and converts provided volume value and unit using provided unit system.
String	formatAndConvertImperial(Number value, VolumeUnit unit)	Formats and converts provided volume value and unit using imperial unit system.
String	formatAndConvertMetric(Number value, VolumeUnit unit)	Formats and converts provided volume value and unit using metric unit system.
String	getUnitSymbol(VolumeUnit 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.
Volume	parse(String source)	Parses provided string and tries to determine a volume 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

CUBIC_CENTIMETER

public static final String CUBIC_CENTIMETER

Cubic centimeter symbol.

See Also:

• Constant Field Values

MILLILITER

public static final String MILLILITER

Milliliter symbol.

See Also:

• Constant Field Values

CUBIC_DECIMETER

public static final String CUBIC_DECIMETER

Cubic decimeter symbol.

See Also:

• Constant Field Values

LITER

public static final String LITER

Liter symbol.

See Also:

• Constant Field Values

HECTOLITER

public static final String HECTOLITER

Hectoliter symbol.

See Also:

• Constant Field Values

CUBIC_METER

public static final String CUBIC_METER

Cubic meter symbol.

See Also:

• Constant Field Values

CUBIC_INCH

public static final String CUBIC_INCH

Cubic inch symbol.

See Also:

• Constant Field Values

PINT

public static final String PINT

Pint symbol.

See Also:

• Constant Field Values

GALLON

public static final String GALLON

Gallon symbol.

See Also:

• Constant Field Values

CUBIC_FOOT

public static final String CUBIC_FOOT

Cubic foot symbol.

See Also:

• Constant Field Values

BARREL

public static final String BARREL

Barrel symbol.

See Also:

• Constant Field Values

Constructor Details

VolumeFormatter

public VolumeFormatter()

Constructor.

VolumeFormatter

public VolumeFormatter(Locale locale)

Constructor with locale.

Parameters:

locale - locale.

Throws:

IllegalArgumentException - if locale is null.

VolumeFormatter

public VolumeFormatter(VolumeFormatter 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 volume formatters are equal by comparing all of their internal parameters.

Overrides:

equals in class MeasureFormatter<Volume,VolumeUnit>

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<Volume,VolumeUnit>

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<Volume,VolumeUnit>

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 Volume parse(String source)
             throws ParseException,
UnknownUnitException

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

Specified by:

parse in class MeasureFormatter<Volume,VolumeUnit>

Parameters:

source - a string to be parsed.

Returns:

a volume containing a value and unit.

Throws:

ParseException - if provided string cannot be parsed.

UnknownUnitException - if unit cannot be determined.

findUnit

public VolumeUnit findUnit(String source)

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

Specified by:

findUnit in class MeasureFormatter<Volume,VolumeUnit>

Parameters:

source - a volume measurement string representation.

Returns:

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

formatAndConvert

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

Formats and converts provided volume 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<Volume,VolumeUnit>

Parameters:

value - a volume value.

unit - a volume unit.

system - system unit to convert measurement to.

Returns:

a string representation of volume value and unit.

formatAndConvertMetric

public String formatAndConvertMetric(Number value,
 VolumeUnit unit)

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

Parameters:

value - a volume value.

unit - a volume unit.

Returns:

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

formatAndConvertImperial

public String formatAndConvertImperial(Number value,
 VolumeUnit unit)

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

Parameters:

value - a volume value.

unit - a volume unit.

Returns:

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

getUnitSymbol

public String getUnitSymbol(VolumeUnit unit)

Returns unit string representation.

Specified by:

getUnitSymbol in class MeasureFormatter<Volume,VolumeUnit>

Parameters:

unit - a volume unit.

Returns:

its string representation.