Package me.datafox.dfxengine.text.suffix

Class CharDigitSuffixFormatter

java.lang.Object

me.datafox.dfxengine.text.suffix.CharDigitSuffixFormatter

All Implemented Interfaces:

Comparable<Handled>, Handled, NumberSuffixFormatter

public class CharDigitSuffixFormatter
extends Object
implements NumberSuffixFormatter

A NumberSuffixFormatter that generates an exponential suffix in an arbitrary base with an arbitrary set of characters representing digits. The character set can be configured with CHARACTERS, and INTERVAL determines how many powers of ten is required for the exponent to increase. The formatter can also be configured to output a plus sign on positive exponents with EXPONENT_PLUS.

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 char[]	ALPHABET	26 English alphabet in lowercase.
static final ConfigurationKey<char[]>	CHARACTERS	Characters to be used as digits for the exponent.
static final ConfigurationKey<Boolean>	EXPONENT_PLUS	If true, will output a plus sign on positive exponents.
static final ConfigurationKey<Integer>	INTERVAL	Interval for formatted exponents.

Constructor Summary

Constructors

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

ALPHABET

public static final char[] ALPHABET

26 English alphabet in lowercase.

CHARACTERS

public static final ConfigurationKey<char[]> CHARACTERS

Characters to be used as digits for the exponent. The default value is ALPHABET.

INTERVAL

public static final ConfigurationKey<Integer> INTERVAL

Interval for formatted exponents. The default value is 3.

EXPONENT_PLUS

public static final ConfigurationKey<Boolean> EXPONENT_PLUS

If true, will output a plus sign on positive exponents. The default value is false.

Constructor Details

CharDigitSuffixFormatter

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

Throws:

TextConfigurationException - if the TextConfiguration is not valid for this formatter

isInfinite

public boolean isInfinite()

Specified by:

isInfinite in interface NumberSuffixFormatter

Returns:

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