org.spongepowered.api.text.placeholder

Interface PlaceholderContext.Builder

All Superinterfaces:

ResettableBuilder<PlaceholderContext,PlaceholderContext.Builder>

Enclosing interface:

PlaceholderContext

public static interface PlaceholderContext.Builder
extends ResettableBuilder<PlaceholderContext,PlaceholderContext.Builder>

A builder for PlaceholderText objects.

Method Summary

Modifier and Type	Method and Description
PlaceholderContext	build() Builds and returns the placeholder.
PlaceholderContext.Builder	setArgumentString(@Nullable String string) Sets a string that represents variables for the supplied token.
PlaceholderContext.Builder	setAssociatedObject(@Nullable Object object) Sets the Object to use as a source of information for this PlaceholderText.
default PlaceholderContext.Builder	setAssociatedObject(Player player) Sets the Object to use as a source of information for this PlaceholderText to the supplied Player.
PlaceholderContext.Builder	setAssociatedObject(@Nullable Supplier<Object> supplier) Sets the Object to use as a source of information for this PlaceholderText.

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

from, reset

Method Detail

setAssociatedObject

default PlaceholderContext.Builder setAssociatedObject(Player player)

Sets the Object to use as a source of information for this PlaceholderText to the supplied Player.

Parameters:

player - The player to associate this text with.

Returns:

This, for chaining

See Also:

PlaceholderContext.getAssociatedObject()

setAssociatedObject

PlaceholderContext.Builder setAssociatedObject(@Nullable Object object)

Sets the Object to use as a source of information for this PlaceholderText. If null, removes this source.

If you are intending to keep the associated PlaceholderText for any period of time and that you wish to associate a game object with the placeholder, use setAssociatedObject(Supplier) instead, supplying a function that can recreate the object if necessary.

If supplying a Player, use setAssociatedObject(Player), which will handle creating the correct supplier for you.

Parameters:

object - The Object to associate this text with.

Returns:

This, for chaining

See Also:

PlaceholderContext.getAssociatedObject()

setAssociatedObject

PlaceholderContext.Builder setAssociatedObject(@Nullable Supplier<Object> supplier)

Sets the Object to use as a source of information for this PlaceholderText. If null, removes this source.

Parameters:

supplier - A Supplier that provides the Object

Returns:

This, for chaining

See Also:

PlaceholderContext.getAssociatedObject()

setArgumentString

PlaceholderContext.Builder setArgumentString(@Nullable String string)

Sets a string that represents variables for the supplied token. The format of this argument string is dependent on the parser that consumes this string and thus is not prescribed here.

Parameters:

string - The argument string, may be null to reset to the default argument string

Returns:

This, for chaining

See Also:

PlaceholderContext.getArgumentString()

build

PlaceholderContext build()
                  throws IllegalStateException

Builds and returns the placeholder.

Returns:

The appropriate PlaceholderText

Throws:

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