Package studio.mevera.imperat.command.tree.help

Class CommandHelp<S extends Source>

java.lang.Object

studio.mevera.imperat.command.tree.help.CommandHelp<S>

public final class CommandHelp<S extends Source>
extends Object

Method Summary

Modifier and Type	Method	Description
static <S extends Source> CommandHelp<S>	create(ExecutionContext<S> context)
<C> void	display(HelpQuery<S> query, HelpTheme<S,C> theme)	Displays help using the provided query and theme.
@NotNull ExecutionContext<S>	getContext()
@NotNull HelpCoordinator<S>	getCoordinator()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

public static <S extends Source> CommandHelp<S> create(ExecutionContext<S> context)

display

public <C> void display(HelpQuery<S> query,
 HelpTheme<S,C> theme)

Displays help using the provided query and theme.

Parameters:

query - the help query specifying what help to show

theme - the theme controlling how help is displayed

getContext

@NotNull
public @NotNull ExecutionContext<S> getContext()

getCoordinator

@NotNull
public @NotNull HelpCoordinator<S> getCoordinator()