eu.fthevenet.util.text

Class PrefixFormatter

java.lang.Object

eu.fthevenet.util.text.PrefixFormatter

Direct Known Subclasses:

BinaryPrefixFormatter, MetricPrefixFormatter

public abstract class PrefixFormatter
extends java.lang.Object

This class provides the interface and base implementation for formatting double or long into string with a unit prefix.

Author:

Frederic Thevenet

Field Summary

Fields

Modifier and Type	Field and Description
protected int	base
static java.lang.String	PATTERN

Constructor Summary

Constructors

Constructor and Description
PrefixFormatter(int base, java.lang.String[] suffixes) Initializes a new instance of PrefixFormatter with the arithmetical base and a representation of the prefixes.

Method Summary

Modifier and Type	Method and Description
java.lang.String	format(double value) Formats a double as a string with a unit prefix
java.lang.String	format(long value) Formats a long as a string with a unit prefix

Methods inherited from class java.lang.Object

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

Field Detail

PATTERN

public static final java.lang.String PATTERN

See Also:

Constant Field Values

base

protected final int base

Constructor Detail

PrefixFormatter

public PrefixFormatter(int base,
                       java.lang.String[] suffixes)

Initializes a new instance of PrefixFormatter with the arithmetical base and a representation of the prefixes.

Parameters:

base - the arithmetical base for the unit

suffixes - a representation of the unit prefixes

Method Detail

format

public java.lang.String format(long value)

Formats a long as a string with a unit prefix

Parameters:

value - the value to format

Returns:

the formatted string

format

public java.lang.String format(double value)

Formats a double as a string with a unit prefix

Parameters:

value - the value to format

Returns:

the formatted string