net.kyori.text

Class TranslatableComponent

java.lang.Object

net.kyori.text.AbstractComponent

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

net.kyori.text.TranslatableComponent

All Implemented Interfaces:

BuildableComponent<TranslatableComponent,TranslatableComponent.Builder>, Component

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

A translatable text component.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TranslatableComponent.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	TranslatableComponent(@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 key, @NonNull java.util.List<Component> args)
protected	TranslatableComponent(@NonNull TranslatableComponent.Builder builder)

Method Summary

Modifier and Type	Method and Description
@NonNull TranslatableComponent	append(@NonNull Component component) Appends a component to this component.
@NonNull java.util.List<Component>	args() Gets the unmodifiable list of translation arguments.
@NonNull TranslatableComponent	args(@NonNull java.util.List<Component> args) Sets the translation arguments for this component.
static TranslatableComponent.Builder	builder() Creates a translatable component builder.
static TranslatableComponent.Builder	builder(@NonNull java.lang.String key) Creates a translatable component builder with a translation key.
@NonNull TranslatableComponent	clickEvent(@Nullable ClickEvent event) Sets the click event of this component.
@NonNull TranslatableComponent	color(@Nullable TextColor color) Sets the color of this component.
@NonNull TranslatableComponent	copy() Creates a component.
@NonNull TranslatableComponent	decoration(@NonNull TextDecoration decoration, boolean flag) Sets the state of a decoration on this component.
@NonNull TranslatableComponent	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 TranslatableComponent	hoverEvent(@Nullable HoverEvent event) Sets the hover event of this component.
@NonNull TranslatableComponent	insertion(@Nullable java.lang.String insertion) Sets the string to be inserted when this component is shift-clicked.
@NonNull java.lang.String	key() Gets the translation key.
@NonNull TranslatableComponent	key(@NonNull java.lang.String key) Sets the translation key.
static TranslatableComponent	make(@NonNull java.util.function.Consumer<TranslatableComponent.Builder> consumer) Creates a translatable component by applying configuration from consumer.
static TranslatableComponent	make(@NonNull java.lang.String key, @NonNull java.util.function.Consumer<TranslatableComponent.Builder> consumer) Creates a translatable component by applying configuration from consumer.
static TranslatableComponent	make(@NonNull java.lang.String key, @NonNull java.util.List<Component> args, @NonNull java.util.function.Consumer<TranslatableComponent.Builder> consumer) Creates a translatable component by applying configuration from consumer.
@NonNull TranslatableComponent	mergeColor(@NonNull Component that) Merges the color from another component into this component.
@NonNull TranslatableComponent	mergeDecorations(@NonNull Component that) Merges the decorations from another component into this component.
@NonNull TranslatableComponent	mergeEvents(@NonNull Component that) Merges the events from another component into this component.
@NonNull TranslatableComponent	mergeStyle(@NonNull Component that) Merges styling from another component into this component.
static TranslatableComponent	of(@NonNull java.lang.String key) Creates a translatable component with a translation key.
static TranslatableComponent	of(@NonNull java.lang.String key, Component... args) Creates a translatable component with a translation key and arguments.
static TranslatableComponent	of(@NonNull java.lang.String key, @NonNull java.util.List<Component> args) Creates a translatable component with a translation key and arguments.
static TranslatableComponent	of(@NonNull java.lang.String key, @Nullable TextColor color) Creates a translatable component with a translation key.
static TranslatableComponent	of(@NonNull java.lang.String key, @Nullable TextColor color, Component... args) Creates a translatable component with a translation key and arguments.
static TranslatableComponent	of(@NonNull java.lang.String key, @Nullable TextColor color, @NonNull java.util.List<Component> args) Creates a translatable component with a translation key and arguments.
static TranslatableComponent	of(@NonNull java.lang.String key, @Nullable TextColor color, @NonNull java.util.Set<TextDecoration> decorations) Creates a translatable component with a translation key.
static TranslatableComponent	of(@NonNull java.lang.String key, @Nullable TextColor color, @NonNull java.util.Set<TextDecoration> decorations, Component... args) Creates a translatable component with a translation key and arguments.
static TranslatableComponent	of(@NonNull java.lang.String key, @Nullable TextColor color, @NonNull java.util.Set<TextDecoration> decorations, @NonNull java.util.List<Component> args) Creates a translatable component with a translation key and arguments.
protected void	populateToString(com.google.common.base.MoreObjects.ToStringHelper builder)
@NonNull TranslatableComponent	resetStyle() Resets all styling on this component.
@NonNull TranslatableComponent.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

TranslatableComponent

protected TranslatableComponent(@NonNull TranslatableComponent.Builder builder)

TranslatableComponent

protected TranslatableComponent(@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 key,
                                @NonNull java.util.List<Component> args)

Method Detail

builder

public static TranslatableComponent.Builder builder()

Creates a translatable component builder.

Returns:

a builder

builder

public static TranslatableComponent.Builder builder(@NonNull java.lang.String key)

Creates a translatable component builder with a translation key.

Parameters:

key - the translation key

Returns:

a builder

of

public static TranslatableComponent of(@NonNull java.lang.String key)

Creates a translatable component with a translation key.

Parameters:

key - the translation key

Returns:

the translatable component

of

public static TranslatableComponent of(@NonNull java.lang.String key,
                                       @Nullable TextColor color)

Creates a translatable component with a translation key.

Parameters:

key - the translation key

color - the color

Returns:

the translatable component

of

public static TranslatableComponent of(@NonNull java.lang.String key,
                                       @Nullable TextColor color,
                                       @NonNull java.util.Set<TextDecoration> decorations)

Creates a translatable component with a translation key.

Parameters:

key - the translation key

color - the color

decorations - the decorations

Returns:

the translatable component

of

public static TranslatableComponent of(@NonNull java.lang.String key,
                                       Component... args)

Creates a translatable component with a translation key and arguments.

Parameters:

key - the translation key

args - the translation arguments

Returns:

the translatable component

of

public static TranslatableComponent of(@NonNull java.lang.String key,
                                       @Nullable TextColor color,
                                       Component... args)

Creates a translatable component with a translation key and arguments.

Parameters:

key - the translation key

color - the color

args - the translation arguments

Returns:

the translatable component

of

public static TranslatableComponent of(@NonNull java.lang.String key,
                                       @Nullable TextColor color,
                                       @NonNull java.util.Set<TextDecoration> decorations,
                                       Component... args)

Creates a translatable component with a translation key and arguments.

Parameters:

key - the translation key

color - the color

decorations - the decorations

args - the translation arguments

Returns:

the translatable component

of

public static TranslatableComponent of(@NonNull java.lang.String key,
                                       @NonNull java.util.List<Component> args)

Creates a translatable component with a translation key and arguments.

Parameters:

key - the translation key

args - the translation arguments

Returns:

the translatable component

of

public static TranslatableComponent of(@NonNull java.lang.String key,
                                       @Nullable TextColor color,
                                       @NonNull java.util.List<Component> args)

Creates a translatable component with a translation key and arguments.

Parameters:

key - the translation key

color - the color

args - the translation arguments

Returns:

the translatable component

of

public static TranslatableComponent of(@NonNull java.lang.String key,
                                       @Nullable TextColor color,
                                       @NonNull java.util.Set<TextDecoration> decorations,
                                       @NonNull java.util.List<Component> args)

Creates a translatable component with a translation key and arguments.

Parameters:

key - the translation key

color - the color

decorations - the decorations

args - the translation arguments

Returns:

the translatable component

make

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

Creates a translatable component by applying configuration from consumer.

Parameters:

consumer - the builder configurator

Returns:

the translatable component

make

public static TranslatableComponent make(@NonNull java.lang.String key,
                                         @NonNull java.util.function.Consumer<TranslatableComponent.Builder> consumer)

Creates a translatable component by applying configuration from consumer.

Parameters:

key - the translation key

consumer - the builder configurator

Returns:

the translatable component

make

public static TranslatableComponent make(@NonNull java.lang.String key,
                                         @NonNull java.util.List<Component> args,
                                         @NonNull java.util.function.Consumer<TranslatableComponent.Builder> consumer)

Creates a translatable component by applying configuration from consumer.

Parameters:

key - the translation key

args - the translation arguments

consumer - the builder configurator

Returns:

the translatable component

key

public @NonNull java.lang.String key()

Gets the translation key.

Returns:

the translation key

key

public @NonNull TranslatableComponent key(@NonNull java.lang.String key)

Sets the translation key.

Parameters:

key - the translation key

Returns:

a copy of this component

args

public @NonNull java.util.List<Component> args()

Gets the unmodifiable list of translation arguments.

Returns:

the unmodifiable list of translation arguments

args

public @NonNull TranslatableComponent args(@NonNull java.util.List<Component> args)

Sets the translation arguments for this component.

Parameters:

args - the translation arguments

Returns:

this component

append

public @NonNull TranslatableComponent 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 TranslatableComponent 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 TranslatableComponent 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 TranslatableComponent 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 TranslatableComponent 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 TranslatableComponent 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 TranslatableComponent 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 TranslatableComponent 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 TranslatableComponent 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 TranslatableComponent 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 TranslatableComponent 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 TranslatableComponent resetStyle()

Description copied from interface: Component

Resets all styling on this component.

Returns:

a component

copy

public @NonNull TranslatableComponent 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 TranslatableComponent.Builder toBuilder()

Description copied from interface: BuildableComponent

Create a builder from this component.

Returns:

the builder