Package nl.pim16aap2.animatedarchitecture.core.text

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)

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.
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 java.lang.Object

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

Constructor Details

TextArgumentFactory

public TextArgumentFactory(ITextComponentFactory textComponentFactory)

Method Details

newTextArgument

public TextArgument newTextArgument(@Nullable
 @Nullable Object argument,
 @Nullable
 @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
 @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.

info

public TextArgument info(@Nullable
 @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.

error

public TextArgument error(@Nullable
 @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
 @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
 @Nullable TextType type,
 String command,
 @Nullable
 @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
 @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
 @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()