Package io.github.mqzn.commands.base.syntax.tree

Class CommandTree<S>

java.lang.Object

io.github.mqzn.commands.base.syntax.tree.CommandTree<S>

Type Parameters:

S - the sender type

public final class CommandTree<S>
extends Object

This class represents a tree data structure containing all nodes of subcommands of a particular command.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommandTree.CommandNode<S>	A class that defines a subcommand node, each node has a reference to its children nodes, the children can be more than one, that's why a set is being used
static class	CommandTree.CommandSearchResult<S>
static enum	CommandTree.CommandSearchResultState
static final record	CommandTree.SubCommandKey<S>

Method Summary

Modifier and Type	Method	Description
static <S> CommandTree<S>	create(Command<S> command)
static <S> String	getLastRawArgument(DelegateCommandContext<S> context)
LinkedList<Argument<?>>	getParentalArguments(CommandTree.SubCommandKey<S> key)
Map<String,CommandTree.CommandNode<S>>	getRoots()
SubCommandSyntax<S>	getSubCommand(CommandTree.SubCommandKey<S> key)
SubCommandSyntax<S>	searchForSub(String name)
CommandTree.CommandSearchResult<S>	traverse(DelegateCommandContext<S> context)	Searches through the subcommands for appropriate subcommand that was used in the context

Methods inherited from class java.lang.Object

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

Method Details

create

public static <S> CommandTree<S> create(Command<S> command)

getLastRawArgument

public static <S> String getLastRawArgument(DelegateCommandContext<S> context)

getRoots

public Map<String,CommandTree.CommandNode<S>> getRoots()

traverse

public CommandTree.CommandSearchResult<S> traverse(DelegateCommandContext<S> context)

Searches through the subcommands for appropriate subcommand that was used in the context

Parameters:

context - the command context determined by the sender

Returns:

the subcommand to execute

getSubCommand

public SubCommandSyntax<S> getSubCommand(CommandTree.SubCommandKey<S> key)

getParentalArguments

public LinkedList<Argument<?>> getParentalArguments(CommandTree.SubCommandKey<S> key)

searchForSub

public SubCommandSyntax<S> searchForSub(String name)