me.vaperion.blade.util.command

Interface RichSuggestionsBuilder

All Known Implementing Classes:

SimpleRichSuggestionsBuilder

public interface RichSuggestionsBuilder

A suggestions builder that supports rich completion metadata.

This is designed as an abstraction over Brigadier, while still allowing legacy string-only suggestions.

Method Summary

Modifier and Type	Method and Description
void	add(@NotNull RichSuggestionsBuilder other) Adds all suggestions from another builder instance.
@NotNull RichSuggestionsBuilder	createOffset(int start) Creates a new builder view with the given replacement offset.
default void	flushLegacy() Flushes legacy suggestions into this builder.
@NotNull java.lang.String	input() Returns the full input used for suggestion generation.
@NotNull SuggestionsBuilder	legacyView() Returns the legacy string-only builder view.
@NotNull java.lang.String	remaining() Returns the remaining input segment from start().
@NotNull java.lang.String	remainingLowerCase() Returns the lowercase remaining input segment from start().
@NotNull RichSuggestionsBuilder	restart() Creates a new builder view that restarts at this builder's start offset.
default void	setFilter(@Nullable java.util.function.Predicate<java.lang.String> filter) Sets the suggestion filter.
int	start() Returns the start offset where suggestions should replace text.
void	suggest(int value) Adds an integer suggestion.
default void	suggest(int value, @Nullable SuggestionTooltip tooltip) Adds an integer suggestion with optional tooltip metadata.
void	suggest(@NotNull java.lang.String text) Adds a string suggestion.
default void	suggest(@NotNull java.lang.String text, @Nullable SuggestionTooltip tooltip) Adds a string suggestion with optional tooltip metadata.
default boolean	testFilter(@NotNull java.lang.String suggestion) Tests whether a suggestion passes the current filter.

Method Detail

input

@NotNull
@NotNull java.lang.String input()

Returns the full input used for suggestion generation.

Returns:

the full input string

start

int start()

Returns the start offset where suggestions should replace text.

Returns:

the replacement start offset

remaining

@NotNull
@NotNull java.lang.String remaining()

Returns the remaining input segment from start().

Returns:

the remaining input segment

remainingLowerCase

@NotNull
@NotNull java.lang.String remainingLowerCase()

Returns the lowercase remaining input segment from start().

Returns:

the lowercase remaining input segment

suggest

void suggest(@NotNull
             @NotNull java.lang.String text)

Adds a string suggestion.

Parameters:

text - the suggested text

suggest

default void suggest(@NotNull
                     @NotNull java.lang.String text,
                     @Nullable
                     @Nullable SuggestionTooltip tooltip)

Adds a string suggestion with optional tooltip metadata.

Parameters:

text - the suggested text

tooltip - the tooltip metadata, or null

suggest

void suggest(int value)

Adds an integer suggestion.

Parameters:

value - the suggested value

suggest

default void suggest(int value,
                     @Nullable
                     @Nullable SuggestionTooltip tooltip)

Adds an integer suggestion with optional tooltip metadata.

Parameters:

value - the suggested value

tooltip - the tooltip metadata, or null

add

void add(@NotNull
         @NotNull RichSuggestionsBuilder other)

Adds all suggestions from another builder instance.

Parameters:

other - the builder to merge from

createOffset

@NotNull
@NotNull RichSuggestionsBuilder createOffset(int start)

Creates a new builder view with the given replacement offset.

Parameters:

start - the replacement start offset

Returns:

a new offset builder

restart

@NotNull
@NotNull RichSuggestionsBuilder restart()

Creates a new builder view that restarts at this builder's start offset.

Returns:

a restarted builder

legacyView

@NotNull
@NotNull SuggestionsBuilder legacyView()

Returns the legacy string-only builder view.

Returns:

the legacy suggestions builder

testFilter

default boolean testFilter(@NotNull
                           @NotNull java.lang.String suggestion)

Tests whether a suggestion passes the current filter.

Parameters:

suggestion - the suggestion to test

Returns:

true if the suggestion passes the current filter, false otherwise

setFilter

default void setFilter(@Nullable
                       @Nullable java.util.function.Predicate<java.lang.String> filter)

Sets the suggestion filter.

Only suggestions that pass this filter will be included.

Parameters:

filter - the filter predicate, or null to accept all suggestions

flushLegacy

default void flushLegacy()

Flushes legacy suggestions into this builder.