Package org.incendo.cloud.help

Interface HelpHandler<C>

All Known Implementing Classes:

StandardHelpHandler

@API(status=STABLE)
public interface HelpHandler<C>

Method Summary

Modifier and Type	Method	Description
@NonNull HelpQueryResult<C>	query(@NonNull HelpQuery<C> query)	Handles the given query and returns the result.
default @NonNull IndexCommandResult<C>	queryRootIndex(@NonNull C sender)	Queries for the root result.

Method Details

query

@NonNull HelpQueryResult<C> query(@NonNull HelpQuery<C> query)

Handles the given query and returns the result.

If nothing matched the query, an empty IndexCommandResult will be returned.

Parameters:

query - the query

Returns:

the result

queryRootIndex

default @NonNull IndexCommandResult<C> queryRootIndex(@NonNull C sender)

Queries for the root result. This is the result from invoking query(HelpQuery) with an empty string.

Parameters:

sender - the sender

Returns:

the result