org.spongepowered.api.text.transform

Class SimpleTextTemplateApplier

java.lang.Object

org.spongepowered.api.text.transform.SimpleTextTemplateApplier

All Implemented Interfaces:

TextElement, TextRepresentable, TextTemplateApplier

Direct Known Subclasses:

MessageEvent.DefaultBodyApplier, MessageEvent.DefaultHeaderApplier

public class SimpleTextTemplateApplier
extends Object
implements TextTemplateApplier

A basic implementation of TextTemplateApplier backed by a HashMap and an empty TextTemplate by default.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,TextElement>	params
protected TextTemplate	template

Constructor Summary

Constructors

Constructor and Description
SimpleTextTemplateApplier() Creates a new SimpleTextTemplateApplier with an empty TextTemplate.
SimpleTextTemplateApplier(TextTemplate template) Creates a new SimpleTextTemplateApplier with the provided TextTemplate.

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.spongepowered.api.text.transform.TextTemplateApplier

getParameter, toText

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

applyTo

Field Detail

params

protected final Map<String,TextElement> params

template

protected TextTemplate template

Constructor Detail

SimpleTextTemplateApplier

public SimpleTextTemplateApplier(TextTemplate template)

Creates a new SimpleTextTemplateApplier with the provided TextTemplate.

Parameters:

template - The template to use

SimpleTextTemplateApplier

public SimpleTextTemplateApplier()

Creates a new SimpleTextTemplateApplier with an empty TextTemplate.

Method Detail

getParameters

public ImmutableMap<String,TextElement> getParameters()

Description copied from interface: TextTemplateApplier

Returns an ImmutableList of this applier's parameters.

Specified by:

getParameters in interface TextTemplateApplier

Returns:

Applier parameters

setParameter

public void setParameter(String key,
                         TextElement value)

Description copied from interface: TextTemplateApplier

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

Specified by:

setParameter in interface TextTemplateApplier

Parameters:

key - Parameter key

value - Parameter value

getTemplate

public TextTemplate getTemplate()

Description copied from interface: TextTemplateApplier

Returns the current TextTemplate for this applier.

Specified by:

getTemplate in interface TextTemplateApplier

Returns:

TextTemplate

setTemplate

public void setTemplate(TextTemplate template)

Description copied from interface: TextTemplateApplier

Sets the TextTemplate to use for this applier.

Specified by:

setTemplate in interface TextTemplateApplier

Parameters:

template - TextTemplate to use