net.kyori.text

Interface ComponentBuilder<C extends BuildableComponent<C,B>,B extends ComponentBuilder<C,B>>

Type Parameters:

C - the component type

B - the builder type

All Known Subinterfaces:

BlockNbtComponent.Builder, EntityNbtComponent.Builder, KeybindComponent.Builder, NbtComponentBuilder<C,B>, ScoreComponent.Builder, SelectorComponent.Builder, TextComponent.Builder, TranslatableComponent.Builder

public interface ComponentBuilder<C extends BuildableComponent<C,B>,B extends ComponentBuilder<C,B>>

A component builder.

Method Summary

Modifier and Type	Method and Description
B	append(@NonNull Component component) Appends a component to this component.
default B	append(@NonNull ComponentBuilder<?,?> builder) Appends a component to this component.
B	append(@NonNull java.lang.Iterable<? extends Component> components) Appends components to this component.
default B	append(@NonNull java.lang.String content) Appends a text component to this component.
default B	append(@NonNull java.lang.String content, @NonNull java.util.function.Consumer<? super TextComponent.Builder> builder) Appends a text component to this component.
default B	append(@NonNull java.lang.String content, @NonNull TextColor color) Appends a text component to this component.
default B	append(@NonNull java.lang.String content, @NonNull TextColor color, TextDecoration... decorations) Appends a text component to this component.
default B	apply(@NonNull java.util.function.Consumer<? super ComponentBuilder<?,?>> consumer) Applies an action to this builder.
B	applyDeep(@NonNull java.util.function.Consumer<? super ComponentBuilder<?,?>> action) Applies an action to this component and all child components if they are an instance of BuildableComponent.
C	build() Build a component.
B	clickEvent(@Nullable ClickEvent event) Sets the click event of this component.
B	color(@Nullable TextColor color) Sets the color of this component.
B	colorIfAbsent(@Nullable TextColor color) Sets the color of this component if there isn't one set already.
default B	decoration(@NonNull TextDecoration decoration, boolean flag) Sets the state of a decoration on this component.
B	decoration(@NonNull TextDecoration decoration, TextDecoration.State state) Sets the value of a decoration on this component.
default B	decorations(@NonNull java.util.Set<TextDecoration> decorations, boolean flag) Sets the state of a set of decorations to flag on this component.
B	hoverEvent(@Nullable HoverEvent event) Sets the hover event of this component.
B	insertion(@Nullable java.lang.String insertion) Sets the string to be inserted when this component is shift-clicked.
B	mapChildren(@NonNull java.util.function.Function<BuildableComponent<?,?>,? extends BuildableComponent<?,?>> function) Replaces each child of this component with the resultant component from the function.
B	mapChildrenDeep(@NonNull java.util.function.Function<BuildableComponent<?,?>,? extends BuildableComponent<?,?>> function) Replaces each child and sub-child of this component with the resultant component of the function.
default B	mergeColor(@NonNull Component that) Merges the color from another component into this component.
default B	mergeDecorations(@NonNull Component that) Merges the decorations from another component into this component.
default B	mergeEvents(@NonNull Component that) Merges the events from another component into this component.
default B	mergeStyle(@NonNull Component that) Merges styling from another component into this component.
B	resetStyle() Resets all styling on this component.
B	style(@NonNull Style style) Sets the style.

Method Detail

append

default B append(@NonNull java.lang.String content)

Appends a text component to this component.

Parameters:

content - the content

Returns:

this builder

append

default B append(@NonNull java.lang.String content,
                 @NonNull TextColor color)

Appends a text component to this component.

Parameters:

content - the content

color - the color

Returns:

this builder

append

default B append(@NonNull java.lang.String content,
                 @NonNull TextColor color,
                 TextDecoration... decorations)

Appends a text component to this component.

Parameters:

content - the content

color - the color

decorations - the decorations

Returns:

this builder

append

default B append(@NonNull java.lang.String content,
                 @NonNull java.util.function.Consumer<? super TextComponent.Builder> builder)

Appends a text component to this component.

Parameters:

content - the content

builder - the builder

Returns:

this builder

append

B append(@NonNull Component component)

Appends a component to this component.

Parameters:

component - the component to append

Returns:

this builder

append

default B append(@NonNull ComponentBuilder<?,?> builder)

Appends a component to this component.

Parameters:

builder - the component to append

Returns:

this builder

append

B append(@NonNull java.lang.Iterable<? extends Component> components)

Appends components to this component.

Parameters:

components - the components to append

Returns:

this builder

apply

default B apply(@NonNull java.util.function.Consumer<? super ComponentBuilder<?,?>> consumer)

Applies an action to this builder.

Parameters:

consumer - the action

Returns:

this builder

applyDeep

B applyDeep(@NonNull java.util.function.Consumer<? super ComponentBuilder<?,?>> action)

Applies an action to this component and all child components if they are an instance of BuildableComponent.

Parameters:

action - the action

Returns:

this builder

mapChildren

B mapChildren(@NonNull java.util.function.Function<BuildableComponent<?,?>,? extends BuildableComponent<?,?>> function)

Replaces each child of this component with the resultant component from the function.

Parameters:

function - the mapping function

Returns:

this builder

mapChildrenDeep

B mapChildrenDeep(@NonNull java.util.function.Function<BuildableComponent<?,?>,? extends BuildableComponent<?,?>> function)

Replaces each child and sub-child of this component with the resultant component of the function.

Parameters:

function - the mapping function

Returns:

this builder

style

B style(@NonNull Style style)

Sets the style.

Parameters:

style - the style

Returns:

this builder

color

B color(@Nullable TextColor color)

Sets the color of this component.

Parameters:

color - the color

Returns:

this builder

colorIfAbsent

B colorIfAbsent(@Nullable TextColor color)

Sets the color of this component if there isn't one set already.

Parameters:

color - the color

Returns:

this builder

decorations

default B decorations(@NonNull java.util.Set<TextDecoration> decorations,
                      boolean flag)

Sets the state of a set of decorations to flag on this component.

Parameters:

decorations - the decorations

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

Returns:

this builder

decoration

default B decoration(@NonNull TextDecoration decoration,
                     boolean flag)

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:

this builder

decoration

B decoration(@NonNull TextDecoration decoration,
             TextDecoration.State state)

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:

this builder

clickEvent

B clickEvent(@Nullable ClickEvent event)

Sets the click event of this component.

Parameters:

event - the click event

Returns:

this builder

hoverEvent

B hoverEvent(@Nullable HoverEvent event)

Sets the hover event of this component.

Parameters:

event - the hover event

Returns:

this builder

insertion

B insertion(@Nullable java.lang.String insertion)

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

Parameters:

insertion - the insertion string

Returns:

this builder

mergeStyle

default B mergeStyle(@NonNull Component that)

Merges styling from another component into this component.

Parameters:

that - the other component

Returns:

this builder

mergeColor

default B mergeColor(@NonNull Component that)

Merges the color from another component into this component.

Parameters:

that - the other component

Returns:

this builder

mergeDecorations

default B mergeDecorations(@NonNull Component that)

Merges the decorations from another component into this component.

Parameters:

that - the other component

Returns:

this builder

mergeEvents

default B mergeEvents(@NonNull Component that)

Merges the events from another component into this component.

Parameters:

that - the other component

Returns:

this builder

resetStyle

B resetStyle()

Resets all styling on this component.

Returns:

this builder

build

C build()

Build a component.

Returns:

the component