Changeset 837 for trunk/quest-plugin-mfc/src/main/java/de/ugoe/cs/quest/plugin/mfc/eventcore/WindowsVirtualKey.java

Timestamp:

09/20/12 12:03:03 (12 years ago)

Author:

sherbold

Message:

• code documentation and clean-up

File:

• trunk/quest-plugin-mfc/src/main/java/de/ugoe/cs/quest/plugin/mfc/eventcore/WindowsVirtualKey.java (modified) (4 diffs)

trunk/quest-plugin-mfc/src/main/java/de/ugoe/cs/quest/plugin/mfc/eventcore/WindowsVirtualKey.java

@@ -5 +5 @@
 
 /**
- * TODO comment
+ * <p>
+ * Map of virtual keys for MFC.
+ * </p>
  * 
- * @version $Revision: $ $Date: $
- * @author 2011, last modified by $Author: $
+ * @version 1.0
+ * @author Patrick Harms
  */
-// -------------------------------------------------------------------------------------------------
-
-public enum WindowsVirtualKey
-{
+public enum WindowsVirtualKey {
     // VK_LBUTTON (0x01, "Left mouse button"),
     // VK_RBUTTON (0x02, "Right mouse button"),
@@ -168 +167 @@
     // VK_OEM_CLEAR (0xFE, "Clear key");
 
-    /** the id of the virtual key */
+    /**
+     * <p>
+     * Numerical representation of the virtual key.
+     * </p>
+     */
     private int mNumber;
 
-    /** the <code>Key</code> represented by this virtual key */
+    /**
+     * <p>
+     * {@link VirtualKey} represented by this WindowsVirtualKey
+     * </p>
+     */
     private VirtualKey mRepresentedKey;
 
-    // -----------------------------------------------------------------------------------------------
-    /**
+    /**
+     * <p>
+     * Constructor. Creates a new WindowsVirtualKey.
+     * </p>
+     * 
      * @param number
-     */
-    // -----------------------------------------------------------------------------------------------
-    WindowsVirtualKey(int number, VirtualKey representedKey)
-    {
+     *            numerical representation of the virtual key
+     * @param representedKey
+     *            virtual key that is represented
+     */
+    WindowsVirtualKey(int number, VirtualKey representedKey) {
         mNumber = number;
         mRepresentedKey = representedKey;
     }
 
-    // -----------------------------------------------------------------------------------------------
-    /**
-     * @return Returns the number.
-     */
-    // -----------------------------------------------------------------------------------------------
-    int getNumber()
-    {
+    /**
+     * <p>
+     * Returns the numerical representation of the virtual key.
+     * </p>
+     * 
+     * @return the numerical representation
+     */
+    int getNumber() {
         return mNumber;
     }
 
-    // -----------------------------------------------------------------------------------------------
-    /**
-   *
-   */
-    // -----------------------------------------------------------------------------------------------
-    public static WindowsVirtualKey parseVirtualKey(String string)
-    {
-        for (WindowsVirtualKey virtualKey : WindowsVirtualKey.values())
-        {
-            if (virtualKey.mNumber == Integer.parseInt(string))
-            {
+    /**
+     * <p>
+     * Parses an {@link String} and returns the respective WindowsVirtualKey if possible.
+     * </p>
+     * 
+     * @param string
+     *            String representation of the event type
+     * @return created WindowsVirtualKey
+     * @throws IllegalArgumentException
+     *             thrown if there is no WindowsVirtualKey that correlates to string
+     */
+    public static WindowsVirtualKey parseVirtualKey(String string) throws IllegalArgumentException {
+        for (WindowsVirtualKey virtualKey : WindowsVirtualKey.values()) {
+            if (virtualKey.mNumber == Integer.parseInt(string)) {
                 return virtualKey;
             }
@@ -213 +228 @@
     }
 
-    // -----------------------------------------------------------------------------------------------
-    /**
-   *
-   */
-    // -----------------------------------------------------------------------------------------------
-    public static WindowsVirtualKey valueOf(int number)
-    {
-        for (WindowsVirtualKey virtualKey : WindowsVirtualKey.values())
-        {
-            if (virtualKey.mNumber == number)
-            {
+    /**
+     * <p>
+     * Returns the WindowsVirtualKey associated with an integer.
+     * </p>
+     * 
+     * @param number
+     *            integer to which the according WindowsVirtualKey is returned
+     * @return the WindowsVirtualKey
+     * @throws IllegalArgumentException
+     *             thrown if there is no WindowsVirtualKey that correlates to number
+     */
+    public static WindowsVirtualKey valueOf(int number) throws IllegalArgumentException {
+        for (WindowsVirtualKey virtualKey : WindowsVirtualKey.values()) {
+            if (virtualKey.mNumber == number) {
                 return virtualKey;
             }
@@ -231 +249 @@
     }
 
-    // -----------------------------------------------------------------------------------------------
-    /**
-     * TODO: comment
-     * 
-     * @return
-     */
-    // -----------------------------------------------------------------------------------------------
-    public VirtualKey getKey()
-    {
+    /**
+     * <p>
+     * Returns the {@link VirtualKey} associated with this WindowsVirtualKey.
+     * </p>
+     * 
+     * @return the virtual key
+     */
+    public VirtualKey getKey() {
         return mRepresentedKey;
     }