Add NoSuchCommandException

This commit is contained in:
Alexander Söderberg 2020-09-02 17:20:59 +02:00
parent 753ab1dba8
commit 9ca5675c71
No known key found for this signature in database
GPG key ID: C0207FF7EA146678
3 changed files with 159 additions and 19 deletions

View file

@ -27,6 +27,7 @@ import com.google.common.base.Objects;
import com.google.common.collect.Lists; import com.google.common.collect.Lists;
import com.intellectualsites.commands.components.CommandComponent; import com.intellectualsites.commands.components.CommandComponent;
import com.intellectualsites.commands.components.StaticComponent; import com.intellectualsites.commands.components.StaticComponent;
import com.intellectualsites.commands.exceptions.NoSuchCommandException;
import com.intellectualsites.commands.parser.ComponentParseResult; import com.intellectualsites.commands.parser.ComponentParseResult;
import com.intellectualsites.commands.sender.CommandSender; import com.intellectualsites.commands.sender.CommandSender;
@ -37,8 +38,10 @@ import java.util.stream.Collectors;
/** /**
* Tree containing all commands and command paths * Tree containing all commands and command paths
*
* @param <C> Command sender type
*/ */
public class CommandTree { public class CommandTree<C extends CommandSender> {
private final Node<CommandComponent<?>> internalTree = new Node<>(null); private final Node<CommandComponent<?>> internalTree = new Node<>(null);
@ -48,22 +51,21 @@ public class CommandTree {
/** /**
* Create a new command tree instance * Create a new command tree instance
* *
* @param <C> Command sender type
* @return New command tree * @return New command tree
*/ */
@Nonnull public static CommandTree newTree() { @Nonnull
return new CommandTree(); public static <C extends CommandSender> CommandTree<C> newTree() {
return new CommandTree<>();
} }
public Optional<Command> parse(@Nonnull final String[] args) { public Optional<Command> parse(@Nonnull final C commandSender, @Nonnull final String[] args) throws NoSuchCommandException {
final CommandSender tempSender = new CommandSender() {
};
final Queue<String> commandQueue = new LinkedList<>(Arrays.asList(args)); final Queue<String> commandQueue = new LinkedList<>(Arrays.asList(args));
return parseCommand(tempSender, commandQueue, this.internalTree); return parseCommand(commandSender, commandQueue, this.internalTree);
} }
private Optional<Command> parseCommand(@Nonnull final CommandSender commandSender, @Nonnull final Queue<String> commandQueue, private Optional<Command> parseCommand(@Nonnull final C commandSender, @Nonnull final Queue<String> commandQueue,
@Nonnull final Node<CommandComponent<?>> root) { @Nonnull final Node<CommandComponent<?>> root) throws NoSuchCommandException {
final List<Node<CommandComponent<?>>> children = root.getChildren(); final List<Node<CommandComponent<?>>> children = root.getChildren();
if (children.size() == 1 && !(children.get(0).getValue() instanceof StaticComponent)) { if (children.size() == 1 && !(children.get(0).getValue() instanceof StaticComponent)) {
@ -126,7 +128,7 @@ public class CommandTree {
} }
/* We could not find a match */ /* We could not find a match */
/* TODO: Send "No Such Command" */ throw new NoSuchCommandException(commandSender, getChain(root).stream().map(Node::getValue).collect(Collectors.toList()), popped);
} }
/* /*
@ -243,13 +245,15 @@ public class CommandTree {
return Collections.unmodifiableList(this.children); return Collections.unmodifiableList(this.children);
} }
@Nonnull private Node<T> addChild(@Nonnull final T child) { @Nonnull
private Node<T> addChild(@Nonnull final T child) {
final Node<T> node = new Node<>(child); final Node<T> node = new Node<>(child);
this.children.add(node); this.children.add(node);
return node; return node;
} }
@Nullable private Node<T> getChild(@Nonnull final T type) { @Nullable
private Node<T> getChild(@Nonnull final T type) {
for (final Node<T> child : this.children) { for (final Node<T> child : this.children) {
if (type.equals(child.getValue())) { if (type.equals(child.getValue())) {
return child; return child;
@ -262,7 +266,8 @@ public class CommandTree {
return this.children.isEmpty(); return this.children.isEmpty();
} }
@Nullable public T getValue() { @Nullable
public T getValue() {
return this.value; return this.value;
} }
@ -288,7 +293,8 @@ public class CommandTree {
this.parent = parent; this.parent = parent;
} }
@Nullable public Node<T> getParent() { @Nullable
public Node<T> getParent() {
return this.parent; return this.parent;
} }

View file

@ -0,0 +1,72 @@
//
// MIT License
//
// Copyright (c) 2020 IntellectualSites
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
package com.intellectualsites.commands.exceptions;
import com.intellectualsites.commands.components.CommandComponent;
import com.intellectualsites.commands.sender.CommandSender;
import javax.annotation.Nonnull;
import java.util.Collections;
import java.util.List;
/**
* Exception thrown when parsing user input into a command
*/
public class CommandParseException extends IllegalArgumentException {
private final CommandSender commandSender;
private final List<CommandComponent<?>> currentChain;
/**
* Construct a new command parse exception
*
* @param commandSender Sender who executed the command
* @param currentChain Chain leading up to the exception
*/
protected CommandParseException(@Nonnull final CommandSender commandSender, @Nonnull final List<CommandComponent<?>> currentChain) {
this.commandSender = commandSender;
this.currentChain = currentChain;
}
/**
* Get the command sender
*
* @return Command sender
*/
@Nonnull
public CommandSender getCommandSender() {
return this.commandSender;
}
/**
* Get the command chain leading up to the exception
*
* @return Unmodifiable list of command components
*/
@Nonnull
public List<CommandComponent<?>> getCurrentChain() {
return Collections.unmodifiableList(this.currentChain);
}
}

View file

@ -0,0 +1,62 @@
//
// MIT License
//
// Copyright (c) 2020 IntellectualSites
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
package com.intellectualsites.commands.exceptions;
import com.intellectualsites.commands.components.CommandComponent;
import com.intellectualsites.commands.sender.CommandSender;
import javax.annotation.Nonnull;
import java.util.List;
/**
* Exception thrown when a command sender tries to execute
* a command that doesn't exist
*/
public class NoSuchCommandException extends CommandParseException {
private final String suppliedCommand;
/**
* Construct a no such command exception
*
* @param commandSender Sender who executed the command
* @param currentChain Chain leading up to the exception
* @param command Entered command (following the command chain)
*/
public NoSuchCommandException(@Nonnull final CommandSender commandSender, @Nonnull final List<CommandComponent<?>> currentChain,
@Nonnull final String command) {
super(commandSender, currentChain);
this.suppliedCommand = command;
}
/**
* Get the supplied command
*
* @return Supplied command
*/
@Nonnull public String getSuppliedCommand() {
return this.suppliedCommand;
}
}