Package com.irurueta.units

Class TemperatureFormatter

java.lang.Object

com.irurueta.units.MeasureFormatter<Temperature,TemperatureUnit>

com.irurueta.units.TemperatureFormatter

All Implemented Interfaces:

Cloneable

public class TemperatureFormatter
extends MeasureFormatter<Temperature,TemperatureUnit>

Formats and parses temperature value and unit.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CELSIUS	Celsius symbol.
static final String	FAHRENHEIT	Fahrenheit symbol.
static final String	KELVIN	Kelvin symbol.

Fields inherited from class com.irurueta.units.MeasureFormatter

DEFAULT_VALUE_AND_UNIT_FORMAT_PATTERN, numberFormat

Constructor Summary

Constructors

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

Method Summary

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

CELSIUS

public static final String CELSIUS

Celsius symbol.

See Also:

• Constant Field Values

FAHRENHEIT

public static final String FAHRENHEIT

Fahrenheit symbol.

See Also:

• Constant Field Values

KELVIN

public static final String KELVIN

Kelvin symbol.

See Also:

• Constant Field Values

Constructor Details

TemperatureFormatter

public TemperatureFormatter()

Constructor.

TemperatureFormatter

public TemperatureFormatter(Locale locale)

Constructor with locale.

Parameters:

locale - locale.

Throws:

IllegalArgumentException - if locale is null.

TemperatureFormatter

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

Overrides:

equals in class MeasureFormatter<Temperature,TemperatureUnit>

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<Temperature,TemperatureUnit>

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<Temperature,TemperatureUnit>

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

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

Specified by:

parse in class MeasureFormatter<Temperature,TemperatureUnit>

Parameters:

source - a string to be parsed.

Returns:

a temperature containing a value and unit.

Throws:

ParseException - if provided string cannot be parsed.

UnknownUnitException - if unit cannot be determined.

findUnit

public TemperatureUnit findUnit(String source)

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

Specified by:

findUnit in class MeasureFormatter<Temperature,TemperatureUnit>

Parameters:

source - a measurement string representation.

Returns:

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

formatAndConvert

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

Formats and converts provided temperature 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).

This implementation just formats provided value using provided unit, ignoring provided unit system.

Specified by:

formatAndConvert in class MeasureFormatter<Temperature,TemperatureUnit>

Parameters:

value - a temperature value.

unit - a temperature unit.

system - system unit to convert temperature to.

Returns:

a string representation of temperature value and unit.

getUnitSymbol

public String getUnitSymbol(TemperatureUnit unit)

Returns unit string representation.

Specified by:

getUnitSymbol in class MeasureFormatter<Temperature,TemperatureUnit>

Parameters:

unit - a temperature unit.

Returns:

its string representation.