Module net.minestom.server

Package net.minestom.server.command.builder.parser

Class CommandParser

java.lang.Object

net.minestom.server.command.builder.parser.CommandParser

public final class CommandParser
extends Object

Class used to parse complete command inputs.

Constructor Summary

Constructors

Constructor	Description
CommandParser()

Method Summary

Modifier and Type	Method	Description
static @Nullable CommandQueryResult	findCommand(CommandDispatcher dispatcher, String input)
static @Nullable ArgumentQueryResult	findEligibleArgument(CommandSender sender, Command command, String[] args, String commandString, boolean trailingSpace, boolean forceCorrect, Predicate<CommandSyntax> syntaxPredicate, Predicate<Argument<?>> argumentPredicate)
static @Nullable ValidSyntaxHolder	findMostCorrectSyntax(List<ValidSyntaxHolder> validSyntaxes, CommandContext context)	Retrieves from the valid syntax map the arguments condition result and get the one with the most valid arguments.
static void	parse(CommandSender sender, @Nullable CommandSyntax syntax, Argument<?>[] commandArguments, String[] inputArguments, String commandString, @Nullable List<ValidSyntaxHolder> validSyntaxes, @Nullable it.unimi.dsi.fastutil.ints.Int2ObjectRBTreeMap<CommandSuggestionHolder> syntaxesSuggestions)

Methods inherited from class java.lang.Object

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

Constructor Details

CommandParser

public CommandParser()

Method Details

findCommand

@Nullable
public static @Nullable CommandQueryResult findCommand(CommandDispatcher dispatcher,
 String input)

parse

public static void parse(CommandSender sender,
 @Nullable
 @Nullable CommandSyntax syntax,
 Argument<?>[] commandArguments,
 String[] inputArguments,
 String commandString,
 @Nullable
 @Nullable List<ValidSyntaxHolder> validSyntaxes,
 @Nullable
 @Nullable it.unimi.dsi.fastutil.ints.Int2ObjectRBTreeMap<CommandSuggestionHolder> syntaxesSuggestions)

findMostCorrectSyntax

@Nullable
public static @Nullable ValidSyntaxHolder findMostCorrectSyntax(List<ValidSyntaxHolder> validSyntaxes,
 CommandContext context)

Retrieves from the valid syntax map the arguments condition result and get the one with the most valid arguments.

Parameters:

validSyntaxes - the list containing all the valid syntaxes

context - the recipient of the argument parsed values

Returns:

the command syntax with all of its arguments correct and with the most arguments count, null if not any

findEligibleArgument

@Nullable
public static @Nullable ArgumentQueryResult findEligibleArgument(CommandSender sender,
 Command command,
 String[] args,
 String commandString,
 boolean trailingSpace,
 boolean forceCorrect,
 Predicate<CommandSyntax> syntaxPredicate,
 Predicate<Argument<?>> argumentPredicate)