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

Interface HelpTheme<S extends Source,C>

Type Parameters:

S - the type of command source/console

C - the type of the entries in the help component (can be String, Component, etc.)

All Known Implementing Classes:

BaseHelpTheme, TextHelpTheme

public interface HelpTheme<S extends Source,C>

A theme for help documentation generation and presentation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	HelpTheme.Option<T>
static enum	HelpTheme.PresentationStyle	Available presentation styles for help display.

Method Summary

Modifier and Type	Method	Description
HelpComponent<S,C>	createEmptyComponent()
@NotNull HelpComponent<S,C>	getBranch()
@NotNull HelpComponent<S,C>	getEmptyIndent()
@NotNull HelpComponent<S,C>	getFooter(ExecutionContext<S> context)
@NotNull HelpComponent<S,C>	getHeader(ExecutionContext<S> context)
@NotNull HelpComponent<S,C>	getIndent()
int	getIndentMultiplier()
@NotNull HelpComponent<S,C>	getLastBranch()
<T> T	getOptionValue(@NotNull HelpTheme.Option<T> option)
@NotNull HelpTheme.PresentationStyle	getPreferredStyle()	Gets the preferred presentation style for this theme.
default @NotNull HelpComponent<S,C>	getTreeBranch(boolean isLast)
default @NotNull HelpComponent<S,C>	getTreeIndent(boolean hasMore)
@NotNull UsageFormatter<S,C>	getUsageFormatter()
<T> void	setOptionValue(@NotNull HelpTheme.Option<T> option, T value)

Method Details

createEmptyComponent

HelpComponent<S,C> createEmptyComponent()

getPreferredStyle

@NotNull
@NotNull HelpTheme.PresentationStyle getPreferredStyle()

Gets the preferred presentation style for this theme.

Returns:

the presentation style to use

getIndentMultiplier

int getIndentMultiplier()

getBranch

@NotNull
@NotNull HelpComponent<S,C> getBranch()

getLastBranch

@NotNull
@NotNull HelpComponent<S,C> getLastBranch()

getIndent

@NotNull
@NotNull HelpComponent<S,C> getIndent()

getEmptyIndent

@NotNull
@NotNull HelpComponent<S,C> getEmptyIndent()

setOptionValue

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

getTreeBranch

@NotNull
default @NotNull HelpComponent<S,C> getTreeBranch(boolean isLast)

getTreeIndent

@NotNull
default @NotNull HelpComponent<S,C> getTreeIndent(boolean hasMore)

getHeader

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

getFooter

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

getOptionValue

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

getUsageFormatter

@NotNull
@NotNull UsageFormatter<S,C> getUsageFormatter()