TextTemplate (SpongeAPI 7.4.0 API)

java.lang.Object
- org.spongepowered.api.text.TextTemplate

All Implemented Interfaces:

Iterable<Object>, TextElement, TextRepresentable
```
public final class TextTemplate
extends Object
implements TextRepresentable, Iterable<Object>
```
Represents a re-usable template that produces a formatted Text.Builder. Elements will be appended to the result builder in the order that they are specified in of(Object...).

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TextTemplate.Arg
Represents a variable element within a TextTemplate.

Nested Classes
Modifier and Type	Class and Description
`static class`	`TextTemplate.Arg` Represents a variable element within a TextTemplate.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_CLOSE_ARG` Default "close" String for how arguments are contained within the template.
`static String`	`DEFAULT_OPEN_ARG` Default "open" String for how arguments are contained within the template.
`static TextTemplate`	`EMPTY` Empty representation of a `TextTemplate`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Text.Builder`	`apply()` Applies an empty map of parameters to this TextTemplate and returns the result in a `Text.Builder`.
`Text.Builder`	`apply(Map<String,?> params)` Applies the specified parameters to this TextTemplate and returns the result in a `Text.Builder`.
`static TextTemplate.Arg.Builder`	`arg(String name)` Constructs a new `TextTemplate.Arg` to be supplied to `of(Object...)`.
`TextTemplate`	`concat(TextTemplate other)` Concatenates the specified `TextTemplate` to this template and returns the result.
`boolean`	`equals(Object obj)`
`Map<String,TextTemplate.Arg>`	`getArguments()` Returns the arguments contained within the TextTemplate.
`String`	`getCloseArgString()` Returns the string used for containing Args within the template.
`List<Object>`	`getElements()` Returns the elements contained in this TextTemplate.
`String`	`getOpenArgString()` Returns the string used for containing Args within the template.
`int`	`hashCode()`
`Iterator<Object>`	`iterator()`
`static TextTemplate`	`of()` Returns the empty representation of a TextTemplate.
`static TextTemplate`	`of(Object... elements)` Constructs a new TextTemplate for the given elements.
`static TextTemplate`	`of(String openArg, String closeArg, Object[] elements)` Constructs a new TextTemplate for the given elements.
`String`	`toString()`
`Text`	`toText()` Gets the textual representation of this instance for its usage in other `Text` objects.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - DEFAULT_OPEN_ARG
```
public static final String DEFAULT_OPEN_ARG
```
    Default "open" String for how arguments are contained within the template.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CLOSE_ARG
```
public static final String DEFAULT_CLOSE_ARG
```
    Default "close" String for how arguments are contained within the template.
    
    See Also:
    
    Constant Field Values
  - EMPTY
```
public static final TextTemplate EMPTY
```
    Empty representation of a TextTemplate. This is returned if the array supplied to of(Object...) is empty.
- Method Detail
  - getElements
```
public List<Object> getElements()
```
    Returns the elements contained in this TextTemplate.
    
    Returns:
    
    The elements within the template
  - getArguments
```
public Map<String,TextTemplate.Arg> getArguments()
```
    Returns the arguments contained within the TextTemplate.
    
    Returns:
    
    The arguments within this TextTemplate
  - getOpenArgString
```
public String getOpenArgString()
```
    Returns the string used for containing Args within the template.
    
    Returns:
    
    String containing args
  - getCloseArgString
```
public String getCloseArgString()
```
    Returns the string used for containing Args within the template.
    
    Returns:
    
    String containing args
  - concat
```
public TextTemplate concat(TextTemplate other)
```
    Concatenates the specified TextTemplate to this template and returns the result. In the event that the two templates' open/close argument containers vary, this template's argument containers will be used.
    
    Parameters:
    
    other - To concatenate
    
    Returns:
    
    Concatenated template
  - apply
```
public Text.Builder apply()
```
    Applies an empty map of parameters to this TextTemplate and returns the result in a Text.Builder.
    
    Returns:
    
    Text builder containing result
    
    Throws:
    
    TextTemplateArgumentException - if required parameters are missing
  - apply
```
public Text.Builder apply(Map<String,?> params)
```
    Applies the specified parameters to this TextTemplate and returns the result in a Text.Builder.
    
    Parameters:
    
    params - Parameters to apply
    
    Returns:
    
    Text builder containing result
    
    Throws:
    
    TextTemplateArgumentException - if required parameters are missing
  - of
```
public static TextTemplate of(String openArg,
                              String closeArg,
                              Object[] elements)
```
    Constructs a new TextTemplate for the given elements. The order of the elements is the order in which they will be appended to the result builder via apply(Map).
    The provided elements may be of any type.
    
    In the case that an element is a TextElement, TextElement.applyTo(Text.Builder) will be used to append the element to the builder.
    
    In the case that an element is an TextTemplate.Arg the argument will be replaced with the TextElement provided by the corresponding parameter supplied by apply(Map)
    
    In the case that an element is any other type, the parameter value's Object.toString() method will be used to create a Text object.
    
    Parameters:
    
    elements - Elements to append to builder
    
    openArg - String to use for beginning of Arg containers
    
    closeArg - String to use for end of Arg containers
    
    Returns:
    
    Newly constructed TextTemplate
  - of
```
public static TextTemplate of(Object... elements)
```
    Constructs a new TextTemplate for the given elements. The order of the elements is the order in which they will be appended to the result builder via apply(Map).
    The provided elements may be of any type.
    
    In the case that an element is a TextElement, TextElement.applyTo(Text.Builder) will be used to append the element to the builder.
    
    In the case that an element is an TextTemplate.Arg the argument will be replaced with the TextElement provided by the corresponding parameter supplied by apply(Map)
    
    In the case that an element is any other type, the parameter value's Object.toString() method will be used to create a Text object.
    
    Parameters:
    
    elements - Elements to append to builder
    
    Returns:
    
    Newly constructed TextTemplate
  - of
```
public static TextTemplate of()
```
    Returns the empty representation of a TextTemplate.
    
    Returns:
    
    Empty TextTemplate
  - arg
```
public static TextTemplate.Arg.Builder arg(String name)
```
    Constructs a new TextTemplate.Arg to be supplied to of(Object...). This argument expects a TextElement parameter.
    
    Parameters:
    
    name - name of argument
    
    Returns:
    
    argument builder
  - toText
```
public 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
  - iterator
```
public Iterator<Object> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Object>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class TextTemplate

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

Field Detail

DEFAULT_OPEN_ARG

DEFAULT_CLOSE_ARG

EMPTY

Method Detail

getElements

getArguments

getOpenArgString

getCloseArgString

concat

apply

apply

of

of

of

arg

toText

iterator

toString

hashCode

equals