PlaceholderParser (SpongeAPI 8.1.0 API)

All Superinterfaces:: DefaultedRegistryValue

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

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

All Methods Static Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`static PlaceholderParser.Builder`	`builder()`	Returns a `PlaceholderParser.Builder` that allows for the creation of simple `PlaceholderParser`s.
`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 Detail
  - 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