org.spongepowered.api.text

Class Text.Builder

java.lang.Object

org.spongepowered.api.text.Text.Builder

All Implemented Interfaces:

TextElement, TextRepresentable

Direct Known Subclasses:

LiteralText.Builder, ScoreText.Builder, SelectorText.Builder, TranslatableText.Builder

Enclosing class:

Text

public abstract static class Text.Builder
extends Object
implements TextRepresentable

Represents a builder class to create immutable Text instances.

See Also:

Text

Method Summary

Modifier and Type	Method and Description
Text.Builder	append(Collection<? extends Text> children) Appends the specified Text to the end of this text.
Text.Builder	append(Iterable<? extends Text> children) Appends the specified Text to the end of this text.
Text.Builder	append(Iterator<? extends Text> children) Appends the specified Text to the end of this text.
Text.Builder	append(Text... children) Appends the specified Text to the end of this text.
abstract Text	build() Builds an immutable instance of the current state of this text builder.
Text.Builder	color(TextColor color) Sets the TextColor of this text.
boolean	equals(Object o)
Text.Builder	format(TextFormat format) Sets the TextFormat of this text.
List<Text>	getChildren() Returns a view of the current children of this builder.
Optional<ClickAction<?>>	getClickAction() Returns the current ClickAction of this builder.
TextColor	getColor() Returns the current color of the Text in this builder.
TextFormat	getFormat() Returns the current format of the Text in this builder.
Optional<HoverAction<?>>	getHoverAction() Returns the current HoverAction of this builder.
Optional<ShiftClickAction<?>>	getShiftClickAction() Returns the current ShiftClickAction of this builder.
TextStyle	getStyle() Returns the current style of the Text in this builder.
int	hashCode()
Text.Builder	insert(int pos, Collection<? extends Text> children) Inserts the specified Text at the given position of this builder.
Text.Builder	insert(int pos, Iterable<? extends Text> children) Inserts the specified Text at the given position of this builder.
Text.Builder	insert(int pos, Iterator<? extends Text> children) Inserts the specified Text at the given position of this builder.
Text.Builder	insert(int pos, Text... children) Inserts the specified Text at the given position of this builder.
Text.Builder	onClick(ClickAction<?> clickAction) Sets the ClickAction that will be executed if the text is clicked in the chat.
Text.Builder	onHover(HoverAction<?> hoverAction) Sets the HoverAction that will be executed if the text is hovered in the chat.
Text.Builder	onShiftClick(ShiftClickAction<?> shiftClickAction) Sets the ShiftClickAction that will be executed if the text is shift-clicked in the chat.
Text.Builder	remove(Collection<? extends Text> children) Removes the specified Text from this builder.
Text.Builder	remove(int index) Removes the child at the given index.
Text.Builder	remove(Iterable<? extends Text> children) Removes the specified Text from this builder.
Text.Builder	remove(Iterator<? extends Text> children) Removes the specified Text from this builder.
Text.Builder	remove(Text... children) Removes the specified Text from this builder.
Text.Builder	removeAll() Removes all children from this builder.
Text.Builder	removeLastChild() Removes the last child in this builder.
Text.Builder	style(TextStyle... styles) Sets the text styles of this text.
String	toString()
Text	toText() Gets the textual representation of this instance for its usage in other Text objects.
Text.Builder	trim() Removes all empty texts from the beginning and end of this builder.

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

getFormat

public final TextFormat getFormat()

Returns the current format of the Text in this builder.

Returns:

The current format

See Also:

Text.getFormat()

format

public Text.Builder format(TextFormat format)

Sets the TextFormat of this text.

Parameters:

format - The new text format for this text

Returns:

The text builder

See Also:

Text.getFormat()

getColor

public final TextColor getColor()

Returns the current color of the Text in this builder.

Returns:

The current color

See Also:

Text.getColor()

color

public Text.Builder color(TextColor color)

Sets the TextColor of this text.

Parameters:

color - The new text color for this text

Returns:

This text builder

See Also:

Text.getColor()

getStyle

public final TextStyle getStyle()

Returns the current style of the Text in this builder.

Returns:

The current style

See Also:

Text.getStyle()

style

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

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.

Parameters:

styles - The text styles to apply

Returns:

This text builder

See Also:

Text.getStyle()

getClickAction

public final Optional<ClickAction<?>> getClickAction()

Returns the current ClickAction of this builder.

Returns:

The current click action or Optional.empty() if none

See Also:

Text.getClickAction()

onClick

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

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

Parameters:

clickAction - The new click action for the text

Returns:

This text builder

See Also:

Text.getClickAction()

getHoverAction

public final Optional<HoverAction<?>> getHoverAction()

Returns the current HoverAction of this builder.

Returns:

The current hover action or Optional.empty() if none

See Also:

Text.getHoverAction()

onHover

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

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

Parameters:

hoverAction - The new hover action for the text

Returns:

This text builder

See Also:

Text.getHoverAction()

getShiftClickAction

public final Optional<ShiftClickAction<?>> getShiftClickAction()

Returns the current ShiftClickAction of this builder.

Returns:

The current shift click action or Optional.empty() if none

See Also:

Text.getShiftClickAction()

onShiftClick

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

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

Parameters:

shiftClickAction - The new shift click action for the text

Returns:

This text builder

See Also:

Text.getShiftClickAction()

getChildren

public final List<Text> getChildren()

Returns a view of the current children of this builder.

The returned list is unmodifiable, but not immutable. It will change if new children get added through this builder.

Returns:

An unmodifiable list of the current children

See Also:

Text.getChildren()

append

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

Appends the specified Text to the end of this text.

Parameters:

children - The texts to append

Returns:

This text builder

See Also:

Text.getChildren()

append

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

Appends the specified Text to the end of this text.

Parameters:

children - The texts to append

Returns:

This text builder

See Also:

Text.getChildren()

append

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

Appends the specified Text to the end of this text.

Parameters:

children - The texts to append

Returns:

This text builder

See Also:

Text.getChildren()

append

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

Appends the specified Text to the end of this text.

Parameters:

children - The texts to append

Returns:

This text builder

See Also:

Text.getChildren()

insert

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

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

Parameters:

pos - The position to insert the texts to

children - The texts to insert

Returns:

This text builder

Throws:

IndexOutOfBoundsException - If the position is out of bounds

See Also:

Text.getChildren()

insert

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

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

Parameters:

pos - The position to insert the texts to

children - The texts to insert

Returns:

This text builder

Throws:

IndexOutOfBoundsException - If the position is out of range

See Also:

Text.getChildren()

insert

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

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

Parameters:

pos - The position to insert the texts to

children - The texts to insert

Returns:

This text builder

Throws:

IndexOutOfBoundsException - If the position is out of range

See Also:

Text.getChildren()

insert

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

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

Parameters:

pos - The position to insert the texts to

children - The texts to insert

Returns:

This text builder

Throws:

IndexOutOfBoundsException - If the position is out of range

See Also:

Text.getChildren()

removeLastChild

public Text.Builder removeLastChild()

Removes the last child in this builder.

Returns:

This text builder

See Also:

remove(int)

remove

public Text.Builder remove(int index)

Removes the child at the given index.

Parameters:

index - The index of the child

Returns:

This text builder

Throws:

IndexOutOfBoundsException - if the given index is out of bounds

remove

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

Removes the specified Text from this builder.

Parameters:

children - The texts to remove

Returns:

This text builder

See Also:

Text.getChildren()

remove

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

Removes the specified Text from this builder.

Parameters:

children - The texts to remove

Returns:

This text builder

See Also:

Text.getChildren()

remove

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

Removes the specified Text from this builder.

Parameters:

children - The texts to remove

Returns:

This text builder

See Also:

Text.getChildren()

remove

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

Removes the specified Text from this builder.

Parameters:

children - The texts to remove

Returns:

This text builder

See Also:

Text.getChildren()

removeAll

public Text.Builder removeAll()

Removes all children from this builder.

Returns:

This text builder

See Also:

Text.getChildren()

trim

public Text.Builder trim()

Removes all empty texts from the beginning and end of this builder.

Returns:

This builder

build

public abstract Text build()

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

Returns:

An immutable Text with the current properties of this builder

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public final String toString()

Overrides:

toString in class Object

toText

public final Text toText()

Description copied from interface: TextRepresentable

Gets the textual representation of this instance for its usage in other Text objects. This may but does not need to include hover texts or other actions. This method is basically the toString() equivalent for Texts.

Specified by:

toText in interface TextRepresentable

Returns:

The text instance representing this instance