com.mrivanplays.commandworker.core.argument

Class LiteralArgument

java.lang.Object

com.mrivanplays.commandworker.core.argument.LiteralArgument

All Implemented Interfaces:

Argument

public final class LiteralArgument
extends Object
implements Argument

Represents literal argument. This is a wrapper for brigadier's LiteralArgumentBuilder, wrapped for easier use.

Method Summary

Modifier and Type	Method and Description
@NotNull List<Argument>	getChildren() Returns unmodifiable copy of the children this argument is holding.
@NotNull String	getName() Returns the name of the argument.
static @NotNull LiteralArgument	literal(@NotNull String name) Creates a new LiteralArgument
@NotNull LiteralArgument	markShouldExecuteCommand()
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 LiteralArgument	then(Argument... other)
@NotNull LiteralArgument	then(@NotNull Argument other) Adds a child to this argument.
@NotNull LiteralArgument	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

getArgumentType, getSuggestionsConsumer, isLiteral

Method Detail

literal

@NotNull
public static @NotNull LiteralArgument literal(@NotNull
                                                        @NotNull String name)

Creates a new LiteralArgument

Parameters:

name - completion value you see ingame.

Returns:

literal 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

then

@NotNull
public @NotNull LiteralArgument then(@NotNull
                                              @NotNull Argument other)

Adds a child to this argument.

Parameters:

other - child

Returns:

this instance for chaining

then

@NotNull
public @NotNull LiteralArgument then(@NotNull
                                              Argument... other)

then

@NotNull
public @NotNull LiteralArgument then(@NotNull
                                              @NotNull Iterable<Argument> iterable)

markShouldExecuteCommand

@NotNull
public @NotNull LiteralArgument markShouldExecuteCommand()

Returns:

this instance for chaining

See Also:

Argument.shouldExecuteCommand()

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