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

Class BaseHelpTheme<S extends CommandSource,C>

java.lang.Object

studio.mevera.imperat.command.tree.help.theme.BaseHelpTheme<S,C>

All Implemented Interfaces:

HelpTheme<S,C>

Direct Known Subclasses:

TextBasedHelpTheme, TextHelpTheme

public abstract class BaseHelpTheme<S extends CommandSource,C>
extends Object
implements HelpTheme<S,C>

Nested Class Summary

Nested classes/interfaces inherited from interface studio.mevera.imperat.command.tree.help.theme.HelpTheme

HelpTheme.Option<T>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseHelpTheme(Function<C,HelpComponent<S,C>> componentFactory)

Method Summary

Modifier and Type	Method	Description
final HelpComponent<S,C>	createEmptyComponent()
abstract C	createEmptyContent()
final @NotNull HelpComponent<S,C>	getFooter(ExecutionContext<S> context)
abstract C	getFooterContent(ExecutionContext<S> context)
final @NotNull HelpComponent<S,C>	getHeader(ExecutionContext<S> context)
abstract C	getHeaderContent(ExecutionContext<S> context)
<T> T	getOptionValue(@NotNull HelpTheme.Option<T> option)
<T> void	setOptionValue(@NotNull HelpTheme.Option<T> option, T value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface studio.mevera.imperat.command.tree.help.theme.HelpTheme

getUsageFormatter

Constructor Details

BaseHelpTheme

protected BaseHelpTheme(Function<C,HelpComponent<S,C>> componentFactory)

Method Details

createEmptyContent

@NotNull
public abstract C createEmptyContent()

getHeaderContent

@NotNull
public abstract C getHeaderContent(ExecutionContext<S> context)

getFooterContent

@NotNull
public abstract C getFooterContent(ExecutionContext<S> context)

createEmptyComponent

public final HelpComponent<S,C> createEmptyComponent()

Specified by:

createEmptyComponent in interface HelpTheme<S extends CommandSource,C>

getHeader

@NotNull
public final @NotNull HelpComponent<S,C> getHeader(ExecutionContext<S> context)

Specified by:

getHeader in interface HelpTheme<S extends CommandSource,C>

getFooter

@NotNull
public final @NotNull HelpComponent<S,C> getFooter(ExecutionContext<S> context)

Specified by:

getFooter in interface HelpTheme<S extends CommandSource,C>

getOptionValue

public <T> T getOptionValue(@NotNull
 @NotNull HelpTheme.Option<T> option)

Specified by:

getOptionValue in interface HelpTheme<S extends CommandSource,C>

setOptionValue

public <T> void setOptionValue(@NotNull
 @NotNull HelpTheme.Option<T> option,
 T value)

Specified by:

setOptionValue in interface HelpTheme<S extends CommandSource,C>