net.lenni0451.commandlib

Class ArgumentChain<E>

java.lang.Object

net.lenni0451.commandlib.ArgumentChain<E>

Type Parameters:

E - The type of the executor

public class ArgumentChain<E>
extends java.lang.Object

A chain of arguments required for correct execution.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArgumentChain.MatchedArgument A wrapper for an argument that has been matched.

Method Summary

Modifier and Type	Method and Description
static <E> java.util.List<ArgumentChain<E>>	buildChains(ArgumentNode<E,?> argument) Build a list of all chains for the given argument node.
ArgumentNode<E,?>	getArgument(int index) Get an argument node by its index.
java.util.function.Function<ExecutionContext<E>,?>	getExecutor() Get the executor of this chain.
int	getLength()
int[]	getWeights()
java.util.List<ArgumentChain.MatchedArgument>	parse(ExecutionContext<E> executionContext, StringReader reader) Parse the given input and return the parsed arguments.
void	populateArguments(ExecutionContext<E> executionContext, java.util.List<ArgumentChain.MatchedArgument> arguments) Populate the given execution context with the given arguments.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

buildChains

public static <E> java.util.List<ArgumentChain<E>> buildChains(ArgumentNode<E,?> argument)

Build a list of all chains for the given argument node.

Type Parameters:

E - The type of the executor

Parameters:

argument - The argument node

Returns:

The list of chains

Throws:

java.lang.IllegalArgumentException - If a duplicate argument name is found or the chain end has no executor

getLength

public int getLength()

getWeights

public int[] getWeights()

Returns:

The weights of all arguments in this chain

getArgument

public ArgumentNode<E,?> getArgument(int index)

Get an argument node by its index.

Parameters:

index - The index

Returns:

The argument node

Throws:

java.lang.IndexOutOfBoundsException - If the index is out of bounds

parse

public java.util.List<ArgumentChain.MatchedArgument> parse(ExecutionContext<E> executionContext,
                                                           StringReader reader)
                                                    throws ChainExecutionException

Parse the given input and return the parsed arguments.

Parameters:

executionContext - The execution context

reader - The input reader

Returns:

The parsed arguments

Throws:

ChainExecutionException - If the input can not be parsed

populateArguments

public void populateArguments(ExecutionContext<E> executionContext,
                              java.util.List<ArgumentChain.MatchedArgument> arguments)

Populate the given execution context with the given arguments.

Parameters:

executionContext - The execution context

arguments - The arguments

getExecutor

public java.util.function.Function<ExecutionContext<E>,?> getExecutor()

Get the executor of this chain.

Returns:

The executor

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object