Package me.datafox.dfxengine.text.api

Interface TextFactory

All Known Implementing Classes:

TextFactoryImpl

public interface TextFactory

A singleton class that generates Strings from Text objects. It manages Names, NameConverters, NumberFormatters, NumberSuffixFacctories, TextConfiguration and the PluralConverter.

Method Summary

Modifier and Type	Method	Description
<T> Name<T>	addName(Name<T> name)
<T> void	addNameConverter(NameConverter<T> converter)
void	addNumberFormatter(NumberFormatter formatter)
void	addNumberSuffixFormatter(NumberSuffixFormatter formatter)	If no default NumberSuffixFormatter is set and this NumberSuffixFormatter can format any number (NumberSuffixFormatter.isInfinite() returns true), it will be set as default.
String	build(List<Text> texts)
String	build(Text text)
<T> Name<T>	createName(T object, String name)	The PluralConverter is used to generate the plural form.
<T> Name<T>	createName(T object, String singular, String plural)
TextConfiguration	getConfiguration()	This method should always return the same TextConfiguration instance.
NumberSuffixFormatter	getDefaultNumberSuffixFormatter()
HandleManager	getHandleManager()
<T> Name<T>	getName(T object)	If a Name associated with the object is present, it is returned.
<T> String	getName(T object, boolean plural)	If a Name associated with the object is present, it is used.
<T> NameConverter<T>	getNameConverter(Class<T> type)
NumberFormatter	getNumberFormatter(Handle handle)
NumberFormatter	getNumberFormatter(TextConfiguration configuration)
NumberSuffixFormatter	getNumberSuffixFormatter(Handle handle)
NumberSuffixFormatter	getNumberSuffixFormatter(TextConfiguration configuration)
PluralConverter	getPluralConverter()
void	setConfiguration(TextConfiguration configuration)	Clears current TextConfiguration and applies the provided one to it.
void	setDefaultNumberSuffixFormatter(NumberSuffixFormatter formatter)	The default NumberSuffixFormatter must be capable of formatting any number (NumberSuffixFormatter.isInfinite() returns true).
void	setPluralConverter(PluralConverter converter)

Method Details

build

String build(Text text)

Parameters:

text - Text object to build

Returns:

String representation of the text

build

String build(List<Text> texts)

Parameters:

texts - Text objects to build

Returns:

String representation of the texts

getHandleManager

HandleManager getHandleManager()

Returns:

HandleManager used by this factory

createName

<T> Name<T> createName(T object,
 String name)

The PluralConverter is used to generate the plural form.

Type Parameters:

T - type of the object

Parameters:

object - object to be named

name - name for the object in singular form

Returns:

Name associated with the object

createName

<T> Name<T> createName(T object,
 String singular,
 String plural)

Type Parameters:

T - type of the object to be named

Parameters:

object - object to be named

singular - name for the object in singular form

plural - name for the object in plural form

Returns:

Name associated with the object

addName

<T> Name<T> addName(Name<T> name)

Type Parameters:

T - type of the object to be named

Parameters:

name - Name object

Returns:

previous Name associated with the owner, or null if no previous mapping is present

getName

<T> Name<T> getName(T object)

If a Name associated with the object is present, it is returned. Otherwise, a new Name is created using NameConverter if a valid one is present or Object.toString() if not. The PluralConverter will be used for the plural form if the NameConverter is not plural capable or not present.

Type Parameters:

T - type of the object to be named

Parameters:

object - object to be named

Returns:

Name associated with the object

getName

<T> String getName(T object,
 boolean plural)

If a Name associated with the object is present, it is used. Otherwise, a new Name is created using NameConverter if a valid one is present or Object.toString() if not. The PluralConverter will be used for the plural form if the NameConverter is not plural capable or not present.

Type Parameters:

T - type of the object to be named

Parameters:

object - object to be named

plural - if true, the plural form is returned

Returns:

name of the object

addNameConverter

<T> void addNameConverter(NameConverter<T> converter)

Type Parameters:

T - type of the object that this NameConverter is capable of converting

Parameters:

converter - NameConverter to be registered

getNameConverter

<T> NameConverter<T> getNameConverter(Class<T> type)

Type Parameters:

T - type of the object to be named

Parameters:

type - Class of the object to be named

Returns:

NameConverter associated with the type or any of its interfaces or superclasses

addNumberFormatter

void addNumberFormatter(NumberFormatter formatter)

Parameters:

formatter - NumberFormatter to be registered

getNumberFormatter

NumberFormatter getNumberFormatter(Handle handle)

Parameters:

handle - Handle of a NumberFormatter

Returns:

NumberFormatter associated with the Handle or null if none is present

getNumberFormatter

NumberFormatter getNumberFormatter(TextConfiguration configuration)

Parameters:

configuration - TextConfiguration to be used

Returns:

NumberFormatter configured in the TextConfiguration or null if none is present

addNumberSuffixFormatter

void addNumberSuffixFormatter(NumberSuffixFormatter formatter)

If no default NumberSuffixFormatter is set and this NumberSuffixFormatter can format any number (NumberSuffixFormatter.isInfinite() returns true), it will be set as default.

Parameters:

formatter - NumberSuffixFormatter to be registered

getNumberSuffixFormatter

NumberSuffixFormatter getNumberSuffixFormatter(Handle handle)

Parameters:

handle - Handle of a NumberSuffixFormatter

Returns:

NumberSuffixFormatter associated with the Handle or null if none is present

getNumberSuffixFormatter

NumberSuffixFormatter getNumberSuffixFormatter(TextConfiguration configuration)

Parameters:

configuration - TextConfiguration to be used

Returns:

NumberSuffixFormatter configured in the TextConfiguration or null if none is present

setDefaultNumberSuffixFormatter

void setDefaultNumberSuffixFormatter(NumberSuffixFormatter formatter)

The default NumberSuffixFormatter must be capable of formatting any number (NumberSuffixFormatter.isInfinite() returns true).

Parameters:

formatter - NumberSuffixFormatter to be set as default

getDefaultNumberSuffixFormatter

NumberSuffixFormatter getDefaultNumberSuffixFormatter()

Returns:

default NumberSuffixFormatter or null if none is present

setConfiguration

void setConfiguration(TextConfiguration configuration)

Clears current TextConfiguration and applies the provided one to it. This method should not overwrite the current TextConfiguration instance and only alter its state.

Parameters:

configuration - TextConfiguration to be applied

getConfiguration

TextConfiguration getConfiguration()

This method should always return the same TextConfiguration instance.

Returns:

current TextConfiguration

setPluralConverter

void setPluralConverter(PluralConverter converter)

Parameters:

converter - PluralConverter to be registered

getPluralConverter

PluralConverter getPluralConverter()

Returns:

registered PluralConverter or null if none is present