Package me.datafox.dfxengine.text.api

Interface NumberSuffixFormatter

All Superinterfaces:

Comparable<Handled>, Handled

All Known Implementing Classes:

CharDigitSuffixFormatter, ExponentSuffixFormatter, NamedSuffixFormatter

public interface NumberSuffixFormatter
extends Handled

A formatter that scales a BigDecimal number and assigns it a suffix.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	NumberSuffixFormatter.Output	Data class containing the output of a NumberSuffixFormatter.

Method Summary

Modifier and Type	Method	Description
NumberSuffixFormatter.Output	format(BigDecimal number, TextFactory factory, TextConfiguration configuration)
boolean	isInfinite()

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

compareTo, getHandle

Method Details

format

NumberSuffixFormatter.Output format(BigDecimal number,
 TextFactory factory,
 TextConfiguration configuration)

Parameters:

number - number to format

factory - TextFactory for formatting

configuration - TextConfiguration for formatting

Returns:

NumberSuffixFormatter.Output containing the scaled number and a suffix, or the NumberSuffixFormatter.Output of TextFactory.getDefaultNumberSuffixFormatter() if the number cannot be formatted by this formatter

Throws:

TextConfigurationException - if the TextConfiguration is not valid for this formatter

isInfinite

boolean isInfinite()

Returns:

true if this formatter can format any BigDecimal number