net.lenni0451.commandlib.builder

Interface ArgumentBuilder<E>

Type Parameters:

E - The type of the executor

public interface ArgumentBuilder<E>

A convenience interface to allow for the easy creation of arguments.

Method Summary

Modifier and Type	Method and Description
default <T> ArgumentType<E,T>	dynamicType(DynamicType.BiParser<E,T> parser) Create a dynamic parsing argument type.
default <T> ArgumentType<E,T>	dynamicType(DynamicType.SingleParser<T> parser) Create a dynamic parsing argument type.
default LineBuilder<E>	line()
default <T> ListNode<E,T>	list(java.lang.String name, ArgumentType<E,T> type) Create a new list argument node.
default <T> ListNode<E,T>	list(java.lang.String name, java.lang.String description, ArgumentType<E,T> type) Create a new list argument node.
default RedirectNode<E>	redirect(ArgumentNode<E,?> targetNode) Create a redirect node.
default StringNode<E>	string(java.lang.String s) Create a new string argument node.
default StringNode<E>	string(java.lang.String s, java.lang.String description) Create a new string argument node.
default StringArrayNode<E>	stringArray(java.lang.String name, StringArrayNode.Executor<E> executor) Create a new string array argument node.
default StringArrayNode<E>	stringArray(java.lang.String name, StringArrayNode.Executor<E> executor, StringArrayNode.Completor<E> completor) Create a new string array argument node.
default StringArrayNode<E>	stringArray(java.lang.String name, java.lang.String description, StringArrayNode.Executor<E> executor) Create a new string array argument node.
default StringArrayNode<E>	stringArray(java.lang.String name, java.lang.String description, StringArrayNode.Executor<E> executor, StringArrayNode.Completor<E> completor) Create a new string array argument node.
default <T> TypedNode<E,T>	typed(java.lang.String name, ArgumentType<E,T> type) Create a new typed argument node.
default <T> TypedNode<E,T>	typed(java.lang.String name, java.lang.String description, ArgumentType<E,T> type) Create a new typed argument node.

Method Detail

string

default StringNode<E> string(java.lang.String s)

Create a new string argument node.
The argument will be matched as a single word. The case-sensitivity will be determined by the ArgumentComparator in the command executor.

Parameters:

s - The name of the argument

Returns:

The created node

string

default StringNode<E> string(java.lang.String s,
                             @Nullable
                             java.lang.String description)

Create a new string argument node.
The argument will be matched as a single word. The case-sensitivity will be determined by the ArgumentComparator in the command executor.

Parameters:

s - The name of the argument

description - The description of the argument

Returns:

The created node

typed

default <T> TypedNode<E,T> typed(java.lang.String name,
                                 ArgumentType<E,T> type)

Create a new typed argument node.
The argument will be parsed by the given ArgumentType.

Type Parameters:

T - The type of the argument

Parameters:

name - The name of the argument

type - The argument type

Returns:

The created node

typed

default <T> TypedNode<E,T> typed(java.lang.String name,
                                 @Nullable
                                 java.lang.String description,
                                 ArgumentType<E,T> type)

Create a new typed argument node.
The argument will be parsed by the given ArgumentType.

Type Parameters:

T - The type of the argument

Parameters:

name - The name of the argument

description - The description of the argument

type - The argument type

Returns:

The created node

redirect

default RedirectNode<E> redirect(ArgumentNode<E,?> targetNode)

Create a redirect node.
The redirect node will redirect the execution to the given target node.

Parameters:

targetNode - The target node

Returns:

The created node

list

default <T> ListNode<E,T> list(java.lang.String name,
                               ArgumentType<E,T> type)

Create a new list argument node.
The argument will be parsed by the given ArgumentType.
The argument can be repeated multiple times.

Type Parameters:

T - The type of the argument

Parameters:

name - The name of the argument

type - The argument type

Returns:

The created node

list

default <T> ListNode<E,T> list(java.lang.String name,
                               @Nullable
                               java.lang.String description,
                               ArgumentType<E,T> type)

Create a new list argument node.
The argument will be parsed by the given ArgumentType.
The argument can be repeated multiple times.

Type Parameters:

T - The type of the argument

Parameters:

name - The name of the argument

description - The description of the argument

type - The argument type

Returns:

The created node

stringArray

default StringArrayNode<E> stringArray(java.lang.String name,
                                       StringArrayNode.Executor<E> executor)

Create a new string array argument node.
The given executor receives the whole string array as argument.
This allows you to handle commands the traditional way.

Parameters:

name - The name of the argument

executor - The executor

Returns:

The created node

stringArray

default StringArrayNode<E> stringArray(java.lang.String name,
                                       StringArrayNode.Executor<E> executor,
                                       StringArrayNode.Completor<E> completor)

Create a new string array argument node.
The given executor receives the whole string array as argument.
The given completor receives all arguments to this point as argument.
This allows you to handle commands the traditional way.

Parameters:

name - The name of the argument

executor - The executor

completor - The completor

Returns:

The created node

stringArray

default StringArrayNode<E> stringArray(java.lang.String name,
                                       @Nullable
                                       java.lang.String description,
                                       StringArrayNode.Executor<E> executor)

Create a new string array argument node.
The given executor receives the whole string array as argument.
This allows you to handle commands the traditional way.

Parameters:

name - The name of the argument

description - The description of the argument

executor - The executor

Returns:

The created node

stringArray

default StringArrayNode<E> stringArray(java.lang.String name,
                                       @Nullable
                                       java.lang.String description,
                                       StringArrayNode.Executor<E> executor,
                                       StringArrayNode.Completor<E> completor)

Create a new string array argument node.
The given executor receives the whole string array as argument.
The given completor receives all arguments to this point as argument.
This allows you to handle commands the traditional way.

Parameters:

name - The name of the argument

description - The description of the argument

executor - The executor

completor - The completor

Returns:

The created node

dynamicType

default <T> ArgumentType<E,T> dynamicType(DynamicType.SingleParser<T> parser)

Create a dynamic parsing argument type.
The DynamicType.SingleParser only receives the string reader to parse the argument.

Type Parameters:

T - The type of the parsed argument

Parameters:

parser - The parser

Returns:

The created argument type

dynamicType

default <T> ArgumentType<E,T> dynamicType(DynamicType.BiParser<E,T> parser)

Create a dynamic parsing argument type.
The DynamicType.BiParser receives the execution context and the string reader to parse the argument.

Type Parameters:

T - The type of the parsed argument

Parameters:

parser - The parser

Returns:

The created argument type

line

default LineBuilder<E> line()

Returns:

A new line builder