Text (SpongeAPI 7.4.0 API)

java.lang.Object
- org.spongepowered.api.text.Text

All Implemented Interfaces:

Comparable<Text>, DataSerializable, TextElement, TextRepresentable

Direct Known Subclasses:

LiteralText, ScoreText, SelectorText, TranslatableText
```
public abstract class Text
extends Object
implements TextRepresentable, DataSerializable, Comparable<Text>
```
Represents an immutable tree-structure of formatted (text) components. Each instance consists of content and a list of children texts appended after the content of this text. The content of the text is available through one of the subclasses.
Text is primarily used for sending formatted chat messages to players, but also in other places like books or signs.

Text instances can be created through the available of() methods or using one of the Text.Builders available through one of the builder() methods.

See Also:

builder(), Text.Builder, LiteralText, TranslatableText, SelectorText, ScoreText

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Text.Builder
Represents a builder class to create immutable Text instances.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Text.Builder` Represents a builder class to create immutable `Text` instances.

Field Summary

Fields
Modifier and Type	Field and Description
`static Text`	`EMPTY` The empty, unformatted `Text` instance.
`static LiteralText`	`NEW_LINE` An unformatted `Text` that will start a new line (if supported).
`static Comparator<Text>`	`PLAIN_COMPARATOR` A `Comparator` for texts that compares the plain text of two text instances.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static Text.Builder`	`builder()` Creates a `Text.Builder` with empty text.
`static LiteralText.Builder`	`builder(char content)` Creates a new unformatted `LiteralText.Builder` with the specified content.
`static ScoreText.Builder`	`builder(Score score)` Creates a new unformatted `ScoreText.Builder` with the given score.
`static SelectorText.Builder`	`builder(Selector selector)` Creates a new unformatted `SelectorText.Builder` with the given selector.
`static LiteralText.Builder`	`builder(String content)` Creates a new unformatted `LiteralText.Builder` with the specified content.
`static ScoreText.Builder`	`builder(Text text, Score score)` Creates a new `ScoreText.Builder` with the formatting and actions of the specified `Text` and the given score.
`static SelectorText.Builder`	`builder(Text text, Selector selector)` Creates a new `SelectorText.Builder` with the formatting and actions of the specified `Text` and the given selector.
`static LiteralText.Builder`	`builder(Text text, String content)` Creates a new `LiteralText.Builder` with the formatting and actions of the specified `Text` and the given content.
`static TranslatableText.Builder`	`builder(Text text, Translatable translatable, Object... args)` Creates a new `TranslatableText.Builder` with the formatting and actions of the specified `Text` and the given `Translatable`.
`static TranslatableText.Builder`	`builder(Text text, Translation translation, Object... args)` Creates a new `TranslatableText.Builder` with the formatting and actions of the specified `Text` and the given `Translation` and arguments.
`static TranslatableText.Builder`	`builder(Translatable translatable, Object... args)` Creates a new unformatted `TranslatableText.Builder` from the given `Translatable`.
`static TranslatableText.Builder`	`builder(Translation translation, Object... args)` Creates a new unformatted `TranslatableText.Builder` with the given `Translation` and arguments.
`int`	`compareTo(Text o)`
`Text`	`concat(Text other)` Concatenates the specified `Text` to this Text and returns the result.
`boolean`	`equals(Object o)`
`ImmutableList<Text>`	`getChildren()` Returns the immutable list of children appended after the content of this `Text`.
`Optional<ClickAction<?>>`	`getClickAction()` Returns the `ClickAction` executed on the client when this `Text` gets clicked.
`TextColor`	`getColor()` Returns the color of this `Text`.
`int`	`getContentVersion()` Gets the content version of this `DataSerializable`.
`TextFormat`	`getFormat()` Returns the format of this `Text`.
`Optional<HoverAction<?>>`	`getHoverAction()` Returns the `HoverAction` executed on the client when this `Text` gets hovered.
`Optional<ShiftClickAction<?>>`	`getShiftClickAction()` Returns the `ShiftClickAction` executed on the client when this `Text` gets shift-clicked.
`TextStyle`	`getStyle()` Returns the style of this `Text`.
`int`	`hashCode()`
`boolean`	`isEmpty()` Returns whether this `Text` is empty.
`static Text`	`join(Iterable<? extends Text> texts)` Joins a sequence of text objects together.
`static Text`	`join(Iterator<? extends Text> texts)` Joins a sequence of text objects together.
`static Text`	`join(Text... texts)` Joins a sequence of text objects together.
`static Text`	`joinWith(Text separator, Iterable<? extends Text> texts)` Joins a sequence of text objects together along with a separator.
`static Text`	`joinWith(Text separator, Iterator<? extends Text> texts)` Joins a sequence of text objects together along with a separator.
`static Text`	`joinWith(Text separator, Text... texts)` Joins a sequence of text objects together along with a separator.
`static Text`	`of()` Returns an empty, unformatted `Text` instance.
`static LiteralText`	`of(char content)` Creates a `Text` with the specified char as plain text.
`static Text`	`of(Object... objects)` Builds a `Text` from a given array of objects.
`static ScoreText`	`of(Score score)` Creates a new unformatted `ScoreText` with the given score.
`static SelectorText`	`of(Selector selector)` Creates a new unformatted `SelectorText` with the given selector.
`static LiteralText`	`of(String content)` Creates a `Text` with the specified plain text.
`static TranslatableText`	`of(Translatable translatable, Object... args)` Creates a new unformatted `TranslatableText` from the given `Translatable`.
`static TranslatableText`	`of(Translation translation, Object... args)` Creates a new unformatted `TranslatableText` with the given `Translation` and arguments.
`Text`	`replace(Pattern oldValue, Text newValue)` Replaces a pattern in this text with a `Text`, preserving all formatting.
`Text`	`replace(Pattern oldValue, Text newValue, boolean lossy)` Replaces a pattern in this text with a `Text`, preserving formatting where possible.
`Text`	`replace(String oldValue, Text newValue)` Replaces a string within this text with a `Text`, preserving all formatting.
`Text`	`replace(String oldValue, Text newValue, boolean lossy)` Replaces a string within this text with a `Text`, preserving formatting where possible.
`abstract Text.Builder`	`toBuilder()` Returns a new `Text.Builder` with the content, formatting and actions of this text.
`DataContainer`	`toContainer()` Serializes this object into a comprehensible `DataContainer`.
`String`	`toPlain()` Returns a plain text representation of this `Text` without any formatting.
`String`	`toPlainSingle()` Returns a plain text representation of this `Text` without any children.
`String`	`toString()`
`Text`	`toText()` Gets the textual representation of this instance for its usage in other `Text` objects.
`Text`	`trim()` Removes all empty texts from the beginning and end of this text.
`Iterable<Text>`	`withChildren()` Returns an immutable `Iterable` over this text and all of its children.

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

- Field Detail
  - EMPTY
```
public static final Text EMPTY
```
    The empty, unformatted Text instance.
  - NEW_LINE
```
public static final LiteralText NEW_LINE
```
    An unformatted Text that will start a new line (if supported).
  - PLAIN_COMPARATOR
```
public static Comparator<Text> PLAIN_COMPARATOR
```
    A Comparator for texts that compares the plain text of two text instances.
- Method Detail
  - getFormat
```
public final TextFormat getFormat()
```
    Returns the format of this Text.
    
    Returns:
    
    The format of this text
  - getColor
```
public final TextColor getColor()
```
    Returns the color of this Text.
    
    Returns:
    
    The color of this text
  - getStyle
```
public final TextStyle getStyle()
```
    Returns the style of this Text. This will return a compound TextStyle if multiple different styles have been set.
    
    Returns:
    
    The style of this text
  - getChildren
```
public final ImmutableList<Text> getChildren()
```
    Returns the immutable list of children appended after the content of this Text.
    
    Returns:
    
    The immutable list of children
  - withChildren
```
public final Iterable<Text> withChildren()
```
    Returns an immutable Iterable over this text and all of its children. This is recursive, the children of the children will be also included.
    
    Returns:
    
    An iterable over this text and the children texts
  - getClickAction
```
public final Optional<ClickAction<?>> getClickAction()
```
    Returns the ClickAction executed on the client when this Text gets clicked.
    
    Returns:
    
    The click action of this text, or Optional.empty() if not set
  - getHoverAction
```
public final Optional<HoverAction<?>> getHoverAction()
```
    Returns the HoverAction executed on the client when this Text gets hovered.
    
    Returns:
    
    The hover action of this text, or Optional.empty() if not set
  - getShiftClickAction
```
public final Optional<ShiftClickAction<?>> getShiftClickAction()
```
    Returns the ShiftClickAction executed on the client when this Text gets shift-clicked.
    
    Returns:
    
    The shift-click action of this text, or Optional.empty() if not set
  - isEmpty
```
public final boolean isEmpty()
```
    Returns whether this Text is empty.
    
    Returns:
    
    true if this text is empty
  - toBuilder
```
public abstract Text.Builder toBuilder()
```
    Returns a new Text.Builder with the content, formatting and actions of this text. This can be used to edit an otherwise immutable Text instance.
    
    Returns:
    
    A new message builder with the content of this text
  - toPlain
```
public final String toPlain()
```
    Returns a plain text representation of this Text without any formatting.
    
    Returns:
    
    This text converted to plain text
  - toPlainSingle
```
public final String toPlainSingle()
```
    Returns a plain text representation of this Text without any children.
    
    Returns:
    
    This text (without children) converted to plain text
  - concat
```
public final Text concat(Text other)
```
    Concatenates the specified Text to this Text and returns the result.
    
    Parameters:
    
    other - To concatenate
    
    Returns:
    
    Concatenated text
  - trim
```
public final Text trim()
```
    Removes all empty texts from the beginning and end of this text.
    
    Returns:
    
    Text result
  - replace
```
public Text replace(Pattern oldValue,
                    Text newValue,
                    boolean lossy)
```
    Replaces a pattern in this text with a Text, preserving formatting where possible.
    If lossy is true, this will replace the pattern if this finds it spanning multiple child Texts, resulting in a potential loss of formatting; if false, it will only replace the pattern where it is contained within one child Text, to preserve all formatting.
    
    This method produces a copy with the specified replacements. The original is not modified.
    
    Parameters:
    
    oldValue - The pattern to replace
    
    newValue - The value to replace with
    
    lossy - Whether lossy mode is enabled
    
    Returns:
    
    The resulting (copied) text
  - replace
```
public Text replace(Pattern oldValue,
                    Text newValue)
```
    Replaces a pattern in this text with a Text, preserving all formatting.
    This method produces a copy with the specified replacements. The original is not modified.
    
    Parameters:
    
    oldValue - The pattern to replace
    
    newValue - The value to replace with
    
    Returns:
    
    The resulting (copied) text
  - replace
```
public Text replace(String oldValue,
                    Text newValue,
                    boolean lossy)
```
    Replaces a string within this text with a Text, preserving formatting where possible.
    If lossy is true, this will replace the pattern if this finds it spanning multiple child Texts, resulting in a potential loss of formatting; if false, it will only replace the pattern where it is contained within one child Text, to preserve all formatting.
    
    This method produces a copy with the specified replacements. The original is not modified.
    
    Parameters:
    
    oldValue - The string to replace
    
    newValue - The value to replace with
    
    lossy - Whether lossy mode is enabled
    
    Returns:
    
    The resulting (copied) text
  - replace
```
public Text replace(String oldValue,
                    Text newValue)
```
    Replaces a string within this text with a Text, preserving all formatting.
    This method produces a copy with the specified replacements. The original is not modified.
    
    Parameters:
    
    oldValue - The string to replace
    
    newValue - The value to replace with
    
    Returns:
    
    The resulting (copied) text
  - getContentVersion
```
public int getContentVersion()
```
    Description copied from interface: DataSerializable
    
    Gets the content version of this DataSerializable. The version may differ between instances of plugins and implementations such that the DataView from DataSerializable.toContainer() may include different information, or remove other information as they are no longer deemed necessary. The version goes hand in hand with DataContentUpdater as it is required when there exists any DataView of this DataSerializable with an "older" version.
    
    Specified by:
    
    getContentVersion in interface DataSerializable
    
    Returns:
    
    The version of the content being serialized
  - toContainer
```
public DataContainer toContainer()
```
    Description copied from interface: DataSerializable
    
    Serializes this object into a comprehensible DataContainer.
    
    Specified by:
    
    toContainer in interface DataSerializable
    
    Returns:
    
    A newly created DataContainer
  - compareTo
```
public int compareTo(Text o)
```
    Specified by:
    
    compareTo in interface Comparable<Text>
  - 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
  - of
```
public static Text of()
```
    Returns an empty, unformatted Text instance.
    
    Returns:
    
    An empty text
  - of
```
public static LiteralText of(String content)
```
    Creates a Text with the specified plain text. The created text won't have any formatting or events configured.
    
    Parameters:
    
    content - The content of the text
    
    Returns:
    
    The created text
    
    See Also:
    
    LiteralText
  - of
```
public static LiteralText of(char content)
```
    Creates a Text with the specified char as plain text. The created text won't have any formatting or events configured.
    
    Parameters:
    
    content - The content of the text as char
    
    Returns:
    
    The created text
    
    See Also:
    
    LiteralText
  - of
```
public static TranslatableText of(Translation translation,
                                  Object... args)
```
    Creates a new unformatted TranslatableText with the given Translation and arguments.
    
    Parameters:
    
    translation - The translation for the text
    
    args - The arguments for the translation
    
    Returns:
    
    The created text
    
    See Also:
    
    TranslatableText
  - of
```
public static TranslatableText of(Translatable translatable,
                                  Object... args)
```
    Creates a new unformatted TranslatableText from the given Translatable.
    
    Parameters:
    
    translatable - The translatable for the text
    
    args - The arguments for the translation
    
    Returns:
    
    The created text
    
    See Also:
    
    TranslatableText
  - of
```
public static SelectorText of(Selector selector)
```
    Creates a new unformatted SelectorText with the given selector.
    
    Parameters:
    
    selector - The selector for the text
    
    Returns:
    
    The created text
    
    See Also:
    
    SelectorText
  - of
```
public static ScoreText of(Score score)
```
    Creates a new unformatted ScoreText with the given score.
    
    Parameters:
    
    score - The score for the text
    
    Returns:
    
    The created text
    
    See Also:
    
    ScoreText
  - of
```
public static Text of(Object... objects)
```
    Builds a Text from a given array of objects.
    For instance, you can use this like Text.of(TextColors.DARK_AQUA, "Hi", TextColors.AQUA, "Bye")
    
    This will create the correct Text instance if the input object is the input for one of the Text types or convert the object to a string otherwise.
    
    For instances of type TextRepresentable (e.g. Text, Text.Builder, ...) the formatting of appended text has priority over the current formatting in the method, e.g. the following results in a green, then yellow and at the end green again Text:
    Text.of(TextColors.GREEN, "Hello ", Text.of(TextColors.YELLOW, "Spongie"), '!');
    
    Parameters:
    
    objects - The object array
    
    Returns:
    
    The built text object
  - builder
```
public static Text.Builder builder()
```
    Creates a Text.Builder with empty text.
    
    Returns:
    
    A new text builder with empty text
  - builder
```
public static LiteralText.Builder builder(String content)
```
    Creates a new unformatted LiteralText.Builder with the specified content.
    
    Parameters:
    
    content - The content of the text
    
    Returns:
    
    The created text builder
    
    See Also:
    
    LiteralText, LiteralText.Builder
  - builder
```
public static LiteralText.Builder builder(char content)
```
    Creates a new unformatted LiteralText.Builder with the specified content.
    
    Parameters:
    
    content - The content of the text as char
    
    Returns:
    
    The created text builder
    
    See Also:
    
    LiteralText, LiteralText.Builder
  - builder
```
public static LiteralText.Builder builder(Text text,
                                          String content)
```
    Creates a new LiteralText.Builder with the formatting and actions of the specified Text and the given content.
    
    Parameters:
    
    text - The text to apply the properties from
    
    content - The content for the text builder
    
    Returns:
    
    The created text builder
    
    See Also:
    
    LiteralText, LiteralText.Builder
  - builder
```
public static TranslatableText.Builder builder(Translation translation,
                                               Object... args)
```
    Creates a new unformatted TranslatableText.Builder with the given Translation and arguments.
    
    Parameters:
    
    translation - The translation for the builder
    
    args - The arguments for the translation
    
    Returns:
    
    The created text builder
    
    See Also:
    
    TranslatableText, TranslatableText.Builder
  - builder
```
public static TranslatableText.Builder builder(Translatable translatable,
                                               Object... args)
```
    Creates a new unformatted TranslatableText.Builder from the given Translatable.
    
    Parameters:
    
    translatable - The translatable for the builder
    
    args - The arguments for the translation
    
    Returns:
    
    The created text builder
    
    See Also:
    
    TranslatableText, TranslatableText.Builder
  - builder
```
public static TranslatableText.Builder builder(Text text,
                                               Translation translation,
                                               Object... args)
```
    Creates a new TranslatableText.Builder with the formatting and actions of the specified Text and the given Translation and arguments.
    
    Parameters:
    
    text - The text to apply the properties from
    
    translation - The translation for the builder
    
    args - The arguments for the translation
    
    Returns:
    
    The created text builder
    
    See Also:
    
    TranslatableText, TranslatableText.Builder
  - builder
```
public static TranslatableText.Builder builder(Text text,
                                               Translatable translatable,
                                               Object... args)
```
    Creates a new TranslatableText.Builder with the formatting and actions of the specified Text and the given Translatable.
    
    Parameters:
    
    text - The text to apply the properties from
    
    translatable - The translatable for the builder
    
    args - The arguments for the translation
    
    Returns:
    
    The created text builder
    
    See Also:
    
    TranslatableText, TranslatableText.Builder
  - builder
```
public static SelectorText.Builder builder(Selector selector)
```
    Creates a new unformatted SelectorText.Builder with the given selector.
    
    Parameters:
    
    selector - The selector for the builder
    
    Returns:
    
    The created text builder
    
    See Also:
    
    SelectorText, SelectorText.Builder
  - builder
```
public static SelectorText.Builder builder(Text text,
                                           Selector selector)
```
    Creates a new SelectorText.Builder with the formatting and actions of the specified Text and the given selector.
    
    Parameters:
    
    text - The text to apply the properties from
    
    selector - The selector for the builder
    
    Returns:
    
    The created text builder
    
    See Also:
    
    SelectorText, SelectorText.Builder
  - builder
```
public static ScoreText.Builder builder(Score score)
```
    Creates a new unformatted ScoreText.Builder with the given score.
    
    Parameters:
    
    score - The score for the text builder
    
    Returns:
    
    The created text builder
    
    See Also:
    
    ScoreText, ScoreText.Builder
  - builder
```
public static ScoreText.Builder builder(Text text,
                                        Score score)
```
    Creates a new ScoreText.Builder with the formatting and actions of the specified Text and the given score.
    
    Parameters:
    
    text - The text to apply the properties from
    
    score - The score for the text builder
    
    Returns:
    
    The created text builder
    
    See Also:
    
    ScoreText, ScoreText.Builder
  - join
```
public static Text join(Text... texts)
```
    Joins a sequence of text objects together.
    
    Parameters:
    
    texts - The texts to join
    
    Returns:
    
    A text object that joins the given text objects
  - join
```
public static Text join(Iterable<? extends Text> texts)
```
    Joins a sequence of text objects together.
    
    Parameters:
    
    texts - The texts to join
    
    Returns:
    
    A text object that joins the given text objects
  - join
```
public static Text join(Iterator<? extends Text> texts)
```
    Joins a sequence of text objects together.
    
    Parameters:
    
    texts - The texts to join
    
    Returns:
    
    A text object that joins the given text objects
  - joinWith
```
public static Text joinWith(Text separator,
                            Text... texts)
```
    Joins a sequence of text objects together along with a separator.
    
    Parameters:
    
    separator - The separator
    
    texts - The texts to join
    
    Returns:
    
    A text object that joins the given text objects
  - joinWith
```
public static Text joinWith(Text separator,
                            Iterable<? extends Text> texts)
```
    Joins a sequence of text objects together along with a separator.
    
    Parameters:
    
    separator - The separator
    
    texts - The texts to join
    
    Returns:
    
    A text object that joins the given text objects
  - joinWith
```
public static Text joinWith(Text separator,
                            Iterator<? extends Text> texts)
```
    Joins a sequence of text objects together along with a separator.
    
    Parameters:
    
    separator - The separator
    
    texts - An iterator for the texts to join
    
    Returns:
    
    A text object that joins the given text objects

Class Text

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

NEW_LINE

PLAIN_COMPARATOR

Method Detail

getFormat

getColor

getStyle

getChildren

withChildren

getClickAction

getHoverAction

getShiftClickAction

isEmpty

toBuilder

toPlain

toPlainSingle

concat

trim

replace

replace

replace

replace

getContentVersion

toContainer

compareTo

equals

hashCode

toString

toText

of

of

of

of

of

of

of

of

builder

builder

builder

builder

builder

builder

builder

builder

builder

builder

builder

builder

join

join

join

joinWith

joinWith

joinWith