me.vaperion.blade.platform.api

Interface HelpGenerator<Text>

All Known Implementing Classes:

HelpGenerator.Default

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface HelpGenerator<Text>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HelpGenerator.Default<T>

Field Summary

Fields

Modifier and Type	Field and Description
static int	RESULTS_PER_PAGE

Method Summary

Modifier and Type	Method and Description
default @NotNull java.util.List<BladeCommand>	filterCommands(@NotNull Context context, @NotNull java.util.List<BladeCommand> commands, @NotNull java.lang.String filterInput) Filters the provided list of commands based on visibility and a filter input.
@NotNull java.util.List<Text>	generate(@NotNull Context context, @NotNull java.util.List<BladeCommand> commands) Generates help text for the given list of commands within the provided context.

Field Detail

RESULTS_PER_PAGE

static final int RESULTS_PER_PAGE

See Also:

Constant Field Values

Method Detail

generate

@NotNull
@NotNull java.util.List<Text> generate(@NotNull
                                                @NotNull Context context,
                                                @NotNull
                                                @NotNull java.util.List<BladeCommand> commands)

Generates help text for the given list of commands within the provided context.

Parameters:

context - the context in which the help is generated

commands - the list of commands to generate help for

Returns:

a list of help text entries

filterCommands

@ApiStatus.NonExtendable
 @NotNull
default @NotNull java.util.List<BladeCommand> filterCommands(@NotNull
                                                                                                @NotNull Context context,
                                                                                                @NotNull
                                                                                                @NotNull java.util.List<BladeCommand> commands,
                                                                                                @NotNull
                                                                                                @NotNull java.lang.String filterInput)

Filters the provided list of commands based on visibility and a filter input.

Parameters:

context - the context in which the filtering is performed

commands - the list of commands to filter

filterInput - the input string used for filtering commands

Returns:

a list of filtered commands