org.spongepowered.api.text.placeholder

Interface PlaceholderParser.Builder

All Superinterfaces:

ResettableBuilder<PlaceholderParser,PlaceholderParser.Builder>

Enclosing interface:

PlaceholderParser

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

A builder that creates PlaceholderParser

Method Summary

Modifier and Type	Method and Description
PlaceholderParser	build() Builds a PlaceholderParser
PlaceholderParser.Builder	id(String id) The un-namespaced ID of the parser.
PlaceholderParser.Builder	name(String name) The human friendly name of this parser
PlaceholderParser.Builder	parser(Function<PlaceholderContext,Text> parser) The function that converts a PlaceholderContext to Text
PlaceholderParser.Builder	plugin(Object plugin) The plugin instance or PluginContainer that this parser is being provided by.

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

from, reset

Method Detail

plugin

PlaceholderParser.Builder plugin(Object plugin)

The plugin instance or PluginContainer that this parser is being provided by.

Parameters:

plugin - The plugin or PluginContainer

Returns:

This builder, for chaining

id

PlaceholderParser.Builder id(String id)

The un-namespaced ID of the parser.

This will reject any ID that contains a colon.

Parameters:

id - The un-namespaced ID

Returns:

This builder, for chaining

name

PlaceholderParser.Builder name(String name)

The human friendly name of this parser

Parameters:

name - The name

Returns:

This builder, for chaining

parser

PlaceholderParser.Builder parser(Function<PlaceholderContext,Text> parser)

The function that converts a PlaceholderContext to Text

Parameters:

parser - The function

Returns:

This builder, for chaining

build

PlaceholderParser build()
                 throws IllegalStateException

Builds a PlaceholderParser

Returns:

The parser

Throws:

IllegalStateException - if the plugin, ID or parser has not been has not been specified.