From 2ca3d148cce22c92813b1e974ab7f7c63cbeb815 Mon Sep 17 00:00:00 2001
From: Dinnerbone <dinnerbone@dinnerbone.com>
Date: Mon, 28 Feb 2011 10:35:58 +0000
Subject: PluginCommand getExecutor + javadocs

---
 .../java/org/bukkit/command/PluginCommand.java     | 25 ++++++++++++++++++++++
 1 file changed, 25 insertions(+)

(limited to 'src/main/java')

diff --git a/src/main/java/org/bukkit/command/PluginCommand.java b/src/main/java/org/bukkit/command/PluginCommand.java
index 22087ff9..2f306bb8 100644
--- a/src/main/java/org/bukkit/command/PluginCommand.java
+++ b/src/main/java/org/bukkit/command/PluginCommand.java
@@ -2,6 +2,9 @@ package org.bukkit.command;
 
 import org.bukkit.plugin.Plugin;
 
+/**
+ * Represents a {@link Command} belonging to a plugin
+ */
 public final class PluginCommand extends Command {
     private final Plugin owningPlugin;
     private CommandExecutor executor;
@@ -13,6 +16,14 @@ public final class PluginCommand extends Command {
         this.usageMessage = "";
     }
 
+    /**
+     * Executes the command, returning its success
+     *
+     * @param sender Source object which is executing this command
+     * @param commandLabel The alias of the command used
+     * @param args All arguments passed to the command, split via ' '
+     * @return true if the command was successful, otherwise false
+     */
     public boolean execute(CommandSender sender, String commandLabel, String[] args) {
         boolean success = false;
 
@@ -29,10 +40,24 @@ public final class PluginCommand extends Command {
         return success;
     }
 
+    /**
+     * Sets the {@link CommandExecutor} to run when parsing this command
+     *
+     * @param executor New executor to run
+     */
     public void setExecutor(CommandExecutor executor) {
         this.executor = executor;
     }
 
+    /**
+     * Gets the {@link CommandExecutor} associated with this command
+     *
+     * @return CommandExecutor object linked to this command
+     */
+    public CommandExecutor getExecutor() {
+        return executor;
+    }
+
     /**
      * Gets the owner of this PluginCommand
      *
-- 
cgit v1.2.3