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

Enum Class HelpRenderOptions.Layout

java.lang.Object

java.lang.Enum<HelpRenderOptions.Layout>

studio.mevera.imperat.command.tree.help.HelpRenderOptions.Layout

All Implemented Interfaces:

Serializable, Comparable<HelpRenderOptions.Layout>, Constable

Enclosing class:

HelpRenderOptions<S extends Source,C>

public static enum HelpRenderOptions.Layout
extends Enum<HelpRenderOptions.Layout>

An enumeration of the available help documentation layouts.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LIST	Simple list view where commands are displayed one after another.
TREE	A tree structure view that shows command nesting and hierarchy.

Method Summary

Modifier and Type	Method	Description
static HelpRenderOptions.Layout	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HelpRenderOptions.Layout[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LIST

public static final HelpRenderOptions.Layout LIST

Simple list view where commands are displayed one after another.

TREE

public static final HelpRenderOptions.Layout TREE

A tree structure view that shows command nesting and hierarchy.

Method Details

values

public static HelpRenderOptions.Layout[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static HelpRenderOptions.Layout valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null