com.pcauto.util
Class TemperatureFormat

java.lang.Object
  java.text.Format
      com.pcauto.util.QuantityFormat
          com.pcauto.util.TemperatureFormat

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class TemperatureFormat

extends QuantityFormat

TemperatureFormat provides several mechanisms to use Temperature objects:

to display temperature values in dynamically selected units

to create and load values into Temperature objects

Locale based constructors use a default scale of 2. The parse and format methods are used to generate and format Temperature objects respectively.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class java.text.Format

java.text.Format.Field

Field Summary

Fields inherited from class com.pcauto.util.QuantityFormat

groupingUsed, scale, units

Constructor Summary

TemperatureFormat()
Creates new TemperatureFormat instance based on default Locale.

TemperatureFormat(java.util.Locale loc)
Creates new TemperatureFormat instance based on supplied Locale

TemperatureFormat(TemperatureUnits units, int scale)
Constructs new TemperatureFormat with units set to int units and scale set to int scale.

Method Summary

java.lang.Object	clone() Creates new TemperatureFormat object based on this TemperatureFormat.
java.lang.StringBuffer	format(java.lang.Object obj, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos) Returns StringBuffer with supplied Temperature quantity formatted in units.
java.lang.String	formatTemperature(Temperature tp) Returns String with supplied Temperature quantity formatted in units.
TemperatureUnits	getUnits() Gets value for measurement unit.
java.lang.Object	parseObject(java.lang.String source, java.text.ParsePosition pos) Parses String based on units to return a Temperature object.
Temperature	parseTemperature(java.lang.String value) Parses String based on units to return a Temperature object.
void	setUnits(TemperatureUnits units) Sets value for measurement units.

Methods inherited from class com.pcauto.util.QuantityFormat

getScale, isGroupingUsed, setGroupingUsed, setScale

Methods inherited from class java.text.Format

format, formatToCharacterIterator, parseObject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TemperatureFormat

public TemperatureFormat()

Creates new TemperatureFormat instance based on default Locale.

TemperatureFormat

public TemperatureFormat(java.util.Locale loc)

Creates new TemperatureFormat instance based on supplied Locale

Parameters:

loc - Locale to set correct temperature units

TemperatureFormat

public TemperatureFormat(TemperatureUnits units,
                         int scale)

Constructs new TemperatureFormat with units set to int units and scale set to int scale.

Method Detail

formatTemperature

public java.lang.String formatTemperature(Temperature tp)

Returns String with supplied Temperature quantity formatted in units.

Parameters:

tp - Temperature object from which to format value

Returns:

String temperature in current units

format

public java.lang.StringBuffer format(java.lang.Object obj,
                                     java.lang.StringBuffer toAppendTo,
                                     java.text.FieldPosition pos)

Returns StringBuffer with supplied Temperature quantity formatted in units.

Parameters:

obj - Temperature object from which to format value

Returns:

StringBuffer temperature in current units

parseTemperature

public Temperature parseTemperature(java.lang.String value)

Parses String based on units to return a Temperature object.

Parameters:

value - String to be converted to Temperature object

Returns:

Temperature holding a value specified in input String

parseObject

public java.lang.Object parseObject(java.lang.String source,
                                    java.text.ParsePosition pos)

Parses String based on units to return a Temperature object.

Parameters:

pos - ParsePosition ignored in this implementation

Returns:

Temperature holding a value specified in input String

Throws:

NumberFormatException - on non-numeric String input

clone

public java.lang.Object clone()

Creates new TemperatureFormat object based on this TemperatureFormat.

Returns:

new TemperatureFormat object

setUnits

public void setUnits(TemperatureUnits units)

Sets value for measurement units.

getUnits

public TemperatureUnits getUnits()

Gets value for measurement unit.

Returns:

TemperatureUnits value of current measurement units