PlaceholderComponent (SpongeAPI 8.2.0 API)

All Superinterfaces:

ComponentLike
```
public interface PlaceholderComponent
extends ComponentLike
```
A ComponentLike that can be used in Component building methods that represents a placeholder in text.
A PlaceholderComponent is the collection of a PlaceholderParser along with contextual data in the supplied PlaceholderContext, enabling its use in a Component object.

Such placeholders will generally be built from tokenized strings, however these objects make no assumption about the format of text templating. Such a system can therefore be used by other templating engines without conforming to a particular standard.

The PlaceholderContext is fixed when this object is created, but PlaceholderParser.parse(PlaceholderContext) is not called until asComponent() is called. Thus, any Component object that is created will reflect the time that the Component object was requested, and not when this object itself was created. It therefore follows that implementations must not cache the result of asComponent() unless it is known that the supplied parser is not sensitive to the time of invocation.

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface PlaceholderComponent.Builder
A builder for PlaceholderComponent objects.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default @NonNull Component`	`asComponent()`	Creates a `Component` from the supplied `PlaceholderParser` in the context of the supplied `PlaceholderContext`.
`static PlaceholderComponent.Builder`	`builder()`	Gets a builder for creating `PlaceholderComponent`.
`PlaceholderContext`	`context()`	Gets the `PlaceholderContext` that is to be supplied to the `PlaceholderParser` to create the `Component`.
`PlaceholderParser`	`parser()`	Gets the `PlaceholderParser` that handles this placeholder.

- Method Detail
  - builder
```
static PlaceholderComponent.Builder builder()
```
    Gets a builder for creating PlaceholderComponent.
    
    Returns:
    
    A PlaceholderComponent.Builder
  - context
```
PlaceholderContext context()
```
    Gets the PlaceholderContext that is to be supplied to the PlaceholderParser to create the Component.
    
    Returns:
    
    The PlaceholderContext
  - parser
```
PlaceholderParser parser()
```
    Gets the PlaceholderParser that handles this placeholder.
    
    Returns:
    
    The PlaceholderParser
  - asComponent
```
default @NonNull Component asComponent()
```
    Creates a Component from the supplied PlaceholderParser in the context of the supplied PlaceholderContext.
    This will always return a Component object, however, if the parser could not handle the provided context, this will be Component.empty().
    
    Specified by:
    
    asComponent in interface ComponentLike
    
    Returns:
    
    The parsed Component