Package net.kyori.adventure.text

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

Type Parameters:

C - the component type

B - the builder type

All Superinterfaces:

AbstractBuilder<C>, Buildable.Builder<C>, ComponentBuilderApplicable, ComponentLike, MutableStyleSetter<B>, StyleSetter<B>

All Known Subinterfaces:

BlockNBTComponent.Builder, EntityNBTComponent.Builder, KeybindComponent.Builder, NBTComponentBuilder<C,B>, ScoreComponent.Builder, SelectorComponent.Builder, StorageNBTComponent.Builder, TextComponent.Builder, TranslatableComponent.Builder

@NonExtendable
public interface ComponentBuilder<C extends BuildableComponent<C,B>,B extends ComponentBuilder<C,B>>
extends AbstractBuilder<C>, Buildable.Builder<C>, ComponentBuilderApplicable, ComponentLike, MutableStyleSetter<B>

A component builder.

Since:

4.0.0

Method Summary

Modifier and Type	Method	Description
B	append(@NotNull java.lang.Iterable<? extends ComponentLike> components)	Appends components to this component.
B	append(@NotNull Component component)	Appends a component to this component.
B	append(@NotNull Component @NotNull ... components)	Appends components to this component.
default B	append(@NotNull ComponentBuilder<?,?> builder)	Appends a component to this component.
default B	append(@NotNull ComponentLike component)	Appends a component to this component.
B	append(@NotNull ComponentLike @NotNull ... components)	Appends components to this component.
default B	appendNewline()	Appends a newline to this component.
default B	appendSpace()	Appends a space to this component.
default B	applicableApply(@NotNull ComponentBuilderApplicable applicable)	Applies applicable.
default B	apply(@NotNull java.util.function.Consumer<? super ComponentBuilder<?,?>> consumer)	Applies an action to this builder.
B	applyDeep(@NotNull java.util.function.Consumer<? super ComponentBuilder<?,?>> action)	Applies an action to this component and all child components if they are an instance of BuildableComponent.
default @NotNull Component	asComponent()	Gets a Component representation.
C	build()	Build a component.
@NotNull java.util.List<Component>	children()	Get an unmodifiable list containing all children currently in this builder.
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 void	componentBuilderApply(@NotNull ComponentBuilder<?,?> component)	Applies to component.
default B	decorate(@NotNull TextDecoration decoration)	Sets the state of decoration to TextDecoration.State.TRUE.
default B	decorate(@NotNull TextDecoration @NotNull ... decorations)	Sets decorations to TextDecoration.State.TRUE.
default B	decoration(@NotNull TextDecoration decoration, boolean flag)	Sets the state of a decoration on this component.
B	decoration(@NotNull TextDecoration decoration, @NotNull TextDecoration.State state)	Sets the value of a decoration on this component.
B	decorationIfAbsent(@NotNull TextDecoration decoration, @NotNull TextDecoration.State state)	Sets the state of a decoration on this component to state if the current state of the decoration is TextDecoration.State.NOT_SET.
default B	decorations(@NotNull java.util.Map<TextDecoration,TextDecoration.State> decorations)	Sets decorations for this component's style using the specified decorations map.
default B	decorations(@NotNull java.util.Set<TextDecoration> decorations, boolean flag)	Sets the state of a set of decorations to flag on this component.
B	font(@Nullable Key font)	Sets the font of this component.
B	hoverEvent(@Nullable HoverEventSource<?> source)	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(@NotNull java.util.function.Function<BuildableComponent<?,?>,? extends BuildableComponent<?,?>> function)	Replaces each child of this component with the resultant component from the function.
B	mapChildrenDeep(@NotNull 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	mergeStyle(@NotNull Component that)	Merges styling from another component into this component.
B	mergeStyle(@NotNull Component that, @NotNull java.util.Set<Style.Merge> merges)	Merges styling from another component into this component.
default B	mergeStyle(@NotNull Component that, @NotNull Style.Merge @NotNull ... merges)	Merges styling from another component into this component.
B	resetStyle()	Resets all styling on this component.
B	style(@NotNull java.util.function.Consumer<Style.Builder> consumer)	Configures the style.
B	style(@NotNull Style style)	Sets the style.

Method Detail

append

@Contract("_ -> this")
@NotNull
B append(@NotNull
         @NotNull Component component)

Appends a component to this component.

Parameters:

component - the component to append

Returns:

this builder

Since:

4.0.0

append

@Contract("_ -> this")
@NotNull
default B append(@NotNull
                 @NotNull ComponentLike component)

Appends a component to this component.

Parameters:

component - the component to append

Returns:

this builder

Since:

4.0.0

append

@Contract("_ -> this")
@NotNull
default B append(@NotNull
                 @NotNull ComponentBuilder<?,?> builder)

Appends a component to this component.

Parameters:

builder - the component to append

Returns:

this builder

Since:

4.0.0

append

@Contract("_ -> this")
@NotNull
B append(@NotNull
         @NotNull Component @NotNull ... components)

Appends components to this component.

Parameters:

components - the components to append

Returns:

this builder

Since:

4.0.0

append

@Contract("_ -> this")
@NotNull
B append(@NotNull
         @NotNull ComponentLike @NotNull ... components)

Appends components to this component.

Parameters:

components - the components to append

Returns:

this builder

Since:

4.0.0

append

@Contract("_ -> this")
@NotNull
B append(@NotNull
         @NotNull java.lang.Iterable<? extends ComponentLike> components)

Appends components to this component.

Parameters:

components - the components to append

Returns:

this builder

Since:

4.0.0

appendNewline

@NotNull
default B appendNewline()

Appends a newline to this component.

Returns:

this builder

Since:

4.12.0

appendSpace

@NotNull
default B appendSpace()

Appends a space to this component.

Returns:

this builder

Since:

4.12.0

apply

@Contract("_ -> this")
@NotNull
default B apply(@NotNull
                @NotNull java.util.function.Consumer<? super ComponentBuilder<?,?>> consumer)

Applies an action to this builder.

Parameters:

consumer - the action

Returns:

this builder

Since:

4.0.0

applyDeep

@Contract("_ -> this")
@NotNull
B applyDeep(@NotNull
            @NotNull 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

Since:

4.0.0

mapChildren

@Contract("_ -> this")
@NotNull
B mapChildren(@NotNull
              @NotNull 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

Since:

4.0.0

mapChildrenDeep

@Contract("_ -> this")
@NotNull
B mapChildrenDeep(@NotNull
                  @NotNull 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

Since:

4.0.0

children

@NotNull
@NotNull java.util.List<Component> children()

Get an unmodifiable list containing all children currently in this builder.

Returns:

the list of children

Since:

4.6.0

style

@Contract("_ -> this")
@NotNull
B style(@NotNull
        @NotNull Style style)

Sets the style.

Parameters:

style - the style

Returns:

this builder

Since:

4.0.0

style

@Contract("_ -> this")
@NotNull
B style(@NotNull
        @NotNull java.util.function.Consumer<Style.Builder> consumer)

Configures the style.

Parameters:

consumer - the style consumer

Returns:

this builder

Since:

4.0.0

font

@Contract("_ -> this")
@NotNull
B font(@Nullable
       @Nullable Key font)

Sets the font of this component.

Specified by:

font in interface StyleSetter<C extends BuildableComponent<C,B>>

Parameters:

font - the font

Returns:

this builder

Since:

4.0.0

color

@Contract("_ -> this")
@NotNull
B color(@Nullable
        @Nullable TextColor color)

Sets the color of this component.

Specified by:

color in interface StyleSetter<C extends BuildableComponent<C,B>>

Parameters:

color - the color

Returns:

this builder

Since:

4.0.0

colorIfAbsent

@Contract("_ -> this")
@NotNull
B colorIfAbsent(@Nullable
                @Nullable TextColor color)

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

Specified by:

colorIfAbsent in interface StyleSetter<C extends BuildableComponent<C,B>>

Parameters:

color - the color

Returns:

this builder

Since:

4.0.0

decorations

@Contract("_, _ -> this")
@NotNull
default B decorations(@NotNull
                      @NotNull java.util.Set<TextDecoration> decorations,
                      boolean flag)

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

Specified by:

decorations in interface MutableStyleSetter<C extends BuildableComponent<C,B>>

Specified by:

decorations in interface StyleSetter<C extends BuildableComponent<C,B>>

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

Since:

4.0.0

decorate

@Contract("_ -> this")
@NotNull
default B decorate(@NotNull
                   @NotNull TextDecoration decoration)

Sets the state of decoration to TextDecoration.State.TRUE.

Specified by:

decorate in interface StyleSetter<C extends BuildableComponent<C,B>>

Parameters:

decoration - the decoration

Returns:

this builder

Since:

4.0.0

decorate

@Contract("_ -> this")
@NotNull
default B decorate(@NotNull
                   @NotNull TextDecoration @NotNull ... decorations)

Sets decorations to TextDecoration.State.TRUE.

Specified by:

decorate in interface MutableStyleSetter<C extends BuildableComponent<C,B>>

Specified by:

decorate in interface StyleSetter<C extends BuildableComponent<C,B>>

Parameters:

decorations - the decorations

Returns:

this builder

Since:

4.0.0

decoration

@Contract("_, _ -> this")
@NotNull
default B decoration(@NotNull
                     @NotNull TextDecoration decoration,
                     boolean flag)

Sets the state of a decoration on this component.

Specified by:

decoration in interface StyleSetter<C extends BuildableComponent<C,B>>

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

Since:

4.0.0

decorations

@Contract("_ -> this")
@NotNull
default B decorations(@NotNull
                      @NotNull java.util.Map<TextDecoration,TextDecoration.State> decorations)

Sets decorations for this component's style using the specified decorations map.

If a given decoration does not have a value explicitly set, the value of that particular decoration is not changed.

Specified by:

decorations in interface MutableStyleSetter<C extends BuildableComponent<C,B>>

Specified by:

decorations in interface StyleSetter<C extends BuildableComponent<C,B>>

Parameters:

decorations - a map containing text decorations and their respective state.

Returns:

this builder

Since:

4.10.0

decoration

@Contract("_, _ -> this")
@NotNull
B decoration(@NotNull
             @NotNull TextDecoration decoration,
             @NotNull TextDecoration.State state)

Sets the value of a decoration on this component.

Specified by:

decoration in interface StyleSetter<C extends BuildableComponent<C,B>>

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

Since:

4.0.0

decorationIfAbsent

@Contract("_, _ -> this")
@NotNull
B decorationIfAbsent(@NotNull
                     @NotNull TextDecoration decoration,
                     @NotNull TextDecoration.State state)

Sets the state of a decoration on this component to state if the current state of the decoration is TextDecoration.State.NOT_SET.

Specified by:

decorationIfAbsent in interface StyleSetter<C extends BuildableComponent<C,B>>

Parameters:

decoration - the decoration

state - the state

Returns:

this builder

Since:

4.12.0

clickEvent

@Contract("_ -> this")
@NotNull
B clickEvent(@Nullable
             @Nullable ClickEvent event)

Sets the click event of this component.

Specified by:

clickEvent in interface StyleSetter<C extends BuildableComponent<C,B>>

Parameters:

event - the click event

Returns:

this builder

Since:

4.0.0

hoverEvent

@Contract("_ -> this")
@NotNull
B hoverEvent(@Nullable
             @Nullable HoverEventSource<?> source)

Sets the hover event of this component.

Specified by:

hoverEvent in interface StyleSetter<C extends BuildableComponent<C,B>>

Parameters:

source - the hover event source

Returns:

this builder

Since:

4.0.0

insertion

@Contract("_ -> this")
@NotNull
B insertion(@Nullable
            @Nullable java.lang.String insertion)

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

Specified by:

insertion in interface StyleSetter<C extends BuildableComponent<C,B>>

Parameters:

insertion - the insertion string

Returns:

this builder

Since:

4.0.0

mergeStyle

@Contract("_ -> this")
@NotNull
default B mergeStyle(@NotNull
                     @NotNull Component that)

Merges styling from another component into this component.

Parameters:

that - the other component

Returns:

this builder

Since:

4.0.0

mergeStyle

@Contract("_, _ -> this")
@NotNull
default B mergeStyle(@NotNull
                     @NotNull Component that,
                     @NotNull Style.Merge @NotNull ... merges)

Merges styling from another component into this component.

Parameters:

that - the other component

merges - the parts to merge

Returns:

this builder

Since:

4.0.0

mergeStyle

@Contract("_, _ -> this")
@NotNull
B mergeStyle(@NotNull
             @NotNull Component that,
             @NotNull
             @NotNull java.util.Set<Style.Merge> merges)

Merges styling from another component into this component.

Parameters:

that - the other component

merges - the parts to merge

Returns:

this builder

Since:

4.0.0

resetStyle

@NotNull
B resetStyle()

Resets all styling on this component.

Returns:

this builder

Since:

4.0.0

build

@NotNull
C build()

Build a component.

Specified by:

build in interface AbstractBuilder<C extends BuildableComponent<C,B>>

Specified by:

build in interface Buildable.Builder<C extends BuildableComponent<C,B>>

Returns:

the component

applicableApply

@Contract("_ -> this")
@NotNull
default B applicableApply(@NotNull
                          @NotNull ComponentBuilderApplicable applicable)

Applies applicable.

Parameters:

applicable - the thing to apply

Returns:

this builder

Since:

4.0.0

componentBuilderApply

default void componentBuilderApply(@NotNull
                                   @NotNull ComponentBuilder<?,?> component)

Description copied from interface: ComponentBuilderApplicable

Applies to component.

Specified by:

componentBuilderApply in interface ComponentBuilderApplicable

Parameters:

component - the component builder

asComponent

@NotNull
default @NotNull Component asComponent()

Description copied from interface: ComponentLike

Gets a Component representation.

Specified by:

asComponent in interface ComponentLike

Returns:

a component