Package org.incendo.cloud

Class CommandTree<C>

java.lang.Object

org.incendo.cloud.CommandTree<C>

Type Parameters:

C - command sender type

@API(status=INTERNAL,
     consumers="org.incendo.cloud.*")
public final class CommandTree<C>
extends Object

Tree containing all commands and command paths.

All commands consists of unique paths made out of components. These arguments may be literals or variables. Command may either be required or optional, with the requirement that no optional argument precedes a required argument.

The commands are stored in this tree and the nodes of tree consists of the command components. Each leaf node of the tree should contain a fully parsed Command. It is thus possible to walk the tree and determine whether the supplied input from a command sender constitutes a proper command.

When parsing input, the tree will be walked until one of four scenarios occur:

1. The input queue is empty at a non-leaf node
2. The input queue is not empty following a leaf node
3. No child node is able to accept the input
4. The input queue is empty following a leaf node

Scenarios one and two would result in a InvalidSyntaxException being thrown, whereas scenario three would result in a NoSuchCommandException if occurring at the root node or a InvalidSyntaxException otherwise. Only the fourth scenario would result in a complete command being parsed.

Method Summary

Modifier and Type	Method	Description
@NonNull CommandManager<C>	commandManager()	Returns the command manager that was used to create this command tree
@NonNull List<@NonNull CommandNode<C>>	getLeaves(@NonNull CommandNode<C> node)	Returns all leaf nodes attached to the given node or its children.
@NonNull List<@NonNull CommandNode<C>>	getLeavesRaw(@NonNull CommandNode<C> node)	Returns all leaf nodes attached to the given node or its children.
@Nullable CommandNode<C>	getNamedNode(@Nullable String name)	Returns a named root node, if it exists
<S extends Suggestion> @NonNull CompletableFuture<@NonNull Suggestions<C,S>>	getSuggestions(@NonNull CommandContext<C> context, @NonNull CommandInput commandInput, @NonNull SuggestionMapper<S> mapper, @NonNull Executor executor)	Returns suggestions from the input queue
void	insertCommand(@NonNull Command<C> command)	Inserts a new command into the command tree and then verifies the integrity of the tree
static <C> @NonNull CommandTree<C>	newTree(@NonNull CommandManager<C> commandManager)	Creates a new command tree instance
@NonNull CompletableFuture<@Nullable Command<C>>	parse(@NonNull CommandContext<C> commandContext, @NonNull CommandInput commandInput, @NonNull Executor parsingExecutor)	Attempts to parse a command from the provided input.
@NonNull CommandNode<C>	rootNode()	Returns the node that all rootNodes() share as a parent.
@NonNull Collection<@NonNull CommandNode<C>>	rootNodes()	Returns an immutable view containing of the root nodes of the command tree

Methods inherited from class java.lang.Object

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

Method Details

newTree

public static <C> @NonNull CommandTree<C> newTree(@NonNull CommandManager<C> commandManager)

Creates a new command tree instance

Type Parameters:

C - Command sender type

Parameters:

commandManager - Command manager

Returns:

the created command tree

commandManager

@API(status=STABLE)
public @NonNull CommandManager<C> commandManager()

Returns the command manager that was used to create this command tree

Returns:

Command manager

rootNodes

@API(status=STABLE)
public @NonNull Collection<@NonNull CommandNode<C>> rootNodes()

Returns an immutable view containing of the root nodes of the command tree

Returns:

immutable view of the root nodes

getNamedNode

public @Nullable CommandNode<C> getNamedNode(@Nullable String name)

Returns a named root node, if it exists

Parameters:

name - root node name

Returns:

the found root node, or null

parse

@API(status=STABLE)
public @NonNull CompletableFuture<@Nullable Command<C>> parse(@NonNull CommandContext<C> commandContext,
 @NonNull CommandInput commandInput,
 @NonNull Executor parsingExecutor)

Attempts to parse a command from the provided input.

Parameters:

commandContext - command context instance

commandInput - command input

parsingExecutor - executor to schedule parsing logic on

Returns:

parsed command, if one could be found

getSuggestions

@API(status=STABLE)
public <S extends Suggestion>
@NonNull CompletableFuture<@NonNull Suggestions<C,S>> getSuggestions(@NonNull CommandContext<C> context,
 @NonNull CommandInput commandInput,
 @NonNull SuggestionMapper<S> mapper,
 @NonNull Executor executor)

Returns suggestions from the input queue

Type Parameters:

S - suggestion type

Parameters:

context - Context instance

commandInput - Input

mapper - suggestion mapper

executor - executor to schedule suggestion logic on

Returns:

String suggestions. These should be filtered based on String.startsWith(String)

insertCommand

public void insertCommand(@NonNull Command<C> command)

Inserts a new command into the command tree and then verifies the integrity of the tree

Parameters:

command - the command to insert

rootNode

@API(status=INTERNAL)
public @NonNull CommandNode<C> rootNode()

Returns the node that all rootNodes() share as a parent.

Returns:

the root node

getLeavesRaw

@API(status=INTERNAL)
public @NonNull List<@NonNull CommandNode<C>> getLeavesRaw(@NonNull CommandNode<C> node)

Returns all leaf nodes attached to the given node or its children.

Parameters:

node - the node

Returns:

the leaf nodes attached to the node

getLeaves

@API(status=INTERNAL)
public @NonNull List<@NonNull CommandNode<C>> getLeaves(@NonNull CommandNode<C> node)

Returns all leaf nodes attached to the given node or its children.

Parameters:

node - the node

Returns:

the leaf nodes attached to the node