Package org.incendo.cloud.help.result

Interface MultipleCommandResult<C>

Type Parameters:

C - the command sender type

All Superinterfaces:

HelpQueryResult<C>

@Immutable
@API(status=STABLE)
public interface MultipleCommandResult<C>
extends HelpQueryResult<C>

A list of commands.

This is the result of a query that is not specific enough to point to a single command, but unlike IndexCommandResult this is guaranteed to not be empty.

The longestPath() is the longest command path shared between all the results, and the childSuggestions()} are the commands that share that common path.

Method Summary

Modifier and Type	Method	Description
@NonNull List<@NonNull String>	childSuggestions()	Returns syntax hints for the children.
@NonNull String	longestPath()	Returns the longest path shared between the children.
static <C> @NonNull MultipleCommandResult<C>	of(@NonNull HelpQuery<C> query, @NonNull String longestPath, @NonNull List<@NonNull String> childSuggestions)	Creates a new result.
@NonNull HelpQuery<C>	query()	Returns the query.

Methods inherited from interface org.incendo.cloud.help.result.HelpQueryResult

render

Method Details

of

static <C> @NonNull MultipleCommandResult<C> of(@NonNull HelpQuery<C> query,
 @NonNull String longestPath,
 @NonNull List<@NonNull String> childSuggestions)

Creates a new result.

Type Parameters:

C - the command sender type

Parameters:

query - the query that prompted the result

longestPath - the longest shared result

childSuggestions - the syntax hints for the children

Returns:

the result

query

@NonNull HelpQuery<C> query()

Returns the query.

Specified by:

query in interface HelpQueryResult<C>

Returns:

the query

longestPath

@NonNull String longestPath()

Returns the longest path shared between the children.

Returns:

the longest shared path

childSuggestions

@NonNull List<@NonNull String> childSuggestions()

Returns syntax hints for the children.

Returns:

child suggestions