Text (FabricMC_yarn

All Superinterfaces:

com.mojang.brigadier.Message

All Known Subinterfaces:

MutableText

All Known Implementing Classes:

BaseText, KeybindText, LiteralText, NbtText, NbtText.BlockNbtText, NbtText.EntityNbtText, NbtText.StorageNbtText, ScoreText, SelectorText, TranslatableText
```
public interface Text
extends com.mojang.brigadier.Message
```
A text. Can be converted to and from JSON format.
Each text has a tree structure, embodying all its siblings. To iterate contents in the text and all its siblings, call visit methods.

This interface does not expose mutation operations. For mutation, refer to MutableText.

See Also:

MutableText

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Text.Serializer` A JSON serializer for `Text`.
`static interface`	`Text.StyledVisitor<T>` A visitor for text content and a contextual `Style`.
`static interface`	`Text.Visitor<T>` A visitor for text content.

Field Summary

Fields
Modifier and Type Field and Description

static Optional<Unit> TERMINATE_VISIT
An Optional that indicates a text visitor should be terminated.

Fields
Modifier and Type	Field and Description
`static Optional<Unit>`	`TERMINATE_VISIT` An `Optional` that indicates a text visitor should be terminated.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`String`	`asString()` Returns the string representation of this text itself, excluding siblings.
`default String`	`asTruncatedString(int length)` Returns the full string representation of this text, truncated beyond the supplied `length`.
`MutableText`	`copy()` Copies the text itself, excluding the styles or siblings.
`List<Text>`	`getSiblings()` Returns the siblings of this text.
`default String`	`getString()` Returns the full string representation of this text, including siblings.
`Style`	`getStyle()` Returns the style of this text.
`MutableText`	`shallowCopy()` Copies the text itself, the style, and the siblings.
`default <T> Optional<T>`	`visit(Text.StyledVisitor<T> visitor, Style style)` Visits the code points of in each `partial string` representation of `text` and its siblings, applying the formatting codes within.
`default <T> Optional<T>`	`visit(Text.Visitor<T> visitor)` Visits this text and its siblings.
`default <T> Optional<T>`	`visitSelf(Text.StyledVisitor<T> visitor, Style style)` Visits the text itself.
`default <T> Optional<T>`	`visitSelf(Text.Visitor<T> visitor)` Visits the text itself.

- Field Detail
  - TERMINATE_VISIT
```
static final Optional<Unit> TERMINATE_VISIT
```
    An Optional that indicates a text visitor should be terminated.
    
    See Also:
    
    Text.Visitor.accept(String), Text.StyledVisitor.accept(Style, String)
- Method Detail
  - getStyle
```
Style getStyle()
```
    Returns the style of this text.
  - asString
```
String asString()
```
    Returns the string representation of this text itself, excluding siblings.
  - getString
```
default String getString()
```
    Returns the full string representation of this text, including siblings.
    
    Specified by:
    
    getString in interface com.mojang.brigadier.Message
  - asTruncatedString
```
default String asTruncatedString(int length)
```
    Returns the full string representation of this text, truncated beyond the supplied length.
    
    Parameters:
    
    length - the max length allowed for the string representation of the text
  - getSiblings
```
List<Text> getSiblings()
```
    Returns the siblings of this text.
  - copy
```
MutableText copy()
```
    Copies the text itself, excluding the styles or siblings.
  - shallowCopy
```
MutableText shallowCopy()
```
    Copies the text itself, the style, and the siblings.
    A shallow copy is made for the siblings.
  - visit
```
@Environment(value=CLIENT)
default <T> Optional<T> visit(Text.StyledVisitor<T> visitor,
                                                         Style style)
```
    Visits the code points of in each partial string representation of text and its siblings, applying the formatting codes within.
    The visit is in forward direction.
    
    Parameters:
    
    visitor - the styled text visitor
    
    style - the starting style
    
    Returns:
    
    true if the full string was visited, or false indicating the visitor terminated half-way
    
    See Also:
    
    visit(Text.StyledVisitor, Style)
  - visit
```
default <T> Optional<T> visit(Text.Visitor<T> visitor)
```
    Visits this text and its siblings.
    When the visitor returns a non-empty optional during visit, the visit is immediately terminated and the result is returned.
    
    Parameters:
    
    visitor - the text visitor
    
    Returns:
    
    what the visitor returns, or Optional.empty() if the visitor always returned Optional.empty().
  - visitSelf
```
@Environment(value=CLIENT)
default <T> Optional<T> visitSelf(Text.StyledVisitor<T> visitor,
                                                             Style style)
```
    Visits the text itself.
    
    Parameters:
    
    visitor - the visitor
    
    style - the current style
    
    Returns:
    
    the visitor's return value
    
    See Also:
    
    visit(StyledVisitor, Style)
  - visitSelf
```
default <T> Optional<T> visitSelf(Text.Visitor<T> visitor)
```
    Visits the text itself.
    
    Parameters:
    
    visitor - the visitor
    
    Returns:
    
    the visitor's return value
    
    See Also:
    
    visit(Visitor)

Interface Text

Nested Class Summary

Field Summary

Method Summary

Field Detail

TERMINATE_VISIT

Method Detail

getStyle

asString

getString

asTruncatedString

getSiblings

copy

shallowCopy

visit

visit

visitSelf

visitSelf