Package org.spongepowered.api.placeholder

Interface PlaceholderContext.Builder

All Superinterfaces:

AbstractBuilder<PlaceholderContext>, Buildable.Builder<PlaceholderContext>, Builder<PlaceholderContext,PlaceholderContext.Builder>, ResettableBuilder<PlaceholderContext,PlaceholderContext.Builder>

Enclosing interface:

PlaceholderContext

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

A builder for PlaceholderComponent objects.

Method Summary

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

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

reset

Method Detail

associatedObject

default PlaceholderContext.Builder associatedObject(Player player)

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

Parameters:

player - The player to associate this text with.

Returns:

This, for chaining

See Also:

PlaceholderContext.associatedObject()

associatedObject

PlaceholderContext.Builder associatedObject(@Nullable java.lang.Object object)

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

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

If supplying a Player, use associatedObject(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.associatedObject()

associatedObject

PlaceholderContext.Builder associatedObject(@Nullable java.util.function.Supplier<java.lang.Object> supplier)

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

Parameters:

supplier - A Supplier that provides the Object

Returns:

This, for chaining

See Also:

PlaceholderContext.associatedObject()

argumentString

PlaceholderContext.Builder argumentString(@Nullable java.lang.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.argumentString()

build

PlaceholderContext build()
                  throws java.lang.IllegalStateException

Builds and returns the placeholder.

Specified by:

build in interface AbstractBuilder<PlaceholderContext>

Specified by:

build in interface Buildable.Builder<PlaceholderContext>

Returns:

The appropriate PlaceholderComponent

Throws:

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