Package com.irurueta.units

Class DistanceFormatter

java.lang.Object

com.irurueta.units.MeasureFormatter<Distance,DistanceUnit>

com.irurueta.units.DistanceFormatter

All Implemented Interfaces:

Cloneable

public class DistanceFormatter
extends MeasureFormatter<Distance,DistanceUnit>

Formats and parses distance value and unit.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CENTIMETER	Centimeter symbol.
static final String	FOOT	Foot symbol.
static final String	INCH	Inch symbol.
static final String	KILOMETER	Kilometer symbol.
static final String	METER	Meter symbol.
static final String	MILE	Mile symbol.
static final String	MILLIMETER	Millimeter symbol.
static final String	YARD	Yard symbol.

Fields inherited from class com.irurueta.units.MeasureFormatter

DEFAULT_VALUE_AND_UNIT_FORMAT_PATTERN, numberFormat

Constructor Summary

Constructors

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

Method Summary

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

MILLIMETER

public static final String MILLIMETER

Millimeter symbol.

See Also:

• Constant Field Values

CENTIMETER

public static final String CENTIMETER

Centimeter symbol.

See Also:

• Constant Field Values

METER

public static final String METER

Meter symbol.

See Also:

• Constant Field Values

KILOMETER

public static final String KILOMETER

Kilometer symbol.

See Also:

• Constant Field Values

INCH

public static final String INCH

Inch symbol.

See Also:

• Constant Field Values

FOOT

public static final String FOOT

Foot symbol.

See Also:

• Constant Field Values

YARD

public static final String YARD

Yard symbol.

See Also:

• Constant Field Values

MILE

public static final String MILE

Mile symbol.

See Also:

• Constant Field Values

Constructor Details

DistanceFormatter

public DistanceFormatter()

Constructor.

DistanceFormatter

public DistanceFormatter(Locale locale)

Constructor with locale.

Parameters:

locale - locale.

Throws:

IllegalArgumentException - if locale is null.

DistanceFormatter

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

Overrides:

equals in class MeasureFormatter<Distance,DistanceUnit>

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<Distance,DistanceUnit>

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<Distance,DistanceUnit>

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

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

Specified by:

parse in class MeasureFormatter<Distance,DistanceUnit>

Parameters:

source - a string to be parsed.

Returns:

a distance containing a value and unit.

Throws:

ParseException - if provided string cannot be parsed.

UnknownUnitException - if unit cannot be determined.

findUnit

public DistanceUnit findUnit(String source)

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

Specified by:

findUnit in class MeasureFormatter<Distance,DistanceUnit>

Parameters:

source - a distance measurement string representation.

Returns:

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

formatAndConvert

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

Formats and converts provided distance 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<Distance,DistanceUnit>

Parameters:

value - a distance value.

unit - a distance unit.

system - system unit to convert distance to.

Returns:

a string representation of distance value and unit.

formatAndConvertMetric

public String formatAndConvertMetric(Number value,
 DistanceUnit unit)

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

Parameters:

value - a distance value.

unit - a distance unit.

Returns:

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

formatAndConvertImperial

public String formatAndConvertImperial(Number value,
 DistanceUnit unit)

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

Parameters:

value - a distance value.

unit - a distance unit.

Returns:

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

getUnitSymbol

public String getUnitSymbol(DistanceUnit unit)

Returns unit string representation.

Specified by:

getUnitSymbol in class MeasureFormatter<Distance,DistanceUnit>

Parameters:

unit - a distance unit.

Returns:

its string representation.