Changeset 835 for trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/eventcore/JFCEventId.java

Timestamp:

09/20/12 10:36:09 (12 years ago)

Author:

sherbold

Message:

• code documentation and clean-up

File:

• trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/eventcore/JFCEventId.java (modified) (5 diffs)

trunk/quest-plugin-jfc/src/main/java/de/ugoe/cs/quest/plugin/jfc/eventcore/JFCEventId.java

@@ +1 @@
+
 package de.ugoe.cs.quest.plugin.jfc.eventcore;
 
@@ -6 +7 @@
 
 /**
- * TODO comment
+ * <p>
+ * Enumeration to deal with JFC event ids.
+ * </p>
  * 
- * @version $Revision: $ $Date: $
- * @author 2011, last modified by $Author: $
+ * @version 1.0
+ * @author Patrick Harms
  */
 public enum JFCEventId {
-    
-    MOUSE_CLICKED(MouseEvent.MOUSE_CLICKED),
-    MOUSE_PRESSED(MouseEvent.MOUSE_PRESSED),
-    MOUSE_RELEASED(MouseEvent.MOUSE_RELEASED),
-    MOUSE_MOVED(MouseEvent.MOUSE_MOVED),
-    MOUSE_ENTERED(MouseEvent.MOUSE_ENTERED),
-    MOUSE_EXITED(MouseEvent.MOUSE_EXITED),
-    MOUSE_DRAGGED(MouseEvent.MOUSE_DRAGGED),
-    MOUSE_WHEEL(MouseEvent.MOUSE_WHEEL),
-    FOCUS_GAINED(FocusEvent.FOCUS_GAINED),
-    FOCUS_LOST(FocusEvent.FOCUS_LOST),
-    KEY_TYPED(KeyEvent.KEY_TYPED),
-    KEY_PRESSED(KeyEvent.KEY_PRESSED),
-    KEY_RELEASED(KeyEvent.KEY_RELEASED);
 
-    /** the numerical representation of the event type */
+    MOUSE_CLICKED(MouseEvent.MOUSE_CLICKED), MOUSE_PRESSED(MouseEvent.MOUSE_PRESSED),
+    MOUSE_RELEASED(MouseEvent.MOUSE_RELEASED), MOUSE_MOVED(MouseEvent.MOUSE_MOVED), MOUSE_ENTERED(
+        MouseEvent.MOUSE_ENTERED), MOUSE_EXITED(MouseEvent.MOUSE_EXITED), MOUSE_DRAGGED(
+        MouseEvent.MOUSE_DRAGGED), MOUSE_WHEEL(MouseEvent.MOUSE_WHEEL), FOCUS_GAINED(
+        FocusEvent.FOCUS_GAINED), FOCUS_LOST(FocusEvent.FOCUS_LOST), KEY_TYPED(KeyEvent.KEY_TYPED),
+    KEY_PRESSED(KeyEvent.KEY_PRESSED), KEY_RELEASED(KeyEvent.KEY_RELEASED);
+
+    /**
+     * <p>
+     * Numerical representation of the event type.
+     * </p>
+     */
     private int mNumber;
 
     /**
+     * <p>
+     * Constructor. Creates a new JFCEventId.
+     * </p>
+     * 
      * @param number
+     *            numerical representation of the event type.
      */
     JFCEventId(int number) {
@@ -38 +43 @@
 
     /**
-     * @return Returns the number.
+     * <p>
+     * Returns the numerical representation of the event type.
+     * </p>
+     * 
+     * @return the numerical representation
      */
     public int getNumber() {
@@ -45 +54 @@
 
     /**
-     *
+     * <p>
+     * Parses an {@link String} and returns the respective JFCEventId if possible.
+     * </p>
+     * 
+     * @param numberString
+     *            String representation of the event type
+     * @return created JFCEventId
+     * @throws IllegalArgumentException
+     *             thrown if there is no JFCEventId that correlates to numberString
      */
-    public static JFCEventId parseEventId(String numberString) {
+    public static JFCEventId parseEventId(String numberString) throws IllegalArgumentException {
         try {
             int number = Integer.parseInt(numberString);
@@ -58 +75 @@
 
     /**
-     *
+     * <p>
+     * Returns the JFCEventId associated with an integer.
+     * </p>
+     * 
+     * @param number
+     *            integer to which the according JFCEventId is returned
+     * @return the JFCEventId
+     * @throws IllegalArgumentException
+     *             thrown if there is no JFCEventId that correlates to number
      */
-    public static JFCEventId valueOf(int number) {
+    public static JFCEventId valueOf(int number) throws IllegalArgumentException {
         for (JFCEventId type : JFCEventId.values()) {
             if (type.mNumber == number) {