Package me.datafox.dfxengine.text.suffix

Class ExponentSuffixFormatter

java.lang.Object

me.datafox.dfxengine.text.suffix.ExponentSuffixFormatter

All Implemented Interfaces:

Comparable<Handled>, Handled, NumberSuffixFormatter

public class ExponentSuffixFormatter
extends Object
implements NumberSuffixFormatter

A NumberSuffixFormatter that generates a traditional exponential notation suffix. Supports formatting in scientific or engineering notation, or have any other interval that the exponents snaps to multiples of, configured with INTERVAL. The returned format has a lowercase e, and can be configured to output a plus 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 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
ExponentSuffixFormatter(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

INTERVAL

public static final ConfigurationKey<Integer> INTERVAL

Interval for formatted exponents. 1 is equivalent to scientific notation and 3 is equivalent to engineering notation. The default value is 1.

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

ExponentSuffixFormatter

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