net.kyori.text

Interface KeybindComponent

All Superinterfaces:

BuildableComponent<KeybindComponent,KeybindComponent.Builder>, Component, ScopedComponent<KeybindComponent>

public interface KeybindComponent
extends BuildableComponent<KeybindComponent,KeybindComponent.Builder>, ScopedComponent<KeybindComponent>

A keybind component.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	KeybindComponent.Builder A keybind component builder.

Method Summary

Modifier and Type	Method and Description
static @NonNull KeybindComponent.Builder	builder() Creates a keybind component builder.
static @NonNull KeybindComponent.Builder	builder(@NonNull java.lang.String keybind) Creates a keybind component builder with a keybind.
@NonNull java.lang.String	keybind() Gets the keybind.
@NonNull KeybindComponent	keybind(@NonNull java.lang.String keybind) Sets the keybind.
static @NonNull KeybindComponent	make(@NonNull java.util.function.Consumer<? super KeybindComponent.Builder> consumer) Creates a keybind component by applying configuration from consumer.
static @NonNull KeybindComponent	make(@NonNull java.lang.String keybind, @NonNull java.util.function.Consumer<? super KeybindComponent.Builder> consumer) Creates a keybind component by applying configuration from consumer.
static @NonNull KeybindComponent	of(@NonNull java.lang.String keybind) Creates a keybind component with a keybind.
static @NonNull KeybindComponent	of(@NonNull java.lang.String keybind, @Nullable TextColor color) Creates a keybind component with content, and optional color.
static @NonNull KeybindComponent	of(@NonNull java.lang.String keybind, @Nullable TextColor color, @NonNull java.util.Set<TextDecoration> decorations) Creates a keybind component with content, and optional color and decorations.
static @NonNull KeybindComponent	of(@NonNull java.lang.String content, @Nullable TextColor color, TextDecoration... decorations) Creates a keybind component with content, and optional color and decorations.

Methods inherited from interface net.kyori.text.BuildableComponent

toBuilder

Methods inherited from interface net.kyori.text.ScopedComponent

append, append, children, clickEvent, color, decoration, decoration, hoverEvent, insertion, mergeColor, mergeDecorations, mergeEvents

Methods inherited from interface net.kyori.text.Component

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

Method Detail

builder

static @NonNull KeybindComponent.Builder builder()

Creates a keybind component builder.

Returns:

a builder

builder

static @NonNull KeybindComponent.Builder builder(@NonNull java.lang.String keybind)

Creates a keybind component builder with a keybind.

Parameters:

keybind - the keybind

Returns:

a builder

of

static @NonNull KeybindComponent of(@NonNull java.lang.String keybind)

Creates a keybind component with a keybind.

Parameters:

keybind - the keybind

Returns:

the keybind component

of

static @NonNull KeybindComponent of(@NonNull java.lang.String keybind,
                                    @Nullable TextColor color)

Creates a keybind component with content, and optional color.

Parameters:

keybind - the keybind

color - the color

Returns:

the keybind component

of

static @NonNull KeybindComponent of(@NonNull java.lang.String content,
                                    @Nullable TextColor color,
                                    TextDecoration... decorations)

Creates a keybind component with content, and optional color and decorations.

Parameters:

content - the plain text content

color - the color

decorations - the decorations

Returns:

the keybind component

of

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

Creates a keybind component with content, and optional color and decorations.

Parameters:

keybind - the keybind

color - the color

decorations - the decorations

Returns:

the keybind component

make

static @NonNull KeybindComponent make(@NonNull java.util.function.Consumer<? super KeybindComponent.Builder> consumer)

Creates a keybind component by applying configuration from consumer.

Parameters:

consumer - the builder configurator

Returns:

the keybind component

make

static @NonNull KeybindComponent make(@NonNull java.lang.String keybind,
                                      @NonNull java.util.function.Consumer<? super KeybindComponent.Builder> consumer)

Creates a keybind component by applying configuration from consumer.

Parameters:

keybind - the keybind

consumer - the builder configurator

Returns:

the keybind component

keybind

@NonNull java.lang.String keybind()

Gets the keybind.

Returns:

the keybind

keybind

@NonNull KeybindComponent keybind(@NonNull java.lang.String keybind)

Sets the keybind.

Parameters:

keybind - the keybind

Returns:

a copy of this component