me.vaperion.blade.util.command

Class SimpleRichSuggestionsBuilder

java.lang.Object

me.vaperion.blade.util.command.SimpleRichSuggestionsBuilder

All Implemented Interfaces:

RichSuggestionsBuilder

public final class SimpleRichSuggestionsBuilder
extends java.lang.Object
implements RichSuggestionsBuilder

Constructor Summary

Constructors

Constructor and Description
SimpleRichSuggestionsBuilder(@NotNull java.lang.String input, int start)

Method Summary

Modifier and Type	Method and Description
void	add(@NotNull RichSuggestionsBuilder other) Adds all suggestions from another builder instance.
@NotNull @Unmodifiable java.util.List<java.lang.String>	build()
@NotNull RichSuggestionsBuilder	createOffset(int start) Creates a new builder view with the given replacement offset.
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 RichSuggestionsBuilder.start().
@NotNull java.lang.String	remainingLowerCase() Returns the lowercase remaining input segment from RichSuggestionsBuilder.start().
@NotNull RichSuggestionsBuilder	restart() Creates a new builder view that restarts at this builder's start offset.
void	setFilter(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.
void	suggest(@NotNull java.lang.String text) Adds a string suggestion.
boolean	testFilter(@NotNull java.lang.String suggestion) Tests whether a suggestion passes the current filter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface me.vaperion.blade.util.command.RichSuggestionsBuilder

suggest, suggest

Constructor Detail

SimpleRichSuggestionsBuilder

public SimpleRichSuggestionsBuilder(@NotNull
                                    @NotNull java.lang.String input,
                                    int start)

Method Detail

input

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

Description copied from interface: RichSuggestionsBuilder

Returns the full input used for suggestion generation.

Specified by:

input in interface RichSuggestionsBuilder

Returns:

the full input string

start

public int start()

Description copied from interface: RichSuggestionsBuilder

Returns the start offset where suggestions should replace text.

Specified by:

start in interface RichSuggestionsBuilder

Returns:

the replacement start offset

remaining

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

Description copied from interface: RichSuggestionsBuilder

Returns the remaining input segment from RichSuggestionsBuilder.start().

Specified by:

remaining in interface RichSuggestionsBuilder

Returns:

the remaining input segment

remainingLowerCase

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

Description copied from interface: RichSuggestionsBuilder

Returns the lowercase remaining input segment from RichSuggestionsBuilder.start().

Specified by:

remainingLowerCase in interface RichSuggestionsBuilder

Returns:

the lowercase remaining input segment

suggest

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

Description copied from interface: RichSuggestionsBuilder

Adds a string suggestion.

Specified by:

suggest in interface RichSuggestionsBuilder

Parameters:

text - the suggested text

suggest

public void suggest(int value)

Description copied from interface: RichSuggestionsBuilder

Adds an integer suggestion.

Specified by:

suggest in interface RichSuggestionsBuilder

Parameters:

value - the suggested value

add

public void add(@NotNull
                @NotNull RichSuggestionsBuilder other)

Description copied from interface: RichSuggestionsBuilder

Adds all suggestions from another builder instance.

Specified by:

add in interface RichSuggestionsBuilder

Parameters:

other - the builder to merge from

createOffset

@NotNull
public @NotNull RichSuggestionsBuilder createOffset(int start)

Description copied from interface: RichSuggestionsBuilder

Creates a new builder view with the given replacement offset.

Specified by:

createOffset in interface RichSuggestionsBuilder

Parameters:

start - the replacement start offset

Returns:

a new offset builder

restart

@NotNull
public @NotNull RichSuggestionsBuilder restart()

Description copied from interface: RichSuggestionsBuilder

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

Specified by:

restart in interface RichSuggestionsBuilder

Returns:

a restarted builder

legacyView

@NotNull
public @NotNull SuggestionsBuilder legacyView()

Description copied from interface: RichSuggestionsBuilder

Returns the legacy string-only builder view.

Specified by:

legacyView in interface RichSuggestionsBuilder

Returns:

the legacy suggestions builder

testFilter

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

Description copied from interface: RichSuggestionsBuilder

Tests whether a suggestion passes the current filter.

Specified by:

testFilter in interface RichSuggestionsBuilder

Parameters:

suggestion - the suggestion to test

Returns:

true if the suggestion passes the current filter, false otherwise

setFilter

public void setFilter(java.util.function.Predicate<java.lang.String> filter)

Description copied from interface: RichSuggestionsBuilder

Sets the suggestion filter.

Only suggestions that pass this filter will be included.

Specified by:

setFilter in interface RichSuggestionsBuilder

Parameters:

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

flushLegacy

public void flushLegacy()

Description copied from interface: RichSuggestionsBuilder

Flushes legacy suggestions into this builder.

Specified by:

flushLegacy in interface RichSuggestionsBuilder

build

@NotNull
public @NotNull @Unmodifiable java.util.List<java.lang.String> build()