revxrsal.commands.node

Interface LiteralNode<A extends CommandActor>

Type Parameters:

A - The actor type

All Superinterfaces:

CommandNode<A>, java.lang.Comparable<CommandNode<A>>

public interface LiteralNode<A extends CommandActor>
extends CommandNode<A>

Represents a literal node, i.e. it has only a single possible value which is CommandNode.name().

Method Summary

Modifier and Type	Method and Description
default boolean	isLiteral() Tests whether this node is a LiteralNode.
default boolean	isParameter() Tests whether this node is a ParameterNode.
default @NotNull java.lang.String	representation() Returns the string representation.
default @NotNull LiteralNode<A>	requireLiteralNode() Requires this node to be a LiteralNode and automatically casts it
default <T> @NotNull ParameterNode<A,T>	requireParameterNode() Requires this node to be a ParameterNode.

Methods inherited from interface revxrsal.commands.node.CommandNode

action, command, execute, hasAction, isLast, lamp, name

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

isLiteral

default boolean isLiteral()

Tests whether this node is a LiteralNode. This always returns true

Specified by:

isLiteral in interface CommandNode<A extends CommandActor>

Returns:

if this node is literal

requireLiteralNode

@Contract(value="-> this",
          pure=true)
 @NotNull
default @NotNull LiteralNode<A> requireLiteralNode()

Requires this node to be a LiteralNode and automatically casts it

Specified by:

requireLiteralNode in interface CommandNode<A extends CommandActor>

Returns:

This node, as a literal node

isParameter

default boolean isParameter()

Tests whether this node is a ParameterNode. This always returns false

Specified by:

isParameter in interface CommandNode<A extends CommandActor>

Returns:

if this node is a parameter

representation

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

Returns the string representation. This is the same as the node name in cases of literals.

Specified by:

representation in interface CommandNode<A extends CommandActor>

Returns:

The node string representation

requireParameterNode

@Contract(value="-> fail")
 @NotNull
default <T> @NotNull ParameterNode<A,T> requireParameterNode()

Requires this node to be a ParameterNode. This will throw a IllegalStateException.

Specified by:

requireParameterNode in interface CommandNode<A extends CommandActor>

Returns:

never as it always fails

Throws:

java.lang.IllegalStateException - always