net.kyori.text

Class TextComponent

java.lang.Object

net.kyori.text.AbstractComponent

net.kyori.text.AbstractBuildableComponent<TextComponent,TextComponent.Builder>

net.kyori.text.TextComponent

All Implemented Interfaces:

BuildableComponent<TextComponent,TextComponent.Builder>, Component

public class TextComponent
extends AbstractBuildableComponent<TextComponent,TextComponent.Builder>

A plain text component.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextComponent.Builder A text component builder.

Nested classes/interfaces inherited from class net.kyori.text.AbstractBuildableComponent

AbstractBuildableComponent.AbstractBuilder<C extends BuildableComponent<C,B>,B extends AbstractBuildableComponent.AbstractBuilder<C,B>>

Field Summary

Fields inherited from class net.kyori.text.AbstractComponent

bold, children, clickEvent, color, hoverEvent, insertion, italic, obfuscated, strikethrough, underlined

Fields inherited from interface net.kyori.text.Component

EMPTY_COMPONENT_LIST

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TextComponent(@NonNull java.util.List<Component> children, @Nullable TextColor color, TextDecoration.State obfuscated, TextDecoration.State bold, TextDecoration.State strikethrough, TextDecoration.State underlined, TextDecoration.State italic, @Nullable ClickEvent clickEvent, @Nullable HoverEvent hoverEvent, @Nullable java.lang.String insertion, @NonNull java.lang.String content)
protected	TextComponent(@NonNull TextComponent.Builder builder)

Method Summary

Modifier and Type	Method and Description
@NonNull TextComponent	append(@NonNull Component component) Appends a component to this component.
static TextComponent.Builder	builder() Creates a text component builder.
static TextComponent.Builder	builder(@NonNull java.lang.String content) Creates a text component builder with content.
@NonNull TextComponent	clickEvent(@Nullable ClickEvent event) Sets the click event of this component.
@NonNull TextComponent	color(@Nullable TextColor color) Sets the color of this component.
@NonNull java.lang.String	content() Gets the plain text content.
@NonNull TextComponent	content(@NonNull java.lang.String content) Sets the plain text content.
@NonNull TextComponent	copy() Creates a component.
@NonNull TextComponent	decoration(@NonNull TextDecoration decoration, boolean flag) Sets the state of a decoration on this component.
@NonNull TextComponent	decoration(@NonNull TextDecoration decoration, TextDecoration.State state) Sets the value of a decoration on this component.
boolean	equals(@Nullable java.lang.Object other)
int	hashCode()
@NonNull TextComponent	hoverEvent(@Nullable HoverEvent event) Sets the hover event of this component.
@NonNull TextComponent	insertion(@Nullable java.lang.String insertion) Sets the string to be inserted when this component is shift-clicked.
static TextComponent	make(@NonNull java.util.function.Consumer<TextComponent.Builder> consumer) Creates a text component by applying configuration from consumer.
static TextComponent	make(@NonNull java.lang.String content, @NonNull java.util.function.Consumer<TextComponent.Builder> consumer) Creates a text component by applying configuration from consumer.
@NonNull TextComponent	mergeColor(@NonNull Component that) Merges the color from another component into this component.
@NonNull TextComponent	mergeDecorations(@NonNull Component that) Merges the decorations from another component into this component.
@NonNull TextComponent	mergeEvents(@NonNull Component that) Merges the events from another component into this component.
@NonNull TextComponent	mergeStyle(@NonNull Component that) Merges styling from another component into this component.
static TextComponent	of(@NonNull java.lang.String content) Creates a text component with content.
static TextComponent	of(@NonNull java.lang.String content, @Nullable TextColor color) Creates a text component with content, and optional color.
static 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.
protected void	populateToString(com.google.common.base.MoreObjects.ToStringHelper builder)
@NonNull TextComponent	resetStyle() Resets all styling on this component.
@NonNull TextComponent.Builder	toBuilder() Create a builder from this component.

Methods inherited from class net.kyori.text.AbstractComponent

children, clickEvent, color, decoration, equals, hasStyling, hoverEvent, insertion, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.kyori.text.Component

children, clickEvent, color, contains, decoration, decorations, decorations, detectCycle, hasDecoration, hasStyling, hoverEvent, insertion, of, of, of, of, of, of

Constructor Detail

TextComponent

protected TextComponent(@NonNull TextComponent.Builder builder)

TextComponent

protected TextComponent(@NonNull java.util.List<Component> children,
                        @Nullable TextColor color,
                        TextDecoration.State obfuscated,
                        TextDecoration.State bold,
                        TextDecoration.State strikethrough,
                        TextDecoration.State underlined,
                        TextDecoration.State italic,
                        @Nullable ClickEvent clickEvent,
                        @Nullable HoverEvent hoverEvent,
                        @Nullable java.lang.String insertion,
                        @NonNull java.lang.String content)

Method Detail

builder

public static TextComponent.Builder builder()

Creates a text component builder.

Returns:

a builder

builder

public static TextComponent.Builder builder(@NonNull java.lang.String content)

Creates a text component builder with content.

Parameters:

content - the plain text content

Returns:

a builder

of

public static TextComponent of(@NonNull java.lang.String content)

Creates a text component with content.

Parameters:

content - the plain text content

Returns:

the text component

of

public static 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

public static 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

public static TextComponent make(@NonNull java.util.function.Consumer<TextComponent.Builder> consumer)

Creates a text component by applying configuration from consumer.

Parameters:

consumer - the builder configurator

Returns:

the text component

make

public static TextComponent make(@NonNull java.lang.String content,
                                 @NonNull java.util.function.Consumer<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

content

public @NonNull java.lang.String content()

Gets the plain text content.

Returns:

the plain text content

content

public @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

append

public @NonNull TextComponent append(@NonNull Component component)

Description copied from interface: Component

Appends a component to this component.

Parameters:

component - the component to append

Returns:

a component with the component added

color

public @NonNull TextComponent color(@Nullable TextColor color)

Description copied from interface: Component

Sets the color of this component.

Parameters:

color - the color

Returns:

a component

decoration

public @NonNull TextComponent decoration(@NonNull TextDecoration decoration,
                                         boolean flag)

Description copied from interface: Component

Sets the state of a decoration on this component.

Parameters:

decoration - the decoration

flag - true if this component should have the decoration, false if this component should not have the decoration

Returns:

a component

decoration

public @NonNull TextComponent decoration(@NonNull TextDecoration decoration,
                                         TextDecoration.State state)

Description copied from interface: Component

Sets the value of a decoration on this component.

Parameters:

decoration - the decoration

state - TextDecoration.State#TRUE if this component should have the decoration, TextDecoration.State#FALSE if this component should not have the decoration, and TextDecoration.State#NOT_SET if the decoration should not have a set value

Returns:

a component

clickEvent

public @NonNull TextComponent clickEvent(@Nullable ClickEvent event)

Description copied from interface: Component

Sets the click event of this component.

Parameters:

event - the click event

Returns:

a component

hoverEvent

public @NonNull TextComponent hoverEvent(@Nullable HoverEvent event)

Description copied from interface: Component

Sets the hover event of this component.

Parameters:

event - the hover event

Returns:

a component

insertion

public @NonNull TextComponent insertion(@Nullable java.lang.String insertion)

Description copied from interface: Component

Sets the string to be inserted when this component is shift-clicked.

Parameters:

insertion - the insertion string

Returns:

a component

mergeStyle

public @NonNull TextComponent mergeStyle(@NonNull Component that)

Description copied from interface: Component

Merges styling from another component into this component.

Parameters:

that - the other component

Returns:

a component

mergeColor

public @NonNull TextComponent mergeColor(@NonNull Component that)

Description copied from interface: Component

Merges the color from another component into this component.

Parameters:

that - the other component

Returns:

a component

mergeDecorations

public @NonNull TextComponent mergeDecorations(@NonNull Component that)

Description copied from interface: Component

Merges the decorations from another component into this component.

Parameters:

that - the other component

Returns:

a component

mergeEvents

public @NonNull TextComponent mergeEvents(@NonNull Component that)

Description copied from interface: Component

Merges the events from another component into this component.

Parameters:

that - the other component

Returns:

a component

resetStyle

public @NonNull TextComponent resetStyle()

Description copied from interface: Component

Resets all styling on this component.

Returns:

a component

copy

public @NonNull TextComponent copy()

Description copied from interface: Component

Creates a component.

Returns:

a component

equals

public boolean equals(@Nullable java.lang.Object other)

Overrides:

equals in class AbstractComponent

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractComponent

populateToString

protected void populateToString(com.google.common.base.MoreObjects.ToStringHelper builder)

Overrides:

populateToString in class AbstractComponent

toBuilder

public @NonNull TextComponent.Builder toBuilder()

Description copied from interface: BuildableComponent

Create a builder from this component.

Returns:

the builder