org.spongepowered.api.text

Class TextTemplate.Arg.Builder

java.lang.Object

org.spongepowered.api.text.TextTemplate.Arg.Builder

Enclosing class:

TextTemplate.Arg

public static final class TextTemplate.Arg.Builder
extends Object

Represents a builder for TextTemplate.Args.

Method Summary

Modifier and Type	Method and Description
TextTemplate.Arg	build() Builds a new TextTemplate.Arg.
TextTemplate.Arg.Builder	color(TextColor color) Sets the "base" color of the Arg.
TextTemplate.Arg.Builder	defaultValue(Text defaultValue) Sets the default value for the Argument.
TextTemplate.Arg.Builder	format(TextFormat format) Sets the "base" format of the Arg.
TextTemplate.Arg.Builder	optional() Makes the Arg optional.
TextTemplate.Arg.Builder	optional(boolean optional) Sets whether the Arg should be optional (false by default).
TextTemplate.Arg.Builder	style(TextStyle style) Sets the "base" style of the Arg.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

build

public TextTemplate.Arg build()

Builds a new TextTemplate.Arg. Note that it is not necessary to call this method when supplying an argument to a template. You may pass the builder to TextTemplate.of(Object...) directly.

Returns:

Newly created Arg

optional

public TextTemplate.Arg.Builder optional(boolean optional)

Sets whether the Arg should be optional (false by default).

Parameters:

optional - True if should be optional

Returns:

This builder

optional

public TextTemplate.Arg.Builder optional()

Makes the Arg optional.

Returns:

This builder

defaultValue

public TextTemplate.Arg.Builder defaultValue(Text defaultValue)

Sets the default value for the Argument. The argument must by optional in order for this value to be used.

Parameters:

defaultValue - Default value

Returns:

This builder

format

public TextTemplate.Arg.Builder format(TextFormat format)

Sets the "base" format of the Arg. This acts as a default format when no formatting data is provided by the parameter.

Parameters:

format - Base format of Arg

Returns:

This builder

color

public TextTemplate.Arg.Builder color(TextColor color)

Sets the "base" color of the Arg. This acts as a default color when no color data is provided by the parameter.

Parameters:

color - Base color of Arg

Returns:

This builder

style

public TextTemplate.Arg.Builder style(TextStyle style)

Sets the "base" style of the Arg. This acts as a default style when no style data is provided by the parameter.

Parameters:

style - Base style of Arg

Returns:

This builder

toString

public String toString()

Overrides:

toString in class Object