Package org.spongepowered.api.placeholder

Interface PlaceholderParser

All Superinterfaces:

DefaultedRegistryValue<PlaceholderParser>

@CatalogedBy(PlaceholderParsers.class)
public interface PlaceholderParser
extends DefaultedRegistryValue<PlaceholderParser>

Provides the logic of how to parse a placeholder token.

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface org.spongepowered.api.registry.DefaultedRegistryValue

asDefaultedReference, findKey, key

Method Details

builder

static PlaceholderParser.Builder builder()

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

Returns:

The PlaceholderParser.Builder

parse

Component parse(PlaceholderContext placeholderContext)

Creates a Component based on the provided PlaceholderContext.

This method should not throw an error, instead returning Component.empty() if the supplied PlaceholderContext is not valid.

Parameters:

placeholderContext - The PlaceholderContext

Returns:

The Component