checkstyle'd

[fanfix.git] / src / jexer / event / TCommandEvent.java

diff --git a/src/jexer/event/TCommandEvent.java b/src/jexer/event/TCommandEvent.java
index d27c7eab2aa4f0fd3653f37fe30ce3fc2774fe07..09304d3b5a3d27e6e5d08bf77f83b7a18ffd7e9d 100644 (file)
--- a/src/jexer/event/TCommandEvent.java
+++ b/src/jexer/event/TCommandEvent.java
@@ -1,16 +1,11 @@
 /**
  * Jexer - Java Text User Interface
  *
- * Version: $Id$
- *
- * Author: Kevin Lamonte, <a href="mailto:kevin.lamonte@gmail.com">kevin.lamonte@gmail.com</a>
- *
  * License: LGPLv3 or later
  *
- * Copyright: This module is licensed under the GNU Lesser General
- * Public License Version 3.  Please see the file "COPYING" in this
- * directory for more information about the GNU Lesser General Public
- * License Version 3.
+ * This module is licensed under the GNU Lesser General Public License
+ * Version 3.  Please see the file "COPYING" in this directory for more
+ * information about the GNU Lesser General Public License Version 3.
  *
  *     Copyright (C) 2015  Kevin Lamonte
  *
@@ -29,36 +24,51 @@
  * http://www.gnu.org/licenses/, or write to the Free Software
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  * 02110-1301 USA
+ *
+ * @author Kevin Lamonte [kevin.lamonte@gmail.com]
+ * @version 1
  */
 package jexer.event;
 
 import jexer.TCommand;
 
 /**
- * This class encapsulates a user command event.
+ * This class encapsulates a user command event.  User commands can be
+ * generated by menu actions, keyboard accelerators, and other UI elements.
+ * Commands can operate on both the application and individual widgets.
  */
 public class TCommandEvent extends TInputEvent {
 
     /**
-     * Command dispatched
+     * Command dispatched.
+     */
+    private TCommand cmd;
+
+    /**
+     * Get TCommand.
+     *
+     * @return the TCommand
      */
-    public TCommand cmd;
+    public final TCommand getCmd() {
+        return cmd;
+    }
 
     /**
-     * Public contructor
+     * Public contructor.
      *
      * @param cmd the TCommand dispatched
      */
-    public TCommandEvent(TCommand cmd) {
-       this.cmd = cmd;
+    public TCommandEvent(final TCommand cmd) {
+        this.cmd = cmd;
     }
 
     /**
-     * Make human-readable description of this event
+     * Make human-readable description of this TCommandEvent.
+     *
+     * @return displayable String
      */
     @Override
-    public String toString() {
-       return String.format("CommandEvent: %s", cmd.toString());
+    public final String toString() {
+        return String.format("CommandEvent: %s", cmd.toString());
     }
 }
-