All Superinterfaces:

AbstractBuilder<Style>, Buildable.Builder<Style>, MutableStyleSetter<Style.Builder>, StyleSetter<Style.Builder>

Enclosing interface:

Style
```
public static interface Style.Builder
extends AbstractBuilder<Style>, Buildable.Builder<Style>, MutableStyleSetter<Style.Builder>
```
A style builder.

Since:

4.0.0

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default @NotNull Style.Builder`	`apply(@NotNull StyleBuilderApplicable applicable)`	Applies `applicable` to this builder.
`@NotNull Style`	`build()`	Builds the style.
`@NotNull Style.Builder`	`clickEvent(@Nullable ClickEvent event)`	Sets the click event.
`@NotNull Style.Builder`	`color(@Nullable TextColor color)`	Sets the color.
`@NotNull Style.Builder`	`colorIfAbsent(@Nullable TextColor color)`	Sets the color if there isn't one set already.
`default @NotNull Style.Builder`	`decorate(@NotNull TextDecoration decoration)`	Sets `decoration` to `TextDecoration.State.TRUE`.
`default @NotNull Style.Builder`	`decorate(@NotNull TextDecoration @NotNull ... decorations)`	Sets `decorations` to `TextDecoration.State.TRUE`.
`default @NotNull Style.Builder`	`decoration(@NotNull TextDecoration decoration, boolean flag)`	Sets the state of a decoration on this style.
`@NotNull Style.Builder`	`decoration(@NotNull TextDecoration decoration, @NotNull TextDecoration.State state)`	Sets the value of a decoration.
`@NotNull Style.Builder`	`decorationIfAbsent(@NotNull TextDecoration decoration, @NotNull TextDecoration.State state)`	Sets the state of a decoration on this style to `state` if the current state of the decoration is `TextDecoration.State.NOT_SET`.
`default @NotNull Style.Builder`	`decorations(@NotNull java.util.Map<TextDecoration,TextDecoration.State> decorations)`	Sets decorations for this style using the specified `decorations` map.
`@NotNull Style.Builder`	`font(@Nullable Key font)`	Sets the font.
`@NotNull Style.Builder`	`hoverEvent(@Nullable HoverEventSource<?> source)`	Sets the hover event.
`@NotNull Style.Builder`	`insertion(@Nullable java.lang.String insertion)`	Sets the string to be inserted.
`default @NotNull Style.Builder`	`merge(@NotNull Style that)`	Merges from another style into this style.
`default @NotNull Style.Builder`	`merge(@NotNull Style that, @NotNull java.util.Set<Style.Merge> merges)`	Merges from another style into this style.
`default @NotNull Style.Builder`	`merge(@NotNull Style that, @NotNull Style.Merge.Strategy strategy)`	Merges from another style into this style.
`@NotNull Style.Builder`	`merge(@NotNull Style that, @NotNull Style.Merge.Strategy strategy, @NotNull java.util.Set<Style.Merge> merges)`	Merges from another style into this style.
`default @NotNull Style.Builder`	`merge(@NotNull Style that, @NotNull Style.Merge.Strategy strategy, @NotNull Style.Merge @NotNull ... merges)`	Merges from another style into this style.
`default @NotNull Style.Builder`	`merge(@NotNull Style that, @NotNull Style.Merge @NotNull ... merges)`	Merges from another style into this style.

Methods inherited from interface net.kyori.adventure.text.format.MutableStyleSetter
decorations

Method Detail

font
```
@Contract("_ -> this")
@NotNull
@NotNull Style.Builder font(@Nullable
                            @Nullable Key font)
```
Sets the font.

Specified by:

font in interface StyleSetter<Style.Builder>

Parameters:

font - the font

Returns:

this builder

Since:

4.0.0

Since Minecraft:

1.16

color

@Contract("_ -> this")
@NotNull
@NotNull Style.Builder color(@Nullable
                             @Nullable TextColor color)

Sets the color.

Specified by:: color in interface StyleSetter<Style.Builder>
Parameters:: color - the color
Returns:: this builder
Since:: 4.0.0

colorIfAbsent
```
@Contract("_ -> this")
@NotNull
@NotNull Style.Builder colorIfAbsent(@Nullable
                                     @Nullable TextColor color)
```
Sets the color if there isn't one set already.

Specified by:

colorIfAbsent in interface StyleSetter<Style.Builder>

Parameters:

color - the color

Returns:

this builder

Since:

4.0.0

decorate
```
@Contract("_ -> this")
@NotNull
default @NotNull Style.Builder decorate(@NotNull
                                        @NotNull TextDecoration decoration)
```
Sets decoration to TextDecoration.State.TRUE.

Specified by:

decorate in interface StyleSetter<Style.Builder>

Parameters:

decoration - the decoration

Returns:

a style

Since:

4.0.0

decorate
```
@Contract("_ -> this")
@NotNull
default @NotNull Style.Builder decorate(@NotNull
                                        @NotNull TextDecoration @NotNull ... decorations)
```
Sets decorations to TextDecoration.State.TRUE.

Specified by:

decorate in interface MutableStyleSetter<Style.Builder>

Specified by:

decorate in interface StyleSetter<Style.Builder>

Parameters:

decorations - the decorations

Returns:

a style

Since:

4.0.0

decoration
```
@Contract("_, _ -> this")
@NotNull
default @NotNull Style.Builder decoration(@NotNull
                                          @NotNull TextDecoration decoration,
                                          boolean flag)
```
Sets the state of a decoration on this style.

Specified by:

decoration in interface StyleSetter<Style.Builder>

Parameters:

decoration - the decoration

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

Returns:

a style

Since:

4.0.0

decorations
```
@Contract("_ -> this")
@NotNull
default @NotNull Style.Builder decorations(@NotNull
                                           @NotNull java.util.Map<TextDecoration,TextDecoration.State> decorations)
```
Sets decorations for this 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<Style.Builder>

Specified by:

decorations in interface StyleSetter<Style.Builder>

Parameters:

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

Returns:

this builder.

Since:

4.10.0

decoration
```
@Contract("_, _ -> this")
@NotNull
@NotNull Style.Builder decoration(@NotNull
                                  @NotNull TextDecoration decoration,
                                  @NotNull TextDecoration.State state)
```
Sets the value of a decoration.

Specified by:

decoration in interface StyleSetter<Style.Builder>

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
@NotNull Style.Builder decorationIfAbsent(@NotNull
                                          @NotNull TextDecoration decoration,
                                          @NotNull TextDecoration.State state)
```
Sets the state of a decoration on this style to state if the current state of the decoration is TextDecoration.State.NOT_SET.

Specified by:

decorationIfAbsent in interface StyleSetter<Style.Builder>

Parameters:

decoration - the decoration

state - the state

Returns:

this builder

Since:

4.12.0

clickEvent
```
@Contract("_ -> this")
@NotNull
@NotNull Style.Builder clickEvent(@Nullable
                                  @Nullable ClickEvent event)
```
Sets the click event.

Specified by:

clickEvent in interface StyleSetter<Style.Builder>

Parameters:

event - the click event

Returns:

this builder

Since:

4.0.0

hoverEvent
```
@Contract("_ -> this")
@NotNull
@NotNull Style.Builder hoverEvent(@Nullable
                                  @Nullable HoverEventSource<?> source)
```
Sets the hover event.

Specified by:

hoverEvent in interface StyleSetter<Style.Builder>

Parameters:

source - the hover event source

Returns:

this builder

Since:

4.0.0

insertion
```
@Contract("_ -> this")
@NotNull
@NotNull Style.Builder insertion(@Nullable
                                 @Nullable java.lang.String insertion)
```
Sets the string to be inserted.

Specified by:

insertion in interface StyleSetter<Style.Builder>

Parameters:

insertion - the insertion string

Returns:

this builder

Since:

4.0.0