Merge pull request #2622 from Multiverse/queue-system-cleanup

Queue system cleanup
This commit is contained in:
nicegamer7 2021-05-16 11:29:23 -04:00 committed by GitHub
commit 128442c062
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 8 deletions

View File

@ -21,7 +21,10 @@ import java.util.Map;
import java.util.WeakHashMap; import java.util.WeakHashMap;
/** /**
* Managers the queuing of dangerous commands that needs to use '/mv confirm' before executing. * <p>Manages the queuing of dangerous commands that require {@code /mv confirm} before executing.</p>
*
* <p>Each sender can only have one command in queue at any given time. When a queued command is added
* for a sender that already has a command in queue, it will replace the old queued command.</p>
*/ */
public class CommandQueueManager { public class CommandQueueManager {
@ -37,9 +40,9 @@ public class CommandQueueManager {
} }
/** /**
* Adds a queue command into queue. * Adds a {@link QueuedCommand} into queue.
* *
* @param queuedCommand The queue command to add. * @param queuedCommand The queued command to add.
*/ */
public void addToQueue(QueuedCommand queuedCommand) { public void addToQueue(QueuedCommand queuedCommand) {
CommandSender targetSender = parseSender(queuedCommand.getSender()); CommandSender targetSender = parseSender(queuedCommand.getSender());
@ -57,7 +60,7 @@ public class CommandQueueManager {
} }
/** /**
* Expire task that remove {@link QueuedCommand} from queue after valid duration defined. * Expire task that removes a {@link QueuedCommand} from queue after valid duration defined.
* *
* @param queuedCommand Command to run the expire task on. * @param queuedCommand Command to run the expire task on.
* @return The expire {@link BukkitTask}. * @return The expire {@link BukkitTask}.
@ -130,7 +133,7 @@ public class CommandQueueManager {
/** /**
* To allow all CommandBlocks to be a common sender with use of {@link DummyCommandBlockSender}. * To allow all CommandBlocks to be a common sender with use of {@link DummyCommandBlockSender}.
* So confirm command can be used for a queue command on another command block. * So confirm command can be used for a queued command on another command block.
* *
* @param sender The sender to parse. * @param sender The sender to parse.
* @return The sender, or if its a command block, a {@link DummyCommandBlockSender}. * @return The sender, or if its a command block, a {@link DummyCommandBlockSender}.
@ -146,9 +149,9 @@ public class CommandQueueManager {
} }
/** /**
* Check if sender is a command block. * Checks if the sender is a command block.
* *
* @param sender The sender to check on. * @param sender The sender to check.
* @return True if sender is a command block, else false. * @return True if sender is a command block, else false.
*/ */
private boolean isCommandBlock(@NotNull CommandSender sender) { private boolean isCommandBlock(@NotNull CommandSender sender) {

View File

@ -94,7 +94,7 @@ class DummyCommandBlockSender implements CommandSender {
@Override @Override
public boolean isOp() { public boolean isOp() {
return true; throw new UnsupportedOperationException();
} }
@Override @Override