Package com.irurueta.units

Class SpeedFormatter

java.lang.Object

com.irurueta.units.MeasureFormatter<Speed,SpeedUnit>

com.irurueta.units.SpeedFormatter

All Implemented Interfaces:

Cloneable

public class SpeedFormatter
extends MeasureFormatter<Speed,SpeedUnit>

Formats and parses speed value and unit.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FEET_PER_SECOND	Feet per second symbol.
static final String	KILOMETERS_PER_HOUR	Kilometers per hour symbol.
static final String	KILOMETERS_PER_SECOND	Kilometers per second symbol.
static final String	METERS_PER_SECOND	Meters per second symbol.
static final String	MILES_PER_HOUR	Miles per hour symbol.

Fields inherited from class com.irurueta.units.MeasureFormatter

DEFAULT_VALUE_AND_UNIT_FORMAT_PATTERN, numberFormat

Constructor Summary

Constructors

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

Method Summary

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

METERS_PER_SECOND

public static final String METERS_PER_SECOND

Meters per second symbol.

See Also:

• Constant Field Values

KILOMETERS_PER_HOUR

public static final String KILOMETERS_PER_HOUR

Kilometers per hour symbol.

See Also:

• Constant Field Values

KILOMETERS_PER_SECOND

public static final String KILOMETERS_PER_SECOND

Kilometers per second symbol.

See Also:

• Constant Field Values

FEET_PER_SECOND

public static final String FEET_PER_SECOND

Feet per second symbol.

See Also:

• Constant Field Values

MILES_PER_HOUR

public static final String MILES_PER_HOUR

Miles per hour symbol.

See Also:

• Constant Field Values

Constructor Details

SpeedFormatter

public SpeedFormatter()

Constructor.

SpeedFormatter

public SpeedFormatter(Locale locale)

Constructor with locale.

Parameters:

locale - locale.

Throws:

IllegalArgumentException - if locale is null.

SpeedFormatter

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

Overrides:

equals in class MeasureFormatter<Speed,SpeedUnit>

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<Speed,SpeedUnit>

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<Speed,SpeedUnit>

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

Parses provided string and tries to determine speed value and unit.

Specified by:

parse in class MeasureFormatter<Speed,SpeedUnit>

Parameters:

source - a string to be parsed.

Returns:

a speed containing a value and unit.

Throws:

ParseException - if provided string cannot be parsed.

UnknownUnitException - if unit cannot be determined.

findUnit

public SpeedUnit findUnit(String source)

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

Specified by:

findUnit in class MeasureFormatter<Speed,SpeedUnit>

Parameters:

source - a measurement string representation.

Returns:

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

formatAndConvert

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

Formats and converts provided speed 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<Speed,SpeedUnit>

Parameters:

value - a speed value.

unit - a speed unit.

system - system unit to convert speed to.

Returns:

a string representation of speed value and unit.

formatAndConvertMetric

public String formatAndConvertMetric(Number value,
 SpeedUnit unit)

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

Parameters:

value - a speed value.

unit - a speed unit.

Returns:

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

formatAndConvertImperial

public String formatAndConvertImperial(Number value,
 SpeedUnit unit)

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

Parameters:

value - a speed value.

unit - a speed unit.

Returns:

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

getUnitSymbol

public String getUnitSymbol(SpeedUnit unit)

Returns unit string representation.

Specified by:

getUnitSymbol in class MeasureFormatter<Speed,SpeedUnit>

Parameters:

unit - a speed unit.

Returns:

its string representation.