Package org.incendo.cloud.help

Interface HelpQuery<C>

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

Method Summary

Modifier and Type	Method	Description
static <C> @NonNull HelpQuery<C>	of(@NonNull C sender, @NonNull String query)	Creates a new help query.
@NonNull String	query()	Returns the query string.
@NonNull C	sender()	Returns the command sender.

Method Details

of

static <C> @NonNull HelpQuery<C> of(@NonNull C sender,
 @NonNull String query)

Creates a new help query.

Type Parameters:

C - the command sender type

Parameters:

sender - the creator of the query

query - the query string

Returns:

the created help query instance

sender

@NonNull C sender()

Returns the command sender.

Returns:

the command sender

query

@NonNull String query()

Returns the query string.

Returns:

the query string