Package me.datafox.dfxengine.text.api

Interface Text

All Known Implementing Classes:

AbstractText, ChainedText, ConfigurationText, NameText, NumberText, NumeralText, StaticText, ValueText

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Text

A String generation interface. get(TextFactory, TextConfiguration) should use the provided TextConfiguration and not TextFactory.getConfiguration(). The reference to TextFactory is provided for access to objects like Names and NumberFormatters.

Method Summary

Modifier and Type	Method	Description
String	get(TextFactory factory, TextConfiguration configuration)	Implementation should use the provided TextConfiguration and not TextFactory.getConfiguration().

Method Details

get

String get(TextFactory factory,
 TextConfiguration configuration)

Implementation should use the provided TextConfiguration and not TextFactory.getConfiguration(). The reference to TextFactory is provided for access to objects like Names and NumberFormatters.

Parameters:

factory - TextFactory for generation

configuration - TextConfiguration for generation

Returns:

generated String

Throws:

TextConfigurationException - if the TextConfiguration is not valid for this text