TextComponent (text-api 3.0.0 API)

All Superinterfaces:

BuildableComponent<TextComponent,TextComponent.Builder>, Component, ScopedComponent<TextComponent>
```
public interface TextComponent
extends BuildableComponent<TextComponent,TextComponent.Builder>, ScopedComponent<TextComponent>
```
A plain text component.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface TextComponent.Builder
A text component builder.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`TextComponent.Builder` A text component builder.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static @NonNull TextComponent.Builder`	`builder()` Creates a text component builder.
`static @NonNull TextComponent.Builder`	`builder(@NonNull java.lang.String content)` Creates a text component builder with content.
`static @NonNull TextComponent.Builder`	`builder(@NonNull java.lang.String content, @Nullable TextColor color)` Creates a text component builder with content, and optional color.
`@NonNull java.lang.String`	`content()` Gets the plain text content.
`@NonNull TextComponent`	`content(@NonNull java.lang.String content)` Sets the plain text content.
`static @NonNull TextComponent`	`empty()` Gets a text component with empty content.
`static @NonNull TextComponent`	`make(@NonNull java.util.function.Consumer<? super TextComponent.Builder> consumer)` Creates a text component by applying configuration from `consumer`.
`static @NonNull TextComponent`	`make(@NonNull java.lang.String content, @NonNull java.util.function.Consumer<? super TextComponent.Builder> consumer)` Creates a text component by applying configuration from `consumer`.
`static @NonNull TextComponent`	`newline()` Gets a text component with a new line character as the content.
`static @NonNull TextComponent`	`of(boolean value)` Creates a text component with the content of `String.valueOf(boolean)`.
`static @NonNull TextComponent`	`of(char value)` Creates a text component with the content of `String.valueOf(char)`.
`static @NonNull TextComponent`	`of(double value)` Creates a text component with the content of `String.valueOf(double)`.
`static @NonNull TextComponent`	`of(float value)` Creates a text component with the content of `String.valueOf(float)`.
`static @NonNull TextComponent`	`of(int value)` Creates a text component with the content of `String.valueOf(int)`.
`static @NonNull TextComponent`	`of(long value)` Creates a text component with the content of `String.valueOf(long)`.
`static @NonNull TextComponent`	`of(@NonNull java.lang.String content)` Creates a text component with content.
`static @NonNull TextComponent`	`of(@NonNull java.lang.String content, @Nullable TextColor color)` Creates a text component with content, and optional color.
`static @NonNull TextComponent`	`of(@NonNull java.lang.String content, @Nullable TextColor color, @NonNull java.util.Set<TextDecoration> decorations)` Creates a text component with content, and optional color and decorations.
`static @NonNull TextComponent`	`of(@NonNull java.lang.String content, @Nullable TextColor color, TextDecoration... decorations)` Creates a text component with content, and optional color and decorations.
`static @NonNull TextComponent`	`space()` Gets a text immutable component with a single space as the content.

Methods inherited from interface net.kyori.text.BuildableComponent
toBuilder

Methods inherited from interface net.kyori.text.ScopedComponent
append, append, children, clickEvent, color, decoration, decoration, hoverEvent, insertion, mergeColor, mergeDecorations, mergeEvents

Methods inherited from interface net.kyori.text.Component
children, clickEvent, color, contains, decoration, decorations, decorations, detectCycle, hasDecoration, hasStyling, hoverEvent, insertion, style, style

- Method Detail
  - builder
```
static @NonNull TextComponent.Builder builder()
```
    Creates a text component builder.
    
    Returns:
    
    a builder
  - builder
```
static @NonNull TextComponent.Builder builder(@NonNull java.lang.String content)
```
    Creates a text component builder with content.
    
    Parameters:
    
    content - the plain text content
    
    Returns:
    
    a builder
  - builder
```
static @NonNull TextComponent.Builder builder(@NonNull java.lang.String content,
                                              @Nullable TextColor color)
```
    Creates a text component builder with content, and optional color.
    
    Parameters:
    
    content - the plain text content
    
    color - the color
    
    Returns:
    
    a builder
  - of
```
static @NonNull TextComponent of(@NonNull java.lang.String content)
```
    Creates a text component with content.
    
    Parameters:
    
    content - the plain text content
    
    Returns:
    
    the text component
  - of
```
static @NonNull TextComponent of(boolean value)
```
    Creates a text component with the content of String.valueOf(boolean).
    
    Parameters:
    
    value - the boolean value
    
    Returns:
    
    the component
  - of
```
static @NonNull TextComponent of(char value)
```
    Creates a text component with the content of String.valueOf(char).
    
    Parameters:
    
    value - the char value
    
    Returns:
    
    the component
  - of
```
static @NonNull TextComponent of(double value)
```
    Creates a text component with the content of String.valueOf(double).
    
    Parameters:
    
    value - the double value
    
    Returns:
    
    the component
  - of
```
static @NonNull TextComponent of(float value)
```
    Creates a text component with the content of String.valueOf(float).
    
    Parameters:
    
    value - the float value
    
    Returns:
    
    the component
  - of
```
static @NonNull TextComponent of(int value)
```
    Creates a text component with the content of String.valueOf(int).
    
    Parameters:
    
    value - the int value
    
    Returns:
    
    the component
  - of
```
static @NonNull TextComponent of(long value)
```
    Creates a text component with the content of String.valueOf(long).
    
    Parameters:
    
    value - the long value
    
    Returns:
    
    the component
  - of
```
static @NonNull TextComponent of(@NonNull java.lang.String content,
                                 @Nullable TextColor color)
```
    Creates a text component with content, and optional color.
    
    Parameters:
    
    content - the plain text content
    
    color - the color
    
    Returns:
    
    the text component
  - of
```
static @NonNull TextComponent of(@NonNull java.lang.String content,
                                 @Nullable TextColor color,
                                 TextDecoration... decorations)
```
    Creates a text component with content, and optional color and decorations.
    
    Parameters:
    
    content - the plain text content
    
    color - the color
    
    decorations - the decorations
    
    Returns:
    
    the text component
  - of
```
static @NonNull TextComponent of(@NonNull java.lang.String content,
                                 @Nullable TextColor color,
                                 @NonNull java.util.Set<TextDecoration> decorations)
```
    Creates a text component with content, and optional color and decorations.
    
    Parameters:
    
    content - the plain text content
    
    color - the color
    
    decorations - the decorations
    
    Returns:
    
    the text component
  - make
```
static @NonNull TextComponent make(@NonNull java.util.function.Consumer<? super TextComponent.Builder> consumer)
```
    Creates a text component by applying configuration from consumer.
    
    Parameters:
    
    consumer - the builder configurator
    
    Returns:
    
    the text component
  - make
```
static @NonNull TextComponent make(@NonNull java.lang.String content,
                                   @NonNull java.util.function.Consumer<? super TextComponent.Builder> consumer)
```
    Creates a text component by applying configuration from consumer.
    
    Parameters:
    
    content - the plain text content
    
    consumer - the builder configurator
    
    Returns:
    
    the text component
  - empty
```
static @NonNull TextComponent empty()
```
    Gets a text component with empty content.
    
    Returns:
    
    a text component with empty content
  - newline
```
static @NonNull TextComponent newline()
```
    Gets a text component with a new line character as the content.
    
    Returns:
    
    a text component with a new line character as the content
  - space
```
static @NonNull TextComponent space()
```
    Gets a text immutable component with a single space as the content.
    
    Returns:
    
    a text component with a single space as the content
  - content
```
@NonNull java.lang.String content()
```
    Gets the plain text content.
    
    Returns:
    
    the plain text content
  - content
```
@NonNull TextComponent content(@NonNull java.lang.String content)
```
    Sets the plain text content.
    
    Parameters:
    
    content - the plain text content
    
    Returns:
    
    a copy of this component

Interface TextComponent

Nested Class Summary

Method Summary

Methods inherited from interface net.kyori.text.BuildableComponent

Methods inherited from interface net.kyori.text.ScopedComponent

Methods inherited from interface net.kyori.text.Component

Method Detail

builder

builder

builder

of

of

of

of

of

of

of

of

of

of

make

make

empty

newline

space

content

content