me.vaperion.blade.util.command

Class SuggestionsBuilder

java.lang.Object

me.vaperion.blade.util.command.SuggestionsBuilder

public final class SuggestionsBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
SuggestionsBuilder()

Method Summary

Modifier and Type	Method and Description
@NotNull @Unmodifiable java.util.List<java.lang.String>	build() Builds the list of suggestions.
void	clear() Clears all current suggestions.
int	count() Returns the number of suggestions currently stored.
void	setFilter(@Nullable java.util.function.Predicate<java.lang.String> filter) Sets a filter for suggestions.
void	suggest(@NotNull java.lang.String suggestion) Adds a suggestion.
boolean	testFilter(@NotNull java.lang.String suggestion) Tests if a suggestion passes the current filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

SuggestionsBuilder

public SuggestionsBuilder()

Method Detail

testFilter

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

Tests if a suggestion passes the current filter.

Parameters:

suggestion - the suggestion to test

Returns:

true if the suggestion passes the filter, false otherwise

setFilter

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

Sets a filter for suggestions.

Only suggestions that pass the filter will be included in the final list.

Parameters:

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

clear

public void clear()

Clears all current suggestions.

suggest

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

Adds a suggestion.

If the suggestion already exists, it will not be added again.

Parameters:

suggestion - the suggestion to add

count

public int count()

Returns the number of suggestions currently stored.

Returns:

the count of suggestions

build

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

Builds the list of suggestions.

Returns:

an unmodifiable list of suggestions