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

Class HelpRenderOptions<S extends Source,C>

java.lang.Object

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

Type Parameters:

S - The type of Source from which the command was executed.

public class HelpRenderOptions<S extends Source,C>
extends Object

Rendering options for customizing help display.

This class serves as a builder for configuring how help documentation should be rendered. It encapsulates settings like the display theme and the layout style, providing a fluent API for easy configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	HelpRenderOptions.Layout	An enumeration of the available help documentation layouts.

Method Summary

Modifier and Type	Method	Description
HelpRenderOptions.Layout	getLayout()	Gets the current rendering layout.
HelpTheme<S,C>	getTheme()	Gets the current rendering theme.
static <S extends Source, C> HelpRenderOptions<S,C>	of(HelpTheme<S,C> theme, HelpRenderOptions.Layout layout)	Creates a new builder for configuring help rendering options.

Methods inherited from class java.lang.Object

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

Method Details

of

public static <S extends Source,
C>
HelpRenderOptions<S,C> of(HelpTheme<S,C> theme,
 HelpRenderOptions.Layout layout)

Creates a new builder for configuring help rendering options.

Type Parameters:

S - The type of Source.

Returns:

A new instance of HelpRenderOptions.

getTheme

public HelpTheme<S,C> getTheme()

Gets the current rendering theme.

Returns:

The configured HelpTheme.

getLayout

public HelpRenderOptions.Layout getLayout()

Gets the current rendering layout.

Returns:

The configured HelpRenderOptions.Layout.