Package me.datafox.dfxengine.text.formatter

Class SimpleNumberFormatter

java.lang.Object

me.datafox.dfxengine.text.formatter.SimpleNumberFormatter

All Implemented Interfaces:

Comparable<Handled>, Handled, NumberFormatter

public class SimpleNumberFormatter
extends Object
implements NumberFormatter

A NumberFormatter that formats a number in a natural form. The precision of the number can be configured with PRECISION, and the minimum absolute exponent when a NumberSuffixFormatter will be used can be configured with MIN_EXPONENT. The minimum exponent must be smaller than or equal to the precision. Any trailing zeros in the decimal part of the number can be stripped, configured by STRIP_ZEROS.

Field Summary

Fields

Modifier and Type	Field	Description
static final ConfigurationKey<Integer>	MIN_EXPONENT	Minimum absolute exponent to be formatted with a suffix.
static final ConfigurationKey<Integer>	PRECISION	Precision, equivalent to MathContext.getPrecision().
static final ConfigurationKey<Boolean>	STRIP_ZEROS	If true, the number will be stripped of any trailing zeros in the decimal part of the number before formatting.

Constructor Summary

Constructors

Constructor	Description
SimpleNumberFormatter(org.slf4j.Logger logger, TextHandles handles)

Method Summary

Modifier and Type	Method	Description
String	format(BigDecimal number, TextFactory factory, TextConfiguration configuration)

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.datafox.dfxengine.handles.api.Handled

compareTo, getHandle

Field Details

PRECISION

public static final ConfigurationKey<Integer> PRECISION

Precision, equivalent to MathContext.getPrecision(). The default value is 6.

MIN_EXPONENT

public static final ConfigurationKey<Integer> MIN_EXPONENT

Minimum absolute exponent to be formatted with a suffix. It must be smaller than or equal to PRECISION. The default value is 3.

STRIP_ZEROS

public static final ConfigurationKey<Boolean> STRIP_ZEROS

If true, the number will be stripped of any trailing zeros in the decimal part of the number before formatting. The default value is true.

Constructor Details

SimpleNumberFormatter

public SimpleNumberFormatter(org.slf4j.Logger logger,
 TextHandles handles)

Parameters:

logger - Logger for this formatter

handles - TextHandles to be used for this formatter's Handle

Method Details

format

public String format(BigDecimal number,
 TextFactory factory,
 TextConfiguration configuration)

Specified by:

format in interface NumberFormatter

Parameters:

number - number to be formatter

factory - TextFactory for formatting

configuration - TextConfiguration for formatting

Returns:

String representation of the number

Throws:

TextConfigurationException - if the TextConfiguration is not valid for this formatter