org.rhq.core.clientapi.util.units

Class SimpleFormatter

java.lang.Object

org.rhq.core.clientapi.util.units.SimpleFormatter

All Implemented Interfaces:

Formatter

Direct Known Subclasses:

NoFormatter, PercentageFormatter

public abstract class SimpleFormatter
extends Object
implements Formatter

Constructor Summary

Constructors

Constructor and Description
SimpleFormatter()

Method Summary

Methods

Modifier and Type	Method and Description
FormattedNumber	format(UnitNumber val, Locale locale, FormatSpecifics specifics) Format a number with the given locale.
protected abstract FormattedNumber	formatNumber(double rawValue, NumberFormat fmt)
FormattedNumber[]	formatSame(double[] vals, UnitsConstants unitType, ScaleConstants scale, Locale locale, FormatSpecifics specifics) Format a several values at once into the same format.
BigDecimal	getBaseValue(double value, ScaleConstants scale) Get the base value of a value, given its scale.
protected NumberFormat	getNumberFormat(Locale locale)
BigDecimal	getScaledValue(BigDecimal value, ScaleConstants targScale) Get a scaled version of a value.
protected abstract ScaleConstants	getUnitScale()
protected abstract UnitsConstants	getUnitType()
UnitNumber	parse(String val, Locale locale, ParseSpecifics specifics) Parse a string into a UnitNumber.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleFormatter

public SimpleFormatter()

Method Detail

getUnitType

protected abstract UnitsConstants getUnitType()

getUnitScale

protected abstract ScaleConstants getUnitScale()

format

public FormattedNumber format(UnitNumber val,
                     Locale locale,
                     FormatSpecifics specifics)

Description copied from interface: Formatter

Format a number with the given locale.

Specified by:

format in interface Formatter

Parameters:

val - Value to format

locale - Locale that the resultant format should be in

specifics - Optional format to give specific hints to the formatter about how the result should look.

formatSame

public FormattedNumber[] formatSame(double[] vals,
                           UnitsConstants unitType,
                           ScaleConstants scale,
                           Locale locale,
                           FormatSpecifics specifics)

Description copied from interface: Formatter

Format a several values at once into the same format. I.e. no matter the discrepency of range, they all contain the same units (megabytes, etc.)

Specified by:

formatSame in interface Formatter

Parameters:

vals - Values to format

unitType - One of UnitsConstants.UNIT_*

scale - One of UnitsConstants.SCALE_*

locale - Locale that the resultant format should be in

specifics - Optional format to give specific hints to the formatter about how the result should look.

formatNumber

protected abstract FormattedNumber formatNumber(double rawValue,
                           NumberFormat fmt)

getNumberFormat

protected NumberFormat getNumberFormat(Locale locale)

getBaseValue

public BigDecimal getBaseValue(double value,
                      ScaleConstants scale)

Description copied from interface: Formatter

Get the base value of a value, given its scale. E.x.: getBaseValue(1, SCALE_KILO) -> 1024 (bytes being the base unit)

Specified by:

getBaseValue in interface Formatter

Parameters:

value - Value to get the base of

scale - Scale of the value -- must be valid for the formatter unit type

getScaledValue

public BigDecimal getScaledValue(BigDecimal value,
                        ScaleConstants targScale)

Description copied from interface: Formatter

Get a scaled version of a value. The value in its base format, and the target scale are passed. The return value will be a number, scaled to the target. E.x.: getScaledValue(1024, SCALE_NONE) -> 1024 getScaledValue(1024, SCALE_KILO) -> 1 (1 kilobyte)

Specified by:

getScaledValue in interface Formatter

Parameters:

value - Value to scale

targScale - Target scale -- must be valid for the formatter unit type

parse

public UnitNumber parse(String val,
               Locale locale,
               ParseSpecifics specifics)
                 throws ParseException

Description copied from interface: Formatter

Parse a string into a UnitNumber. E.x. parse("34 MB") -> UnitNumber(34, UNIT_BYTES, SCALE_MEGA)

Specified by:

parse in interface Formatter

Parameters:

val - Value to parse

locale - Locale to parse with

specifics - An optional argument which gives the parser more information about parsing

Returns:

the number representing the parsed value

Throws:

ParseException - if the value could not be parsed