revxrsal.commands.node

Interface CommandNode<A extends CommandActor>

Type Parameters:

A - The actor type. This allows for better type inference and reduces the need for type-checking and casting

All Superinterfaces:

java.lang.Comparable<CommandNode<A>>

All Known Subinterfaces:

LiteralNode<A>, ParameterNode<A,T>

public interface CommandNode<A extends CommandActor>
extends java.lang.Comparable<CommandNode<A>>

Represents a node in a command tree. This can either be a LiteralNode or a ParameterNode.

See Also:

LiteralNode, ParameterNode

Method Summary

Modifier and Type	Method and Description
@Nullable CommandAction<A>	action() Returns the action bound to this command node.
@NotNull ExecutableCommand<A>	command() Returns the ExecutableCommand that this node belongs to
void	execute(@NotNull ExecutionContext<A> context, @NotNull MutableStringStream input) Executes the action() of this node with the given context and input.
default boolean	hasAction() Tests whether this node has an action().
boolean	isLast() Tests whether is this node the last one in the command tree it belongs to
boolean	isLiteral() Tests whether this node is a LiteralNode
boolean	isParameter() Tests whether this node is a ParameterNode
@NotNull Lamp<A>	lamp() Returns the Lamp instance that constructed this node
@NotNull java.lang.String	name() Returns the name of this node.
@NotNull java.lang.String	representation() Returns the node string representation.
@NotNull LiteralNode<A>	requireLiteralNode() Requires this node to be a LiteralNode and automatically casts it, otherwise throws a IllegalStateException.
<T> @NotNull ParameterNode<A,T>	requireParameterNode() Requires this node to be a ParameterNode and automatically casts it, otherwise throws a IllegalStateException.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

lamp

@NotNull
@NotNull Lamp<A> lamp()

Returns the Lamp instance that constructed this node

Returns:

The Lamp instance

command

@NotNull
@NotNull ExecutableCommand<A> command()

Returns the ExecutableCommand that this node belongs to

Returns:

the command

name

@NotNull
@NotNull java.lang.String name()

Returns the name of this node.

Returns:

The node name

action

@Nullable
 @Contract(pure=true)
@Nullable CommandAction<A> action()

Returns the action bound to this command node.

Returns:

The action of this node, or null if none is registered.

isLast

boolean isLast()

Tests whether is this node the last one in the command tree it belongs to

Returns:

if the node is the last in the tree.

hasAction

default boolean hasAction()

Tests whether this node has an action().

Returns:

if this node has an action or not

execute

void execute(@NotNull
             @NotNull ExecutionContext<A> context,
             @NotNull
             @NotNull MutableStringStream input)

Executes the action() of this node with the given context and input.

If this node has no action, this method does nothing.

Parameters:

context - The execution context

input - The user input

isLiteral

boolean isLiteral()

Tests whether this node is a LiteralNode

Returns:

if this node is literal

requireLiteralNode

@NotNull
@NotNull LiteralNode<A> requireLiteralNode()

Requires this node to be a LiteralNode and automatically casts it, otherwise throws a IllegalStateException.

Returns:

This node, as a literal node

Throws:

java.lang.IllegalStateException - if this is not a literal node

isParameter

boolean isParameter()

Tests whether this node is a ParameterNode

Returns:

if this node is a parameter

requireParameterNode

@NotNull
<T> @NotNull ParameterNode<A,T> requireParameterNode()

Requires this node to be a ParameterNode and automatically casts it, otherwise throws a IllegalStateException.

Returns:

This node, as a parameter node

Throws:

java.lang.IllegalStateException - if this is not a parameter node

representation

@NotNull
@NotNull java.lang.String representation()

Returns the node string representation. This is defined as:

• The node name if it's literal
• <name> if it's a required parameter
• [name] if it's an optional parameter

Returns:

The node's string representation