Package me.datafox.dfxengine.text.formatter

Class EvenLengthNumberFormatter

java.lang.Object

me.datafox.dfxengine.text.formatter.EvenLengthNumberFormatter

All Implemented Interfaces:

Comparable<Handled>, Handled, NumberFormatter

public class EvenLengthNumberFormatter
extends Object
implements NumberFormatter

A NumberFormatter that formats a number in a natural form and ensures that every output is no longer than an arbitrary number of characters, configured with LENGTH, 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 length. The output can be configured to be padded with zeros to keep all outputs at the same length with PAD_ZEROS. If an output of the desired length cannot be produced, the output will be longer and a warning will be logged.

Field Summary

Fields

Modifier and Type	Field	Description
static final ConfigurationKey<Integer>	LENGTH	Number of characters in the output.
static final ConfigurationKey<Integer>	MIN_EXPONENT	Minimum absolute exponent to be formatted with a suffix.
static final ConfigurationKey<Boolean>	PAD_ZEROS	If true, the number will be padded with zeros to keep the length of all numbers the same.

Constructor Summary

Constructors

Constructor	Description
EvenLengthNumberFormatter(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

LENGTH

public static final ConfigurationKey<Integer> LENGTH

Number of characters in the output. It is recommended to use a value of at least 7. The default value is 8.

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 LENGTH. The default value is 3.

PAD_ZEROS

public static final ConfigurationKey<Boolean> PAD_ZEROS

If true, the number will be padded with zeros to keep the length of all numbers the same. Otherwise, the output may be shorter than the configured length. The default value is true.

Constructor Details

EvenLengthNumberFormatter

public EvenLengthNumberFormatter(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