org.spongepowered.api.text

Class LiteralText.Builder

java.lang.Object

org.spongepowered.api.text.Text.Builder

org.spongepowered.api.text.LiteralText.Builder

All Implemented Interfaces:

TextElement, TextRepresentable

Enclosing class:

LiteralText

public static class LiteralText.Builder
extends Text.Builder

Represents a Text.Builder creating immutable LiteralText instances.

See Also:

LiteralText

Method Summary

Modifier and Type	Method and Description
LiteralText.Builder	append(Collection<? extends Text> children) Appends the specified Text to the end of this text.
LiteralText.Builder	append(Iterable<? extends Text> children) Appends the specified Text to the end of this text.
LiteralText.Builder	append(Iterator<? extends Text> children) Appends the specified Text to the end of this text.
LiteralText.Builder	append(Text... children) Appends the specified Text to the end of this text.
LiteralText	build() Builds an immutable instance of the current state of this text builder.
LiteralText.Builder	color(TextColor color) Sets the TextColor of this text.
LiteralText.Builder	content(String content) Sets the plain text content of this text.
boolean	equals(Object o)
LiteralText.Builder	format(TextFormat format) Sets the TextFormat of this text.
String	getContent() Returns the current content of this builder.
int	hashCode()
LiteralText.Builder	insert(int pos, Collection<? extends Text> children) Inserts the specified Text at the given position of this builder.
LiteralText.Builder	insert(int pos, Iterable<? extends Text> children) Inserts the specified Text at the given position of this builder.
LiteralText.Builder	insert(int pos, Iterator<? extends Text> children) Inserts the specified Text at the given position of this builder.
LiteralText.Builder	insert(int pos, Text... children) Inserts the specified Text at the given position of this builder.
LiteralText.Builder	onClick(ClickAction<?> clickAction) Sets the ClickAction that will be executed if the text is clicked in the chat.
LiteralText.Builder	onHover(HoverAction<?> hoverAction) Sets the HoverAction that will be executed if the text is hovered in the chat.
LiteralText.Builder	onShiftClick(ShiftClickAction<?> shiftClickAction) Sets the ShiftClickAction that will be executed if the text is shift-clicked in the chat.
LiteralText.Builder	remove(Collection<? extends Text> children) Removes the specified Text from this builder.
LiteralText.Builder	remove(Iterable<? extends Text> children) Removes the specified Text from this builder.
LiteralText.Builder	remove(Iterator<? extends Text> children) Removes the specified Text from this builder.
LiteralText.Builder	remove(Text... children) Removes the specified Text from this builder.
LiteralText.Builder	removeAll() Removes all children from this builder.
LiteralText.Builder	style(TextStyle... styles) Sets the text styles of this text.

Methods inherited from class org.spongepowered.api.text.Text.Builder

getChildren, getClickAction, getColor, getFormat, getHoverAction, getShiftClickAction, getStyle, remove, removeLastChild, toString, toText, trim

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.spongepowered.api.text.TextRepresentable

applyTo

Method Detail

getContent

public final String getContent()

Returns the current content of this builder.

Returns:

The current content

See Also:

LiteralText.getContent()

content

public LiteralText.Builder content(String content)

Sets the plain text content of this text.

Parameters:

content - The content of this text

Returns:

This text builder

See Also:

LiteralText.getContent()

build

public LiteralText build()

Description copied from class: Text.Builder

Builds an immutable instance of the current state of this text builder.

Specified by:

build in class Text.Builder

Returns:

An immutable Text with the current properties of this builder

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class Text.Builder

hashCode

public int hashCode()

Overrides:

hashCode in class Text.Builder

format

public LiteralText.Builder format(TextFormat format)

Description copied from class: Text.Builder

Sets the TextFormat of this text.

Overrides:

format in class Text.Builder

Parameters:

format - The new text format for this text

Returns:

The text builder

See Also:

Text.getFormat()

color

public LiteralText.Builder color(TextColor color)

Description copied from class: Text.Builder

Sets the TextColor of this text.

Overrides:

color in class Text.Builder

Parameters:

color - The new text color for this text

Returns:

This text builder

See Also:

Text.getColor()

style

public LiteralText.Builder style(TextStyle... styles)

Description copied from class: Text.Builder

Sets the text styles of this text. This will construct a composite TextStyle of the current style and the specified styles first and set it to the text.

Overrides:

style in class Text.Builder

Parameters:

styles - The text styles to apply

Returns:

This text builder

See Also:

Text.getStyle()

onClick

public LiteralText.Builder onClick(@Nullable
                                   ClickAction<?> clickAction)

Description copied from class: Text.Builder

Sets the ClickAction that will be executed if the text is clicked in the chat.

Overrides:

onClick in class Text.Builder

Parameters:

clickAction - The new click action for the text

Returns:

This text builder

See Also:

Text.getClickAction()

onHover

public LiteralText.Builder onHover(@Nullable
                                   HoverAction<?> hoverAction)

Description copied from class: Text.Builder

Sets the HoverAction that will be executed if the text is hovered in the chat.

Overrides:

onHover in class Text.Builder

Parameters:

hoverAction - The new hover action for the text

Returns:

This text builder

See Also:

Text.getHoverAction()

onShiftClick

public LiteralText.Builder onShiftClick(@Nullable
                                        ShiftClickAction<?> shiftClickAction)

Description copied from class: Text.Builder

Sets the ShiftClickAction that will be executed if the text is shift-clicked in the chat.

Overrides:

onShiftClick in class Text.Builder

Parameters:

shiftClickAction - The new shift click action for the text

Returns:

This text builder

See Also:

Text.getShiftClickAction()

append

public LiteralText.Builder append(Text... children)

Description copied from class: Text.Builder

Appends the specified Text to the end of this text.

Overrides:

append in class Text.Builder

Parameters:

children - The texts to append

Returns:

This text builder

See Also:

Text.getChildren()

append

public LiteralText.Builder append(Collection<? extends Text> children)

Description copied from class: Text.Builder

Appends the specified Text to the end of this text.

Overrides:

append in class Text.Builder

Parameters:

children - The texts to append

Returns:

This text builder

See Also:

Text.getChildren()

append

public LiteralText.Builder append(Iterable<? extends Text> children)

Description copied from class: Text.Builder

Appends the specified Text to the end of this text.

Overrides:

append in class Text.Builder

Parameters:

children - The texts to append

Returns:

This text builder

See Also:

Text.getChildren()

append

public LiteralText.Builder append(Iterator<? extends Text> children)

Description copied from class: Text.Builder

Appends the specified Text to the end of this text.

Overrides:

append in class Text.Builder

Parameters:

children - The texts to append

Returns:

This text builder

See Also:

Text.getChildren()

insert

public LiteralText.Builder insert(int pos,
                                  Text... children)

Description copied from class: Text.Builder

Inserts the specified Text at the given position of this builder.

Overrides:

insert in class Text.Builder

Parameters:

pos - The position to insert the texts to

children - The texts to insert

Returns:

This text builder

See Also:

Text.getChildren()

insert

public LiteralText.Builder insert(int pos,
                                  Collection<? extends Text> children)

Description copied from class: Text.Builder

Inserts the specified Text at the given position of this builder.

Overrides:

insert in class Text.Builder

Parameters:

pos - The position to insert the texts to

children - The texts to insert

Returns:

This text builder

See Also:

Text.getChildren()

insert

public LiteralText.Builder insert(int pos,
                                  Iterable<? extends Text> children)

Description copied from class: Text.Builder

Inserts the specified Text at the given position of this builder.

Overrides:

insert in class Text.Builder

Parameters:

pos - The position to insert the texts to

children - The texts to insert

Returns:

This text builder

See Also:

Text.getChildren()

insert

public LiteralText.Builder insert(int pos,
                                  Iterator<? extends Text> children)

Description copied from class: Text.Builder

Inserts the specified Text at the given position of this builder.

Overrides:

insert in class Text.Builder

Parameters:

pos - The position to insert the texts to

children - The texts to insert

Returns:

This text builder

See Also:

Text.getChildren()

remove

public LiteralText.Builder remove(Text... children)

Description copied from class: Text.Builder

Removes the specified Text from this builder.

Overrides:

remove in class Text.Builder

Parameters:

children - The texts to remove

Returns:

This text builder

See Also:

Text.getChildren()

remove

public LiteralText.Builder remove(Collection<? extends Text> children)

Description copied from class: Text.Builder

Removes the specified Text from this builder.

Overrides:

remove in class Text.Builder

Parameters:

children - The texts to remove

Returns:

This text builder

See Also:

Text.getChildren()

remove

public LiteralText.Builder remove(Iterable<? extends Text> children)

Description copied from class: Text.Builder

Removes the specified Text from this builder.

Overrides:

remove in class Text.Builder

Parameters:

children - The texts to remove

Returns:

This text builder

See Also:

Text.getChildren()

remove

public LiteralText.Builder remove(Iterator<? extends Text> children)

Description copied from class: Text.Builder

Removes the specified Text from this builder.

Overrides:

remove in class Text.Builder

Parameters:

children - The texts to remove

Returns:

This text builder

See Also:

Text.getChildren()

removeAll

public LiteralText.Builder removeAll()

Description copied from class: Text.Builder

Removes all children from this builder.

Overrides:

removeAll in class Text.Builder

Returns:

This text builder

See Also:

Text.getChildren()