net.lenni0451.commandlib.builder

Class LineBuilder<E>

java.lang.Object

net.lenni0451.commandlib.builder.LineBuilder<E>

Type Parameters:

E - The type of the executor

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

Easily build a line of arguments into an ArgumentNode.

Method Summary

Modifier and Type	Method and Description
<T> LineBuilder<E>	arg(java.lang.String name, ArgumentType<E,T> type) Start building an argument and add it to the line.
<T> LineBuilder<E>	arg(java.lang.String name, java.lang.String description, ArgumentType<E,T> type) Start building an argument and add it to the line.
static <E> LineBuilder<E>	create() Create a new line builder.
<T> LineBuilder<E>	defaultValue(T defaultValue) Set the default value of the last added argument.
LineBuilder<E>	exceptionHandler(CommandExceptionHandler<E> exceptionHandler) Add an exception handler to the last added argument.
<R> ArgumentNode<E,R>	executes(java.util.function.Consumer<ExecutionContext<E>> consumer) Set the Consumer executor of the line and build the line into an ArgumentNode.
<R> ArgumentNode<E,R>	executes(java.util.function.Function<ExecutionContext<E>,R> function) Set the Function executor of the line and build the line into an ArgumentNode.
<R> ArgumentNode<E,R>	executes(java.lang.Runnable runnable) Set the Runnable executor of the line and build the line into an ArgumentNode.
<R> ArgumentNode<E,R>	executes(java.util.function.Supplier<R> supplier) Set the Supplier executor of the line and build the line into an ArgumentNode.
LineBuilder<E>	suggestions(CompletionsProvider<E> completionsProvider) Add a completions provider to the last added argument.
<T> LineBuilder<E>	validator(java.util.function.Predicate<T> validator) Add a validator to the last added argument.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <E> LineBuilder<E> create()

Create a new line builder.

Type Parameters:

E - The type of the executor

Returns:

The created line builder

arg

public <T> LineBuilder<E> arg(java.lang.String name,
                              ArgumentType<E,T> type)

Start building an argument and add it to the line.

Type Parameters:

T - The type of the argument

Parameters:

name - The name of the argument

type - The argument type

Returns:

The line builder

arg

public <T> LineBuilder<E> arg(java.lang.String name,
                              @Nullable
                              java.lang.String description,
                              ArgumentType<E,T> type)

Start building an argument and add it to the line.

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 line builder

validator

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

Add a validator to the last added argument.

Type Parameters:

T - The type of the argument

Parameters:

validator - The validator

Returns:

The line builder

Throws:

java.lang.IllegalStateException - If no argument was added before

suggestions

public LineBuilder<E> suggestions(@Nullable
                                  CompletionsProvider<E> completionsProvider)

Add a completions provider to the last added argument.

Parameters:

completionsProvider - The completions provider

Returns:

The line builder

Throws:

java.lang.IllegalStateException - If no argument was added before

exceptionHandler

public LineBuilder<E> exceptionHandler(@Nullable
                                       CommandExceptionHandler<E> exceptionHandler)

Add an exception handler to the last added argument.

Parameters:

exceptionHandler - The exception handler

Returns:

The line builder

Throws:

java.lang.IllegalStateException - If no argument was added before

defaultValue

public <T> LineBuilder<E> defaultValue(@Nullable
                                       T defaultValue)

Set the default value of the last added argument.

Type Parameters:

T - The type of the argument

Parameters:

defaultValue - The default value

Returns:

The line builder

Throws:

java.lang.IllegalStateException - If no argument was added before

executes

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

Set the Runnable executor of the line and build the line into an ArgumentNode.

Type Parameters:

R - The return type of the executor

Parameters:

runnable - The executor

Returns:

The created ArgumentNode

executes

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

Set the Consumer executor of the line and build the line into an ArgumentNode.
The consumer will receive the ExecutionContext as argument.

Type Parameters:

R - The return type of the executor

Parameters:

consumer - The executor

Returns:

The created ArgumentNode

executes

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

Set the Supplier executor of the line and build the line into an ArgumentNode.

Type Parameters:

R - The return type of the executor

Parameters:

supplier - The executor

Returns:

The created ArgumentNode

executes

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

Set the Function executor of the line and build the line into an ArgumentNode.
The function will receive the ExecutionContext as argument.

Type Parameters:

R - The return type of the executor

Parameters:

function - The executor

Returns:

The created ArgumentNode