net.lenni0451.commandlib.nodes

Class ArgumentNode<E,T>

java.lang.Object

net.lenni0451.commandlib.nodes.ArgumentNode<E,T>

Type Parameters:

E - The type of the executor

T - The type of the argument

Direct Known Subclasses:

ListNode, StringArrayNode, StringNode, TypedNode

public abstract class ArgumentNode<E,T>
extends java.lang.Object

The abstract argument node class containing all methods required to build a customizable argument tree.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	providesArgument
protected int	weight

Constructor Summary

Constructors

Constructor and Description
ArgumentNode(java.lang.String name)
ArgumentNode(java.lang.String name, java.lang.String description)

Method Summary

Modifier and Type	Method and Description
java.util.List<ArgumentNode<E,?>>	children()
java.util.Set<java.lang.String>	completions(CompletionContext completionContext, ExecutionContext<E> executionContext, StringReader reader) Provide the completions of this argument.
CompletionsProvider<E>	completionsProvider()
java.lang.String	description()
CommandExceptionHandler<E>	exceptionHandler()
ArgumentNode<E,T>	exceptionHandler(CommandExceptionHandler<E> exceptionHandler) Set the exception handler of this argument node.
ArgumentNode<E,T>	executes(java.util.function.Consumer<ExecutionContext<E>> consumer) Set the Consumer executor of this argument node.
ArgumentNode<E,T>	executes(java.util.function.Function<ExecutionContext<E>,?> function) Set the Function executor of this argument node.
ArgumentNode<E,T>	executes(java.lang.Runnable runnable) Set the Runnable executor of this argument node.
ArgumentNode<E,T>	executes(java.util.function.Supplier<?> supplier) Set the Supplier executor of this argument node.
java.util.function.Function<ExecutionContext<E>,?>	executor()
java.lang.String	name()
protected abstract void	parseCompletions(java.util.Set<java.lang.String> completions, CompletionContext completionContext, ExecutionContext<E> executionContext, StringReader stringReader) Provide the completions of this argument.
protected abstract T	parseValue(ExecutionContext<E> executionContext, StringReader stringReader) Parse the value of this argument.
boolean	providesArgument()
ArgumentRequirement<E>	requirement()
ArgumentNode<E,T>	requires(ArgumentRequirement<E> requirement) Set the requirement of this argument node.
ArgumentNode<E,T>	suggestions(CompletionsProvider<E> completionsProvider) Set the custom completions provider of this argument node.
ArgumentNode<E,T>	then(ArgumentNode<E,?> child) Add a child to this argument node.
java.util.function.Predicate<T>	validator()
ArgumentNode<E,T>	validator(java.util.function.Predicate<T> validator) Set the validator of this argument node.
T	value(ExecutionContext<E> executionContext, StringReader stringReader) Parse the value of this argument.
int	weight()

Methods inherited from class java.lang.Object

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

Field Detail

weight

protected int weight

providesArgument

protected boolean providesArgument

Constructor Detail

ArgumentNode

public ArgumentNode(java.lang.String name)

ArgumentNode

public ArgumentNode(java.lang.String name,
                    @Nullable
                    java.lang.String description)

Method Detail

name

public java.lang.String name()

Returns:

The name of the argument

description

@Nullable
public java.lang.String description()

Returns:

The description of the argument

children

public java.util.List<ArgumentNode<E,?>> children()

Returns:

The children of this argument

weight

public int weight()

Returns:

The weight of this argument

providesArgument

public boolean providesArgument()

Returns:

If this node provides an argument (See StringNode)

requirement

@Nonnull
public ArgumentRequirement<E> requirement()

Returns:

The requirement of this argument

validator

@Nullable
public java.util.function.Predicate<T> validator()

Returns:

The validator of this argument

completionsProvider

@Nullable
public CompletionsProvider<E> completionsProvider()

Returns:

The completions provider of this argument

exceptionHandler

@Nullable
public CommandExceptionHandler<E> exceptionHandler()

Returns:

The exception handler of this argument

executor

@Nullable
public java.util.function.Function<ExecutionContext<E>,?> executor()

Returns:

The executor of this argument

value

@Nonnull
public T value(ExecutionContext<E> executionContext,
                         StringReader stringReader)
                  throws ArgumentParseException,
                         java.lang.RuntimeException

Parse the value of this argument.

Parameters:

executionContext - The execution context

stringReader - The string reader

Returns:

The parsed value

Throws:

ArgumentParseException - If the value could not be parsed

java.lang.RuntimeException - If an unexpected error occurred

completions

public java.util.Set<java.lang.String> completions(CompletionContext completionContext,
                                                   ExecutionContext<E> executionContext,
                                                   StringReader reader)

Provide the completions of this argument.

Parameters:

completionContext - The completion context

executionContext - The execution context

reader - The string reader

Returns:

The completions

parseValue

@Nonnull
protected abstract T parseValue(ExecutionContext<E> executionContext,
                                          StringReader stringReader)
                                   throws ArgumentParseException,
                                          java.lang.RuntimeException

Parse the value of this argument.

Parameters:

executionContext - The execution context

stringReader - The string reader

Returns:

The parsed value

Throws:

ArgumentParseException - If the value could not be parsed

java.lang.RuntimeException - If an unexpected error occurred

parseCompletions

protected abstract void parseCompletions(java.util.Set<java.lang.String> completions,
                                         CompletionContext completionContext,
                                         ExecutionContext<E> executionContext,
                                         StringReader stringReader)

Provide the completions of this argument.

Parameters:

completions - The completions

completionContext - The completion context

executionContext - The execution context

stringReader - The string reader

then

public ArgumentNode<E,T> then(ArgumentNode<E,?> child)

Add a child to this argument node.

Parameters:

child - The child

Returns:

This argument node

requires

public ArgumentNode<E,T> requires(ArgumentRequirement<E> requirement)

Set the requirement of this argument node.

Parameters:

requirement - The requirement

Returns:

This argument node

validator

public ArgumentNode<E,T> validator(@Nullable
                                   java.util.function.Predicate<T> validator)

Set the validator of this argument node.

Parameters:

validator - The validator

Returns:

This argument node

suggestions

public ArgumentNode<E,T> suggestions(@Nullable
                                     CompletionsProvider<E> completionsProvider)

Set the custom completions provider of this argument node.

Parameters:

completionsProvider - The completions provider

Returns:

This argument node

exceptionHandler

public ArgumentNode<E,T> exceptionHandler(@Nullable
                                          CommandExceptionHandler<E> exceptionHandler)

Set the exception handler of this argument node.

Parameters:

exceptionHandler - The exception handler

Returns:

This argument node

executes

public ArgumentNode<E,T> executes(java.lang.Runnable runnable)

Set the Runnable executor of this argument node.

Parameters:

runnable - The runnable

Returns:

This argument node

executes

public ArgumentNode<E,T> executes(java.util.function.Consumer<ExecutionContext<E>> consumer)

Set the Consumer executor of this argument node.

Parameters:

consumer - The consumer

Returns:

This argument node

executes

public ArgumentNode<E,T> executes(java.util.function.Supplier<?> supplier)

Set the Supplier executor of this argument node.

Parameters:

supplier - The supplier

Returns:

This argument node

executes

public ArgumentNode<E,T> executes(java.util.function.Function<ExecutionContext<E>,?> function)

Set the Function executor of this argument node.

Parameters:

function - The function

Returns:

This argument node