Package me.datafox.dfxengine.text.suffix

Class NamedSuffixFormatter

java.lang.Object

me.datafox.dfxengine.text.suffix.NamedSuffixFormatter

All Implemented Interfaces:

Comparable<Handled>, Handled, NumberSuffixFormatter

public class NamedSuffixFormatter
extends Object
implements NumberSuffixFormatter

A NumberSuffixFormatter that generates a suffix based on an array of suffixes and an interval, configured with SUFFIXES and INTERVAL. The suffix with an index of the exponent scale of the number divided by the interval will be used. If the exponent scale is negative or the calculated index is out of bounds, the number is instead formatted with TextFactory.getDefaultNumberSuffixFormatter(). All provided preset suffixes (SI, SHORT and LONG use the default interval of 3. This class is designed to be used with the Injector.

Nested Class Summary

Nested classes/interfaces inherited from interface me.datafox.dfxengine.text.api.NumberSuffixFormatter

NumberSuffixFormatter.Output

Field Summary

Fields

Modifier and Type	Field	Description
static final ConfigurationKey<Integer>	INTERVAL	Interval to be used between suffixes.
static final String[]	LONG	Array of abbreviated names of the long scale powers of 3 to be used as number suffixes.
static final String[]	SHORT	Array of abbreviated names of the short scale powers of 3 to be used as number suffixes.
static final String[]	SI	Array of SI unit prefixes to be used as number suffixes.
static final ConfigurationKey<String[]>	SUFFIXES	Array of suffixes to be used.

Constructor Summary

Constructors

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

Method Summary

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

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

SI

public static final String[] SI

Array of SI unit prefixes to be used as number suffixes.

SHORT

public static final String[] SHORT

Array of abbreviated names of the short scale powers of 3 to be used as number suffixes.

LONG

public static final String[] LONG

Array of abbreviated names of the long scale powers of 3 to be used as number suffixes.

SUFFIXES

public static final ConfigurationKey<String[]> SUFFIXES

Array of suffixes to be used. The default value is SHORT.

INTERVAL

public static final ConfigurationKey<Integer> INTERVAL

Interval to be used between suffixes. The default value is 3.

Constructor Details

NamedSuffixFormatter

public NamedSuffixFormatter(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 NumberSuffixFormatter.Output format(BigDecimal number,
 TextFactory factory,
 TextConfiguration configuration)

Specified by:

format in interface NumberSuffixFormatter

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

isInfinite

public boolean isInfinite()

Specified by:

isInfinite in interface NumberSuffixFormatter

Returns:

true if this formatter can format any BigDecimal number. Always returns false