Package org.spongepowered.api.placeholder

Interface PlaceholderComponent.Builder

All Superinterfaces:

AbstractBuilder<PlaceholderComponent>, Builder<PlaceholderComponent,PlaceholderComponent.Builder>, ResettableBuilder<PlaceholderComponent,PlaceholderComponent.Builder>

Enclosing interface:

PlaceholderComponent

public static interface PlaceholderComponent.Builder
extends Builder<PlaceholderComponent,PlaceholderComponent.Builder>

A builder for PlaceholderComponent objects.

Method Summary

Modifier and Type	Method	Description
PlaceholderComponent	build()	Builds and returns the placeholder.
PlaceholderComponent.Builder	context(PlaceholderContext context)	Sets the PlaceholderContext that will be provided to the PlaceholderParser to create the Component when ComponentLike.asComponent() ()} is called.
PlaceholderComponent.Builder	parser(PlaceholderParser parser)	Sets the token that represents a PlaceholderParser for use in this PlaceholderComponent.

Methods inherited from interface org.spongepowered.api.util.Builder

reset

Method Details

parser

PlaceholderComponent.Builder parser(PlaceholderParser parser)

Sets the token that represents a PlaceholderParser for use in this PlaceholderComponent.

Parameters:

parser - The PlaceholderParser to use

Returns:

This, for chaining

context

PlaceholderComponent.Builder context(PlaceholderContext context)

Sets the PlaceholderContext that will be provided to the PlaceholderParser to create the Component when ComponentLike.asComponent() ()} is called.

Parameters:

context - The PlaceholderContext to use.

Returns:

This, for chaining

build

PlaceholderComponent build()
                    throws IllegalStateException

Builds and returns the placeholder.

Specified by:

build in interface AbstractBuilder<PlaceholderComponent>

Returns:

The appropriate PlaceholderComponent

Throws:

IllegalStateException - if the builder has not been completed, or the associated PlaceholderParser could not validate the built PlaceholderComponent, if applicable.