net.lenni0451.commons.brigadier

Class LineArgumentBuilder<S>

java.lang.Object

com.mojang.brigadier.builder.ArgumentBuilder<S,LineArgumentBuilder<S>>

net.lenni0451.commons.brigadier.LineArgumentBuilder<S>

public class LineArgumentBuilder<S>
extends com.mojang.brigadier.builder.ArgumentBuilder<S,LineArgumentBuilder<S>>

Method Summary

Modifier and Type	Method and Description
LineArgumentBuilder<S>	argument(java.lang.String name, com.mojang.brigadier.arguments.ArgumentType<?> type) Add a new argument node to the line.
com.mojang.brigadier.tree.CommandNode<S>	build()
static <S> LineArgumentBuilder<S>	create() Create a new line argument builder.
static <S> LineArgumentBuilder<S>	create(com.mojang.brigadier.builder.ArgumentBuilder<S,?> parent) Create a new line argument builder with the given parent.
LineArgumentBuilder<S>	defaultValue() Make the most recent literal node optional.
LineArgumentBuilder<S>	defaultValue(java.lang.Object defaultValue) Make the most recent argument node optional with the given default value.
LineArgumentBuilder<S>	defaultValue(java.util.function.Supplier<java.lang.Object> supplier) Make the most recent argument node optional with the given default supplier.
com.mojang.brigadier.builder.ArgumentBuilder<S,?>	execute(com.mojang.brigadier.Command<S> executor) Set the executor for the line and finalize it.
com.mojang.brigadier.builder.ArgumentBuilder<S,?>	execute(java.util.function.Consumer<com.mojang.brigadier.context.CommandContext<S>> executor) Set the executor for the line and finalize it.
protected LineArgumentBuilder<S>	getThis()
LineArgumentBuilder<S>	literal(java.lang.String name) Add a new literal node to the line.
LineArgumentBuilder<S>	node(com.mojang.brigadier.builder.ArgumentBuilder<S,?> node) Add a new node to the line.
LineArgumentBuilder<S>	require(java.util.function.Predicate<S> requirement) Add a requirement to the most recent node.
LineArgumentBuilder<S>	suggest(com.mojang.brigadier.suggestion.SuggestionProvider<S> provider) Add a suggestion provider to the most recent node.

Methods inherited from class com.mojang.brigadier.builder.ArgumentBuilder

executes, fork, forward, getArguments, getCommand, getRedirect, getRedirectModifier, getRequirement, isFork, redirect, redirect, requires, then, then

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <S> LineArgumentBuilder<S> create()

Create a new line argument builder.
Since no parent is provided, the first node can not be optional.
Use create(ArgumentBuilder) to create a line with a parent.

Type Parameters:

S - The sender type

Returns:

The created line argument builder

create

public static <S> LineArgumentBuilder<S> create(com.mojang.brigadier.builder.ArgumentBuilder<S,?> parent)

Create a new line argument builder with the given parent.
This is only required if the first node should be optional.

Type Parameters:

S - The sender type

Parameters:

parent - The parent of the line

Returns:

The parent argument builder

node

public LineArgumentBuilder<S> node(com.mojang.brigadier.builder.ArgumentBuilder<S,?> node)

Add a new node to the line.

Parameters:

node - The node to add

Returns:

The line argument builder

literal

public LineArgumentBuilder<S> literal(java.lang.String name)

Add a new literal node to the line.

Parameters:

name - The name of the literal

Returns:

The line argument builder

argument

public LineArgumentBuilder<S> argument(java.lang.String name,
                                       com.mojang.brigadier.arguments.ArgumentType<?> type)

Add a new argument node to the line.

Parameters:

name - The name of the argument

type - The type of the argument

Returns:

The line argument builder

require

public LineArgumentBuilder<S> require(java.util.function.Predicate<S> requirement)

Add a requirement to the most recent node.

Parameters:

requirement - The requirement

Returns:

The line argument builder

suggest

public LineArgumentBuilder<S> suggest(com.mojang.brigadier.suggestion.SuggestionProvider<S> provider)

Add a suggestion provider to the most recent node.

Parameters:

provider - The suggestion provider

Returns:

The line argument builder

defaultValue

public LineArgumentBuilder<S> defaultValue()

Make the most recent literal node optional.

Returns:

The line argument builder

defaultValue

public LineArgumentBuilder<S> defaultValue(java.lang.Object defaultValue)

Make the most recent argument node optional with the given default value.

Parameters:

defaultValue - The default value

Returns:

The line argument builder

defaultValue

public LineArgumentBuilder<S> defaultValue(java.util.function.Supplier<java.lang.Object> supplier)

Make the most recent argument node optional with the given default supplier.

Parameters:

supplier - The default supplier

Returns:

The line argument builder

execute

public com.mojang.brigadier.builder.ArgumentBuilder<S,?> execute(java.util.function.Consumer<com.mojang.brigadier.context.CommandContext<S>> executor)

Set the executor for the line and finalize it.
The line can no longer be modified after this method has been called.

Parameters:

executor - The executor

Returns:

The line argument builder

execute

public com.mojang.brigadier.builder.ArgumentBuilder<S,?> execute(com.mojang.brigadier.Command<S> executor)

Set the executor for the line and finalize it.
The line can no longer be modified after this method has been called.

Parameters:

executor - The executor

Returns:

The line argument builder

getThis

protected LineArgumentBuilder<S> getThis()

Specified by:

getThis in class com.mojang.brigadier.builder.ArgumentBuilder<S,LineArgumentBuilder<S>>

build

public com.mojang.brigadier.tree.CommandNode<S> build()

Specified by:

build in class com.mojang.brigadier.builder.ArgumentBuilder<S,LineArgumentBuilder<S>>