io.github.nucleuspowered.nucleus.api.service

Interface NucleusMessageTokenService.TokenParser

Enclosing interface:

NucleusMessageTokenService

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public static interface NucleusMessageTokenService.TokenParser

A parser for tokens directed at a plugin. Plugins can only register ONE of these.

To understand what is returned to the parser, it's worth reminding the implementor what the token that users will use look like:

{{pl:plugin-id:identifier:s}}

Plugins will only ever see the identifier part of the token. This token can take any form, as chosen by the plugin, except for the }} sequence.

Method Summary

Modifier and Type	Method and Description
Optional<org.spongepowered.api.text.Text>	parse(String tokenInput, org.spongepowered.api.command.CommandSource source, Map<String,Object> variables) Parses a plugin's token and returns Text, if any.

Method Detail

parse

@Nonnull
Optional<org.spongepowered.api.text.Text> parse(String tokenInput,
                                                         org.spongepowered.api.command.CommandSource source,
                                                         Map<String,Object> variables)

Parses a plugin's token and returns Text, if any.

Parameters:

tokenInput - The identifier for the token.

source - The CommandSource that will be viewing the output of this token.

variables - A map of variable names to variable objects. Consult documentation for the variables that might be caused by an event or command.

Returns:

The Text to display, or Optional.empty() if the token cannot be parsed.