me.datafox.dfxengine.text.api.NumberSuffixFormatter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of text-api Show documentation

API for DFXEngine Text

There is a newer version: 1.0.2

package me.datafox.dfxengine.text.api;

import lombok.Data;
import me.datafox.dfxengine.handles.api.Handled;
import me.datafox.dfxengine.text.api.exception.TextConfigurationException;

import java.math.BigDecimal;

/**
 * A formatter that scales a {@link BigDecimal} number and assigns it a suffix.
 *
 * @author datafox
 */
public interface NumberSuffixFormatter extends Handled {
    /**
     * @param number number to format
     * @param factory {@link TextFactory} for formatting
     * @param configuration {@link TextConfiguration} for formatting
     * @return {@link Output} containing the scaled number and a suffix, or the {@link Output} of
     * {@link TextFactory#getDefaultNumberSuffixFormatter()} if the number cannot be formatted by this formatter
     *
     * @throws TextConfigurationException if the {@link TextConfiguration} is not valid for this formatter
     */
    Output format(BigDecimal number, TextFactory factory, TextConfiguration configuration);

    /**
     * @return {@code true} if this formatter can format any {@link BigDecimal} number
     */
    boolean isInfinite();

    /**
     * Data class containing the output of a {@link NumberSuffixFormatter}.
     */
    @Data
    final class Output {
        /**
         * Scaled number.
         */
        private final BigDecimal scaled;

        /**
         * Suffix for the number.
         */
        private final String suffix;
    }
}