TextFormatter (SpongeAPI 7.4.0 API)

All Superinterfaces:

Iterable<E>, TextElement, TextRepresentable

All Known Subinterfaces:

PartitionedTextFormatter<E>

All Known Implementing Classes:

DynamicPartitionedTextFormatter, FixedPartitionedTextFormatter, MessageEvent.MessageFormatter, SimpleTextFormatter
```
public interface TextFormatter<E extends TextRepresentable>
extends TextRepresentable, Iterable<E>
```
A TextFormatter is a mutable collection of TextRepresentables which are all concatenated to an empty Text object on format().

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`boolean`	`add(Collection<E> elements)` Adds the specified elements to the end of this formatter.
`boolean`	`add(E element)` Adds the specified element to the end of this formatter.
`default boolean`	`add(Iterable<E> elements)` Adds the specified elements to the end of this formatter.
`default boolean`	`add(Iterator<E> elements)` Adds the specified elements to the end of this formatter.
`void`	`clear()` Clears all elements from this formatter.
`boolean`	`contains(E e)` Returns true if the specified element is in the formatter.
`default <T extends TextRepresentable> Optional<T>`	`first(Class<T> clazz)` Returns the first element of the specified type.
`default <T extends TextRepresentable> Optional<T>`	`firstAfter(int index, Class<T> clazz)` Returns the first element of the specified type after the specified index.
`default <T extends TextRepresentable> void`	`forEach(Class<T> clazz, Consumer<T> consumer)` Applies the specified consumer to each element of the specified type after the specified index.
`default <T extends TextRepresentable> void`	`forEachAfter(int index, Class<T> clazz, Consumer<T> consumer)` Applies the specified consumer to each element of the specified type after the specified index.
`default Text`	`format()` Builds the result `Text` for this formatter using the current configuration of each element.
`E`	`get(int i)` Returns the element at the specified index.
`ImmutableList<E>`	`getAll()` Returns an `ImmutableList` of this formatter's elements.
`void`	`insert(int i, Collection<E> elements)` Inserts the specified elements at the specified index within the formatter.
`void`	`insert(int i, E element)` Inserts the specified element at the specified index within the formatter.
`default void`	`insert(int i, Iterable<E> elements)` Inserts the specified elements at the specified index within the formatter.
`default void`	`insert(int i, Iterator<E> elements)` Inserts the specified elements at the specified index within the formatter.
`boolean`	`isEmpty()` Returns true if the formatter contains no elements.
`default Iterator<E>`	`iterator()`
`boolean`	`remove(Collection<E> elements)` Removes the specified elements from the formatter.
`boolean`	`remove(E element)` Removes the specified element from the formatter.
`default boolean`	`remove(Iterable<E> elements)` Removes the specified elements from the formatter.
`default boolean`	`remove(Iterator<E> elements)` Removes the specified elements from the formatter.
`boolean`	`retain(Collection<E> elements)` Removes all elements from the formatter except for these specified elements.
`default boolean`	`retain(Iterable<E> elements)` Removes all elements from the formatter except for these specified elements.
`default boolean`	`retain(Iterator<E> elements)` Removes all elements from the formatter except for these specified elements.
`E`	`set(int i, E e)` Replaces the element previously at the specified index with the specified element.
`int`	`size()` Returns the amount of elements in this formatter.
`default Text`	`toText()` Gets the textual representation of this instance for its usage in other `Text` objects.

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - getAll
```
ImmutableList<E> getAll()
```
    Returns an ImmutableList of this formatter's elements.
    
    Returns:
    
    All elements
  - get
```
E get(int i)
```
    Returns the element at the specified index.
    
    Parameters:
    
    i - Index to retrieve from
    
    Returns:
    
    Element at index
  - firstAfter
```
default <T extends TextRepresentable> Optional<T> firstAfter(int index,
                                                             Class<T> clazz)
```
    Returns the first element of the specified type after the specified index.
    
    Type Parameters:
    
    T - Type of TextRepresentable
    
    Parameters:
    
    index - To start at
    
    clazz - Class of type
    
    Returns:
    
    Element if found
  - first
```
default <T extends TextRepresentable> Optional<T> first(Class<T> clazz)
```
    Returns the first element of the specified type.
    
    Type Parameters:
    
    T - Type of TextRepresentable
    
    Parameters:
    
    clazz - Type to get
    
    Returns:
    
    TextRepresentable of type if found, empty otherwise
  - forEachAfter
```
default <T extends TextRepresentable> void forEachAfter(int index,
                                                        Class<T> clazz,
                                                        Consumer<T> consumer)
```
    Applies the specified consumer to each element of the specified type after the specified index.
    
    Type Parameters:
    
    T - Type
    
    Parameters:
    
    index - Index to start at
    
    clazz - Class of type
    
    consumer - Consumer
  - forEach
```
default <T extends TextRepresentable> void forEach(Class<T> clazz,
                                                   Consumer<T> consumer)
```
    Applies the specified consumer to each element of the specified type after the specified index.
    
    Type Parameters:
    
    T - Type
    
    Parameters:
    
    clazz - Class of type
    
    consumer - Consumer
  - set
```
E set(int i,
      E e)
```
    Replaces the element previously at the specified index with the specified element.
    
    Parameters:
    
    i - Index to replace
    
    e - Element to replace with
    
    Returns:
    
    Element previously at index
  - size
```
int size()
```
    Returns the amount of elements in this formatter.
    
    Returns:
    
    Amount of elements
  - isEmpty
```
boolean isEmpty()
```
    Returns true if the formatter contains no elements.
    
    Returns:
    
    True if contains no elements
  - contains
```
boolean contains(E e)
```
    Returns true if the specified element is in the formatter.
    
    Parameters:
    
    e - Element to check
    
    Returns:
    
    True if in formatter
  - clear
```
void clear()
```
    Clears all elements from this formatter.
  - add
```
boolean add(E element)
```
    Adds the specified element to the end of this formatter.
    
    Parameters:
    
    element - Element to add
    
    Returns:
    
    True if the formatter changed as a result of the call
  - add
```
boolean add(Collection<E> elements)
```
    Adds the specified elements to the end of this formatter.
    
    Parameters:
    
    elements - Elements to add
    
    Returns:
    
    True if the formatter changed as a result of the call
  - add
```
default boolean add(Iterable<E> elements)
```
    Adds the specified elements to the end of this formatter.
    
    Parameters:
    
    elements - Elements to add
    
    Returns:
    
    True if the formatter changed as a result of the call
  - add
```
default boolean add(Iterator<E> elements)
```
    Adds the specified elements to the end of this formatter.
    
    Parameters:
    
    elements - Elements to add
    
    Returns:
    
    True if the formatter changed as a result of the call
  - insert
```
void insert(int i,
            E element)
```
    Inserts the specified element at the specified index within the formatter.
    
    Parameters:
    
    i - Index to insert at
    
    element - Element to insert
  - insert
```
void insert(int i,
            Collection<E> elements)
```
    Inserts the specified elements at the specified index within the formatter.
    
    Parameters:
    
    i - Index to insert at
    
    elements - Elements to insert
  - insert
```
default void insert(int i,
                    Iterable<E> elements)
```
    Inserts the specified elements at the specified index within the formatter.
    
    Parameters:
    
    i - Index to insert at
    
    elements - Elements to insert
  - insert
```
default void insert(int i,
                    Iterator<E> elements)
```
    Inserts the specified elements at the specified index within the formatter.
    
    Parameters:
    
    i - Index to insert at
    
    elements - Elements to insert
  - remove
```
boolean remove(E element)
```
    Removes the specified element from the formatter.
    
    Parameters:
    
    element - Element to remove
    
    Returns:
    
    True if this formatter contained the Element
  - remove
```
boolean remove(Collection<E> elements)
```
    Removes the specified elements from the formatter.
    
    Parameters:
    
    elements - Elements to remove
    
    Returns:
    
    True if the formatter changed as a result of this call
  - remove
```
default boolean remove(Iterable<E> elements)
```
    Removes the specified elements from the formatter.
    
    Parameters:
    
    elements - Elements to remove
    
    Returns:
    
    True if the formatter changed as a result of this call
  - remove
```
default boolean remove(Iterator<E> elements)
```
    Removes the specified elements from the formatter.
    
    Parameters:
    
    elements - Elements to remove
    
    Returns:
    
    True if the formatter changed as a result of this call
  - retain
```
boolean retain(Collection<E> elements)
```
    Removes all elements from the formatter except for these specified elements.
    
    Parameters:
    
    elements - Elements to retain
    
    Returns:
    
    True if the formatter changed as a result of this call
  - retain
```
default boolean retain(Iterable<E> elements)
```
    Removes all elements from the formatter except for these specified elements.
    
    Parameters:
    
    elements - Elements to retain
    
    Returns:
    
    True if the formatter changed as a result of this call
  - retain
```
default boolean retain(Iterator<E> elements)
```
    Removes all elements from the formatter except for these specified elements.
    
    Parameters:
    
    elements - Elements to retain
    
    Returns:
    
    True if the formatter changed as a result of this call
  - format
```
default Text format()
```
    Builds the result Text for this formatter using the current configuration of each element. The result of each element is concatenated to an empty Text to yield the result.
    
    Returns:
    
    Text result of formatter
  - iterator
```
default Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface Iterable<E extends TextRepresentable>
  - toText
```
default 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

Interface TextFormatter<E extends TextRepresentable>

Method Summary

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

Methods inherited from interface java.lang.Iterable

Method Detail

getAll

get

firstAfter

first

forEachAfter

forEach

set

size

isEmpty

contains

clear

add

add

add

add

insert

insert

insert

insert

remove

remove

remove

remove

retain

retain

retain

format

iterator

toText