com.mrivanplays.commandworker.core.argument.parser

Class ArgumentHolder

java.lang.Object

com.mrivanplays.commandworker.core.argument.parser.ArgumentHolder

public final class ArgumentHolder
extends Object

Represents a holder of arguments.

Constructor Summary

Constructors

Constructor and Description
ArgumentHolder(String input, LiteralNode commandStructure)

Method Summary

Modifier and Type	Method and Description
@NotNull String	buildUsage()
@NotNull String	buildUsage(@Nullable String alias)
@Nullable IndexRange	getArgumentIndex(@NotNull String argumentName) Returns the IndexRange of the specified argument name, if the argument was defined in the command structure.
@NotNull LiteralNode	getCommandStructure() Returns the command structure of the arguments held by this argument holder.
@NotNull String	getInput() Returns the sender argument input.
@Nullable Argument	getLastArgument() Returns the last argument, for which we have a value.
@NotNull String[]	getRawArgs() Returns the arguments in their raw state.
@Nullable String	getRawRequiredArgument(@NotNull String argumentName) Returns the specified required argument's name's argument if is typed in its raw state.
<V> V	getRequiredArgument(@NotNull String name, @NotNull Class<V> type) Retrieves the required argument with the specified name, which should be parsed to the specified type.
boolean	isTyped(@NotNull String argumentName) Returns whether or not the specified argument is typed (being present when the command was executed).
int	size() Returns the arguments length.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArgumentHolder

public ArgumentHolder(String input,
                      LiteralNode commandStructure)

Method Detail

getRequiredArgument

@Nullable
public <V> V getRequiredArgument(@NotNull
                                           @NotNull String name,
                                           @NotNull
                                           @NotNull Class<V> type)
                                    throws com.mojang.brigadier.exceptions.CommandSyntaxException

Retrieves the required argument with the specified name, which should be parsed to the specified type.

Type Parameters:

V - value type

Parameters:

name - argument name

type - argument type

Returns:

value

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException

getLastArgument

@Nullable
public @Nullable Argument getLastArgument()

Returns the last argument, for which we have a value.

Returns:

last argument

getArgumentIndex

@Nullable
public @Nullable IndexRange getArgumentIndex(@NotNull
                                                       @NotNull String argumentName)

Returns the IndexRange of the specified argument name, if the argument was defined in the command structure.

Parameters:

argumentName - argument name

Returns:

range if present

isTyped

public boolean isTyped(@NotNull
                       @NotNull String argumentName)

Returns whether or not the specified argument is typed (being present when the command was executed).

Parameters:

argumentName - the argument's name that you want to check if has value or not.

Returns:

true if typed, false otherwise

getRawRequiredArgument

@Nullable
public @Nullable String getRawRequiredArgument(@NotNull
                                                         @NotNull String argumentName)
                                                  throws com.mojang.brigadier.exceptions.CommandSyntaxException

Returns the specified required argument's name's argument if is typed in its raw state.

Parameters:

argumentName - argument name

Returns:

argument

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException

size

public int size()

Returns the arguments length.

Returns:

length

getRawArgs

@NotNull
public @NotNull String[] getRawArgs()

Returns the arguments in their raw state.

Returns:

raw arguments

getInput

@NotNull
public @NotNull String getInput()

Returns the sender argument input.

Returns:

input

getCommandStructure

@NotNull
public @NotNull LiteralNode getCommandStructure()

Returns the command structure of the arguments held by this argument holder.

Returns:

command structure node

buildUsage

@NotNull
public @NotNull String buildUsage()

Returns:

argument usage

See Also:

LiteralNode.buildUsage()

buildUsage

@NotNull
public @NotNull String buildUsage(@Nullable
                                           @Nullable String alias)

Parameters:

alias - command alias for which you want full command usage

Returns:

command usage

See Also:

LiteralNode.buildUsage(String)