Class TextArgumentFactory

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.text.TextArgumentFactory

public final class TextArgumentFactory
extends Object

Contains some quality-of-life features to aid the creation of new TextArguments.

Constructor Summary

Constructors

Constructor	Description
TextArgumentFactory(ITextComponentFactory textComponentFactory, @Nullable PersonalizedLocalizer personalizedLocalizer)

Method Summary

Modifier and Type	Method	Description
TextArgument	clickable(Object argument, String command)	Shortcut for creating a new TextArgument with a TextComponent for a clickable argument without any information for the TextType.CLICKABLE text type.
TextArgument	clickable(Object argument, String command, @Nullable String info)	Shortcut for creating a new TextArgument with a TextComponent for a clickable argument for the TextType.CLICKABLE text type.
TextArgument	clickable(Object argument, @Nullable TextType type, String command)	Shortcut for creating a new TextArgument with a TextComponent for a clickable argument without any information.
TextArgument	clickable(Object argument, @Nullable TextType type, String command, @Nullable String info)	Shortcut for creating a new TextArgument with a TextComponent for a clickable argument.
TextArgument	error(@Nullable Object argument)	Shortcut for creating a new TextArgument with a TextComponent for the TextType.ERROR text type.
ITextComponentFactory	getTextComponentFactory()
TextArgument	highlight(@Nullable Object argument)	Shortcut for creating a new TextArgument with a TextComponent for the TextType.HIGHLIGHT text type.
TextArgument	info(@Nullable Object argument)	Shortcut for creating a new TextArgument with a TextComponent for the TextType.INFO text type.
String	localized(String key)	Localizes the provided key using the PersonalizedLocalizer of this factory.
TextArgument	localizedHighlight(String key)	Shortcut for localizing a String using localized(String) and creating a new TextArgument with a TextComponent for the TextType.HIGHLIGHT text type.
TextArgument	localizedHighlight(IStructureConst structure)	Shortcut for localizing a structure type using localized(String) and creating a new TextArgument with a TextComponent for the TextType.HIGHLIGHT text type.
TextArgument	localizedHighlight(StructureType structureType)	Shortcut for localizing a structure type using localized(String) and creating a new TextArgument with a TextComponent for the TextType.HIGHLIGHT text type.
TextArgument	localizedInfo(String key)	Shortcut for localizing a String using localized(String) and creating a new TextArgument with a TextComponent for the TextType.INFO text type.
TextArgument	localizedInfo(IStructureConst structure)	Shortcut for localizing a structure type using localized(String) and creating a new TextArgument with a TextComponent for the TextType.INFO text type.
TextArgument	localizedInfo(StructureType structureType)	Shortcut for localizing a structure type using localized(String) and creating a new TextArgument with a TextComponent for the TextType.INFO text type.
TextArgument	newTextArgument(@Nullable Object argument, @Nullable TextType type)	Shortcut for creating a new TextArgument with a TextComponent for the provided text type.
TextArgument	success(@Nullable Object argument)	Shortcut for creating a new TextArgument with a TextComponent for the TextType.SUCCESS text type.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TextArgumentFactory

public TextArgumentFactory(ITextComponentFactory textComponentFactory,
 @Nullable PersonalizedLocalizer personalizedLocalizer)

Method Details

localized

public String localized(String key)

Localizes the provided key using the PersonalizedLocalizer of this factory.

Parameters:

key - The key to localize.

Returns:

The localized key or the key itself if the localizer is null.

newTextArgument

public TextArgument newTextArgument(@Nullable Object argument,
 @Nullable TextType type)

Shortcut for creating a new TextArgument with a TextComponent for the provided text type.

See ITextComponentFactory.newComponent(TextType).

Parameters:

argument - The argument.

type - The text type to use for the argument.

Returns:

The new TextArgument.

highlight

public TextArgument highlight(@Nullable Object argument)

Shortcut for creating a new TextArgument with a TextComponent for the TextType.HIGHLIGHT text type.

See ITextComponentFactory.newComponent(TextType).

Parameters:

argument - The argument.

Returns:

The new TextArgument.

localizedHighlight

public TextArgument localizedHighlight(String key)

Shortcut for localizing a String using localized(String) and creating a new TextArgument with a TextComponent for the TextType.HIGHLIGHT text type.

Parameters:

key - The key to localize and whose value to highlight.

Returns:

The new TextArgument.

localizedHighlight

public TextArgument localizedHighlight(StructureType structureType)

Shortcut for localizing a structure type using localized(String) and creating a new TextArgument with a TextComponent for the TextType.HIGHLIGHT text type.

Parameters:

structureType - The structure type to localize and highlight.

Returns:

The new TextArgument.

localizedHighlight

public TextArgument localizedHighlight(IStructureConst structure)

Shortcut for localizing a structure type using localized(String) and creating a new TextArgument with a TextComponent for the TextType.HIGHLIGHT text type.

Parameters:

structure - The structure whose type to localize and highlight.

Returns:

The new TextArgument.

info

public TextArgument info(@Nullable Object argument)

Shortcut for creating a new TextArgument with a TextComponent for the TextType.INFO text type.

See ITextComponentFactory.newComponent(TextType).

Parameters:

argument - The argument.

Returns:

The new TextArgument.

localizedInfo

public TextArgument localizedInfo(String key)

Shortcut for localizing a String using localized(String) and creating a new TextArgument with a TextComponent for the TextType.INFO text type.

Parameters:

key - The key to localize and whose value to info.

Returns:

The new TextArgument.

localizedInfo

public TextArgument localizedInfo(StructureType structureType)

Shortcut for localizing a structure type using localized(String) and creating a new TextArgument with a TextComponent for the TextType.INFO text type.

Parameters:

structureType - The structure type to localize and info.

Returns:

The new TextArgument.

localizedInfo

public TextArgument localizedInfo(IStructureConst structure)

Shortcut for localizing a structure type using localized(String) and creating a new TextArgument with a TextComponent for the TextType.INFO text type.

Parameters:

structure - The structure whose type to localize and info.

Returns:

The new TextArgument.

error

public TextArgument error(@Nullable Object argument)

Shortcut for creating a new TextArgument with a TextComponent for the TextType.ERROR text type.

See ITextComponentFactory.newComponent(TextType).

Parameters:

argument - The argument.

Returns:

The new TextArgument.

success

public TextArgument success(@Nullable Object argument)

Shortcut for creating a new TextArgument with a TextComponent for the TextType.SUCCESS text type.

See ITextComponentFactory.newComponent(TextType).

Parameters:

argument - The argument.

Returns:

The new TextArgument.

clickable

public TextArgument clickable(Object argument,
 @Nullable TextType type,
 String command,
 @Nullable String info)

Shortcut for creating a new TextArgument with a TextComponent for a clickable argument.

See ITextComponentFactory.newClickableTextComponent(TextType, String, String).

Parameters:

argument - The argument.

type - The type of the text.

command - The command to execute when this text is clicked.

info - The optional information String explaining what clicking the text will do.

Returns:

The new TextArgument.

clickable

public TextArgument clickable(Object argument,
 @Nullable TextType type,
 String command)

Shortcut for creating a new TextArgument with a TextComponent for a clickable argument without any information.

See ITextComponentFactory.newClickableTextComponent(TextType, String, String).

Parameters:

argument - The argument.

type - The type of the text.

command - The command to execute when this text is clicked.

Returns:

The new TextArgument.

clickable

public TextArgument clickable(Object argument,
 String command,
 @Nullable String info)

Shortcut for creating a new TextArgument with a TextComponent for a clickable argument for the TextType.CLICKABLE text type.

See ITextComponentFactory.newClickableTextComponent(TextType, String, String).

Parameters:

argument - The argument.

command - The command to execute when this text is clicked.

info - The optional information String explaining what clicking the text will do.

Returns:

The new TextArgument.

clickable

public TextArgument clickable(Object argument,
 String command)

Shortcut for creating a new TextArgument with a TextComponent for a clickable argument without any information for the TextType.CLICKABLE text type.

See ITextComponentFactory.newClickableTextComponent(TextType, String, String).

Parameters:

argument - The argument.

command - The command to execute when this text is clicked.

Returns:

The new TextArgument.

getTextComponentFactory

public ITextComponentFactory getTextComponentFactory()