Package org.incendo.cloud.help

Interface HelpHandlerFactory<C>

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

Method Summary

Modifier and Type	Method	Description
@NonNull HelpHandler<C>	createHelpHandler(@NonNull CommandPredicate<C> filter)	Creates a new help handler.
static <C> @NonNull HelpHandlerFactory<C>	standard(@NonNull CommandManager<C> commandManager)	Returns a factory that produces instances of StandardHelpHandler.

Method Details

standard

static <C> @NonNull HelpHandlerFactory<C> standard(@NonNull CommandManager<C> commandManager)

Returns a factory that produces instances of StandardHelpHandler.

Type Parameters:

C - the command sender type

Parameters:

commandManager - the command manager

Returns:

the factory instance

createHelpHandler

@NonNull HelpHandler<C> createHelpHandler(@NonNull CommandPredicate<C> filter)

Creates a new help handler.

Parameters:

filter - filter that determines which commands are applicable to the help handler

Returns:

the help handler