Package org.incendo.cloud.help.result

Interface VerboseCommandResult<C>

Type Parameters:

C - the command sender type

All Superinterfaces:

HelpQueryResult<C>

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

Verbose information about a single command.

This is displayed when the help query is precise enough to point to a single command.

Method Summary

Modifier and Type	Method	Description
@NonNull CommandEntry<C>	entry()	Returns the command entry.
static <C> @NonNull VerboseCommandResult<C>	of(@NonNull HelpQuery<C> query, @NonNull CommandEntry<C> entry)	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 VerboseCommandResult<C> of(@NonNull HelpQuery<C> query,
 @NonNull CommandEntry<C> entry)

Creates a new result.

Type Parameters:

C - the command sender type

Parameters:

query - the query that prompted the result

entry - the entry

Returns:

the result

query

@NonNull HelpQuery<C> query()

Returns the query.

Specified by:

query in interface HelpQueryResult<C>

Returns:

the query

entry

@NonNull CommandEntry<C> entry()

Returns the command entry.

Returns:

the entry