Package me.datafox.dfxengine.text.api

Interface NumberFormatter

All Superinterfaces:

Comparable<Handled>, Handled

All Known Implementing Classes:

EvenLengthNumberFormatter, SimpleNumberFormatter, SplittingNumberFormatter

public interface NumberFormatter
extends Handled

A formatter that formats a BigDecimal number to a String. Should generally use the configured NumberSuffixFormatter for the operation.

Method Summary

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

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

compareTo, getHandle

Method Details

format

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

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