com.mrivanplays.commandworker.core.argument

Class RequiredArgument<V>

java.lang.Object

com.mrivanplays.commandworker.core.argument.RequiredArgument<V>

Type Parameters:

V - type of the argument type.

All Implemented Interfaces:

Argument

public final class RequiredArgument<V>
extends Object
implements Argument

Represents required argument. This is a wrapper for brigadier's RequiredArgumentType, wrapped for easier use.

Method Summary

Modifier and Type	Method and Description
static <T> @NotNull RequiredArgument<T>	argument(@NotNull String name, @NotNull com.mojang.brigadier.arguments.ArgumentType<T> type) Creates a new RequiredArgument
<T> @NotNull com.mojang.brigadier.arguments.ArgumentType<T>	getArgumentType() Returns the brigadier argument type, if the argument is required.
@NotNull List<Argument>	getChildren() Returns unmodifiable copy of the children this argument is holding.
@NotNull String	getName() Returns the name of the argument.
@Nullable Consumer<com.mojang.brigadier.suggestion.SuggestionsBuilder>	getSuggestionsConsumer() Returns the SuggestionsBuilder consumer, which is able to modify the suggestions for this argument.
@NotNull RequiredArgument<V>	markShouldNotExecuteCommand()
boolean	shouldExecuteCommand() Returns whether or not this argument should call the base command's execute method when the argument ends up being the last typed argument.
@NotNull RequiredArgument<V>	suggests(@Nullable Consumer<com.mojang.brigadier.suggestion.SuggestionsBuilder> suggestionsConsumer) Sets the SuggestionsBuilder modifications to get applied later.
@NotNull RequiredArgument<V>	then(Argument... other)
@NotNull RequiredArgument<V>	then(@NotNull Argument child) Adds a child to this required argument.
@NotNull RequiredArgument<V>	then(@NotNull Iterable<Argument> iterable)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mrivanplays.commandworker.core.argument.Argument

isLiteral

Method Detail

argument

@NotNull
public static <T> @NotNull RequiredArgument<T> argument(@NotNull
                                                                 @NotNull String name,
                                                                 @NotNull
                                                                 @NotNull com.mojang.brigadier.arguments.ArgumentType<T> type)

Creates a new RequiredArgument

Type Parameters:

T - type of the argument type

Parameters:

name - completion value you see ingame

type - type

Returns:

required argument

getName

@NotNull
public @NotNull String getName()

Description copied from interface: Argument

Returns the name of the argument. Usually the completion you see if the argument is literal

Specified by:

getName in interface Argument

Returns:

name

getArgumentType

@NotNull
public <T> @NotNull com.mojang.brigadier.arguments.ArgumentType<T> getArgumentType()

Description copied from interface: Argument

Returns the brigadier argument type, if the argument is required.

A literal argument does not have a dedicated argument type, and this will return null if the argument is literal.

Specified by:

getArgumentType in interface Argument

Type Parameters:

T - the type held by the argument type.

Returns:

argument type

then

@NotNull
public @NotNull RequiredArgument<V> then(@NotNull
                                                  @NotNull Argument child)

Adds a child to this required argument.

Parameters:

child - child

Returns:

this instance for chaining

then

@NotNull
public @NotNull RequiredArgument<V> then(@NotNull
                                                  Argument... other)

then

@NotNull
public @NotNull RequiredArgument<V> then(@NotNull
                                                  @NotNull Iterable<Argument> iterable)

suggests

@NotNull
public @NotNull RequiredArgument<V> suggests(@Nullable
                                                      @Nullable Consumer<com.mojang.brigadier.suggestion.SuggestionsBuilder> suggestionsConsumer)

Sets the SuggestionsBuilder modifications to get applied later.

We do not suggest using suggestions builder to add your suggestions. Instead, use literal arguments with combination with a required one

Parameters:

suggestionsConsumer - suggestions consumer

Returns:

this instance for chaining

markShouldNotExecuteCommand

@NotNull
public @NotNull RequiredArgument<V> markShouldNotExecuteCommand()

Returns:

this instance for chaining

See Also:

Argument.shouldExecuteCommand()

getSuggestionsConsumer

@Nullable
public @Nullable Consumer<com.mojang.brigadier.suggestion.SuggestionsBuilder> getSuggestionsConsumer()

Description copied from interface: Argument

Returns the SuggestionsBuilder consumer, which is able to modify the suggestions for this argument. By default, this returns null.

We do not suggest using suggestions builder to add your suggestions. Instead, use literal arguments with combination with a required one

Specified by:

getSuggestionsConsumer in interface Argument

Returns:

suggestions consumer

shouldExecuteCommand

public boolean shouldExecuteCommand()

Description copied from interface: Argument

Returns whether or not this argument should call the base command's execute method when the argument ends up being the last typed argument. This marking is being ignored if brigadier isn't supported for the minecraft version your plugin is being ran on.

Specified by:

shouldExecuteCommand in interface Argument

Returns:

true if should have execute, false otherwise

getChildren

@NotNull
public @NotNull List<Argument> getChildren()

Description copied from interface: Argument

Returns unmodifiable copy of the children this argument is holding.

Specified by:

getChildren in interface Argument

Returns:

children

toString

public String toString()

Overrides:

toString in class Object