Package org.incendo.cloud.help
Interface HelpHandler<C>
- All Known Implementing Classes:
StandardHelpHandler
-
Method Summary
Modifier and TypeMethodDescriptionHandles the givenqueryand returns the result.default @NonNull IndexCommandResult<C> queryRootIndex(@NonNull C sender) Queries for the root result.
-
Method Details
-
query
Handles the givenqueryand returns the result.If nothing matched the query, an empty
IndexCommandResultwill be returned.- Parameters:
query- the query- Returns:
- the result
-
queryRootIndex
Queries for the root result. This is the result from invokingquery(HelpQuery)with an empty string.- Parameters:
sender- the sender- Returns:
- the result
-