org.spongepowered.api.text.placeholder

Interface PlaceholderText.Builder

All Superinterfaces:

ResettableBuilder<PlaceholderText,PlaceholderText.Builder>

Enclosing interface:

PlaceholderText

public static interface PlaceholderText.Builder
extends ResettableBuilder<PlaceholderText,PlaceholderText.Builder>

A builder for PlaceholderText objects.

Method Summary

Modifier and Type	Method and Description
PlaceholderText	build() Builds and returns the placeholder.
PlaceholderText.Builder	setContext(PlaceholderContext context) Sets the PlaceholderContext that will be provided to the PlaceholderParser to create the Text when TextRepresentable.toText() is called.
PlaceholderText.Builder	setParser(PlaceholderParser parser) Sets the token that represents a PlaceholderParser for use in this PlaceholderText.

Methods inherited from interface org.spongepowered.api.util.ResettableBuilder

from, reset

Method Detail

setParser

PlaceholderText.Builder setParser(PlaceholderParser parser)

Sets the token that represents a PlaceholderParser for use in this PlaceholderText.

Parameters:

parser - The PlaceholderParser to use

Returns:

This, for chaining

setContext

PlaceholderText.Builder setContext(PlaceholderContext context)

Sets the PlaceholderContext that will be provided to the PlaceholderParser to create the Text when TextRepresentable.toText() is called.

Parameters:

context - The PlaceholderContext to use.

Returns:

This, for chaining

build

PlaceholderText build()
               throws IllegalStateException

Builds and returns the placeholder.

Returns:

The appropriate PlaceholderText

Throws:

IllegalStateException - if the builder has not been completed, or the associated PlaceholderParser could not validate the built PlaceholderText, if applicable.