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

Class BaseHelpTheme<S extends Source,C>

java.lang.Object

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

All Implemented Interfaces:

HelpTheme<S,C>

Direct Known Subclasses:

TextHelpTheme

public abstract class BaseHelpTheme<S extends Source,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>, HelpTheme.PresentationStyle

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseHelpTheme(@NotNull HelpTheme.PresentationStyle style, int indentMultiplier, Function<C,HelpComponent<S,C>> componentFactory)
protected	BaseHelpTheme(HelpTheme.PresentationStyle style, 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>	getBranch()
abstract C	getBranchContent()
final @NotNull HelpComponent<S,C>	getEmptyIndent()
abstract C	getEmptyIndentContent()
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)
final @NotNull HelpComponent<S,C>	getIndent()
abstract C	getIndentContent()
int	getIndentMultiplier()
final @NotNull HelpComponent<S,C>	getLastBranch()
abstract C	getLastBranchContent()
<T> T	getOptionValue(@NotNull HelpTheme.Option<T> option)
@NotNull HelpTheme.PresentationStyle	getPreferredStyle()	Gets the preferred presentation style for this theme.
<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

getTreeBranch, getTreeIndent, getUsageFormatter

Constructor Details

BaseHelpTheme

protected BaseHelpTheme(@NotNull
 @NotNull HelpTheme.PresentationStyle style,
 int indentMultiplier,
 Function<C,HelpComponent<S,C>> componentFactory)

BaseHelpTheme

protected BaseHelpTheme(HelpTheme.PresentationStyle style,
 Function<C,HelpComponent<S,C>> componentFactory)

Method Details

getPreferredStyle

@NotNull
public @NotNull HelpTheme.PresentationStyle getPreferredStyle()

Description copied from interface: HelpTheme

Gets the preferred presentation style for this theme.

Specified by:

getPreferredStyle in interface HelpTheme<S extends Source,C>

Returns:

the presentation style to use

getIndentMultiplier

public int getIndentMultiplier()

Specified by:

getIndentMultiplier in interface HelpTheme<S extends Source,C>

createEmptyContent

@NotNull
public abstract C createEmptyContent()

getBranchContent

@NotNull
public abstract C getBranchContent()

getLastBranchContent

@NotNull
public abstract C getLastBranchContent()

getIndentContent

@NotNull
public abstract C getIndentContent()

getEmptyIndentContent

@NotNull
public abstract C getEmptyIndentContent()

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 Source,C>

getBranch

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

Specified by:

getBranch in interface HelpTheme<S extends Source,C>

getLastBranch

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

Specified by:

getLastBranch in interface HelpTheme<S extends Source,C>

getIndent

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

Specified by:

getIndent in interface HelpTheme<S extends Source,C>

getEmptyIndent

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

Specified by:

getEmptyIndent in interface HelpTheme<S extends Source,C>

getHeader

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

Specified by:

getHeader in interface HelpTheme<S extends Source,C>

getFooter

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

Specified by:

getFooter in interface HelpTheme<S extends Source,C>

getOptionValue

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

Specified by:

getOptionValue in interface HelpTheme<S extends Source,C>

setOptionValue

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

Specified by:

setOptionValue in interface HelpTheme<S extends Source,C>