checkstyle'd

[nikiroo-utils.git] / src / jexer / event / TKeypressEvent.java

diff --git a/src/jexer/event/TKeypressEvent.java b/src/jexer/event/TKeypressEvent.java
index 4f54df907ba16e62649a98df25cdca3269d66b37..31bc4aea04c02b5cb8cb52b8b993eba54e18ae60 100644 (file)
--- a/src/jexer/event/TKeypressEvent.java
+++ b/src/jexer/event/TKeypressEvent.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,6 +24,9 @@
  * 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;
 
@@ -40,31 +38,33 @@ import jexer.TKeypress;
 public class TKeypressEvent extends TInputEvent {
 
     /**
-     * Keystroke received
+     * Keystroke received.
      */
     public TKeypress key;
 
     /**
-     * Public contructor
+     * Public contructor sets the key to the special kbNoKey.
      */
     public TKeypressEvent() {
-       key = new TKeypress(false, 0, ' ', false, false, false);
+        key = TKeypress.kbNoKey;
     }
 
     /**
-     * Public contructor
+     * Public contructor.
      *
      * @param key the TKeypress received
      */
-    public TKeypressEvent(TKeypress key) {
-       this.key = key;
+    public TKeypressEvent(final TKeypress key) {
+        this.key = key;
     }
 
     /**
-     * Make human-readable description of this event
+     * Make human-readable description of this TKeypressEvent.
+     *
+     * @return displayable String
      */
     @Override
-    public String toString() {
-       return String.format("Keypress: %s", key.toString());
+    public final String toString() {
+        return String.format("Keypress: %s", key.toString());
     }
 }