• Home
• me.datafox.dfxengine
• text-api
• 1.0.0
• source code
• Text.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

package me.datafox.dfxengine.text.api;

import me.datafox.dfxengine.text.api.exception.TextConfigurationException;

/**
 * A {@link String} generation interface. {@link #get(TextFactory, TextConfiguration)} should use the provided
 * {@link TextConfiguration} and not {@link TextFactory#getConfiguration()}. The reference to {@link TextFactory} is
 * provided for access to objects like {@link Name Names} and {@link NumberFormatter NumberFormatters}.
 *
 * @author datafox
 */
@FunctionalInterface
public interface Text {
    /**
     * Implementation should use the provided {@link TextConfiguration} and not {@link TextFactory#getConfiguration()}.
     * The reference to {@link TextFactory} is provided for access to objects like {@link Name Names} and
     * {@link NumberFormatter NumberFormatters}.
     *
     * @param factory {@link TextFactory} for generation
     * @param configuration {@link TextConfiguration} for generation
     * @return generated {@link String}
     *
     * @throws TextConfigurationException if the {@link TextConfiguration} is not valid for this text
     */
    String get(TextFactory factory, TextConfiguration configuration);
}