org.spongepowered.api.text.placeholder

Interface PlaceholderParser

All Superinterfaces:

CatalogType

@CatalogedBy(value=PlaceholderParsers.class)
public interface PlaceholderParser
extends CatalogType

Provides the logic of how to parse a placeholder token.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PlaceholderParser.Builder A builder that creates PlaceholderParser

Method Summary

Modifier and Type	Method and Description
static PlaceholderParser.Builder	builder() Returns a PlaceholderParser.Builder that allows for the creation of simple PlaceholderParsers.
Text	parse(PlaceholderContext placeholderContext) Creates a Text based on the provided PlaceholderContext.

Methods inherited from interface org.spongepowered.api.CatalogType

getId, getName

Method Detail

builder

static PlaceholderParser.Builder builder()

Returns a PlaceholderParser.Builder that allows for the creation of simple PlaceholderParsers.

Returns:

The PlaceholderParser.Builder

parse

Text parse(PlaceholderContext placeholderContext)

Creates a Text based on the provided PlaceholderContext.

This method should not throw an error, instead returning Text.EMPTY if the supplied PlaceholderContext is not valid.

Parameters:

placeholderContext - The PlaceholderContext

Returns:

The Text