Package me.datafox.dfxengine.text.formatter

Class SplittingNumberFormatter

java.lang.Object

me.datafox.dfxengine.text.formatter.SplittingNumberFormatter

All Implemented Interfaces:

Comparable<Handled>, Handled, NumberFormatter

public class SplittingNumberFormatter
extends Object
implements NumberFormatter

A NumberFormatter that splits a number into multiple parts in order of magnitude and outputs them in a list. The most common use case is formatting a period of time. A SplittingNumberFormatter.Split consists of a BigDecimal multiplier and a singular and plural forms of a suffix. Splits are stored in an array and configured with SPLITS. The array must have the splits in ascending order based on the multiplier, and the first split is recommended (but not required) to be BigDecimal.ONE.

Each part of the output will be formatted by a different NumberFormatter which can be configured with FORMATTER. The least significant part of the output can be in decimal form or rounded down, configured with ROUND_SMALLEST. When formatting the parts either ConfigurationKeys.DELIMITER, or ConfigurationKeys.LIST_DELIMITER and ConfigurationKeys.LIST_LAST_DELIMITER can be used, configured with USE_LIST_DELIMITER.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SplittingNumberFormatter.Split	Defines a single part to be used with SplittingNumberFormatter.

Field Summary

Fields

Modifier and Type	Field	Description
static final ConfigurationKey<Handle>	FORMATTER	Handle of the NumberFormatter to be used for the splits.
static final ConfigurationKey<Boolean>	ROUND_SMALLEST	If true, the last split will be rounded down.
static final ConfigurationKey<SplittingNumberFormatter.Split[]>	SPLITS	Splits to be used.
static final SplittingNumberFormatter.Split[]	TIME_LONG	Array of Splits for formatting time with singular and plural names of different units of time, from seconds to years.
static final SplittingNumberFormatter.Split[]	TIME_SHORT	Array of Splits for formatting time with abbreviations of different units of time, from seconds to years.
static final ConfigurationKey<Boolean>	USE_LIST_DELIMITER	If true, ConfigurationKeys.LIST_DELIMITER and ConfigurationKeys.LIST_LAST_DELIMITER will be used instead of ConfigurationKeys.DELIMITER.

Constructor Summary

Constructors

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

Method Summary

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

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

TIME_SHORT

public static final SplittingNumberFormatter.Split[] TIME_SHORT

Array of Splits for formatting time with abbreviations of different units of time, from seconds to years. A month is assumed to be 30 days and a year is assumed to be 365 days.

TIME_LONG

public static final SplittingNumberFormatter.Split[] TIME_LONG

Array of Splits for formatting time with singular and plural names of different units of time, from seconds to years. A month is assumed to be 30 days and a year is assumed to be 365 days.

SPLITS

public static final ConfigurationKey<SplittingNumberFormatter.Split[]> SPLITS

Splits to be used. The elements must be in ascending order by the multiplier, and the first element is recommended to be BigDecimal.ONE. The default value is TIME_LONG.

FORMATTER

public static final ConfigurationKey<Handle> FORMATTER

Handle of the NumberFormatter to be used for the splits. The default value is Handled.getHandle().

ROUND_SMALLEST

public static final ConfigurationKey<Boolean> ROUND_SMALLEST

If true, the last split will be rounded down. The default value is true.

USE_LIST_DELIMITER

public static final ConfigurationKey<Boolean> USE_LIST_DELIMITER

If true, ConfigurationKeys.LIST_DELIMITER and ConfigurationKeys.LIST_LAST_DELIMITER will be used instead of ConfigurationKeys.DELIMITER. The default value is true.

Constructor Details

SplittingNumberFormatter

public SplittingNumberFormatter(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 String format(BigDecimal number,
 TextFactory factory,
 TextConfiguration configuration)

Specified by:

format in interface NumberFormatter

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