org.spongepowered.api.text.transform

Interface TextTemplateApplier

All Superinterfaces:

TextElement, TextRepresentable

All Known Implementing Classes:

MessageEvent.DefaultBodyApplier, MessageEvent.DefaultHeaderApplier, SimpleTextTemplateApplier

public interface TextTemplateApplier
extends TextRepresentable

Wrapper class to hold TextTemplate parameters and a TextTemplate.

Method Summary

Modifier and Type	Method and Description
default TextElement	getParameter(String key) Returns the current value of the parameter with the specified key.
ImmutableMap<String,TextElement>	getParameters() Returns an ImmutableList of this applier's parameters.
TextTemplate	getTemplate() Returns the current TextTemplate for this applier.
void	setParameter(String key, TextElement value) Sets the value of the specified parameter key within this applier.
void	setTemplate(TextTemplate template) Sets the TextTemplate to use for this applier.
default Text	toText() Gets the textual representation of this instance for its usage in other Text objects.

Methods inherited from interface org.spongepowered.api.text.TextRepresentable

applyTo

Method Detail

getParameters

ImmutableMap<String,TextElement> getParameters()

Returns an ImmutableList of this applier's parameters.

Returns:

Applier parameters

getParameter

default TextElement getParameter(String key)

Returns the current value of the parameter with the specified key.

Parameters:

key - Parameter key

Returns:

Parameter value

setParameter

void setParameter(String key,
                  @Nullable
                  TextElement value)

Sets the value of the specified parameter key within this applier.

Parameters:

key - Parameter key

value - Parameter value

getTemplate

TextTemplate getTemplate()

Returns the current TextTemplate for this applier.

Returns:

TextTemplate

setTemplate

void setTemplate(TextTemplate template)

Sets the TextTemplate to use for this applier.

Parameters:

template - TextTemplate to use

toText

default Text toText()

Description copied from interface: TextRepresentable

Gets the textual representation of this instance for its usage in other Text objects. This may but does not need to include hover texts or other actions. This method is basically the toString() equivalent for Texts.

Specified by:

toText in interface TextRepresentable

Returns:

The text instance representing this instance