Changeset 1276 for trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/eventcore

Timestamp:

07/26/13 09:20:36 (11 years ago)

Author:

pharms

Message:

• added some Java Docs

File:

• trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/eventcore/HTMLEventTypeFactory.java (modified) (5 diffs)

trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/eventcore/HTMLEventTypeFactory.java

@@ -39 +39 @@
 /**
  * <p>
- * TODO comment
+ * convenience class to instantiate the correct event type based on an event name, event parameters,
+ * and the target GUI element.
  * </p>
  * 
@@ -47 +48 @@
 public class HTMLEventTypeFactory {
     
-    /**  */
+    /**
+     * <p>
+     * single instance
+     * </p>
+     */
     private static HTMLEventTypeFactory instance = new HTMLEventTypeFactory();
 
     /**
      * <p>
-     * TODO: comment
+     * private constructor to implement correct singleton
      * </p>
-     *
      */
     private HTMLEventTypeFactory() {}
@@ -60 +64 @@
     /**
      * <p>
-     * TODO: comment
+     * singleton retrieval
      * </p>
-     *
-     * @return
      */
     public static HTMLEventTypeFactory getInstance() {
@@ -71 +73 @@
     /**
      * <p>
-     * TODO: comment
+     * returns the event type for the given event name, the parameters as well as the target GUI
+     * element
      * </p>
      *
-     * @param eventName
-     * @param eventParameters
-     * @return
+     * @param eventName       the name of the event, e.g., onscroll
+     * @param eventParameters the parameters of the event, e.g., scroll coordinates
+     * @param guiElement      the target GUI element of the event (required for some event type
+     *                        differentiation
+     *                        
+     * @return the event type matching the proviced parameters
+     * 
+     * @throws IllegalArgumentException if the provided parameters in their combination do not
+     *                                  correctly specify an event type 
      */
-    public IEventType getEventType(String eventName, Map<String, String> eventParameters, 
-                                   IGUIElement guiElement) {
+    public IEventType getEventType(String              eventName,
+                                   Map<String, String> eventParameters, 
+                                   IGUIElement         guiElement)
+    {
         IInteraction result = null;
 
@@ -142 +153 @@
     /**
      * <p>
-     * TODO: comment
+     * convenience method to retrieve coordinates from the event parameters.
      * </p>
-     * 
-     * @param eventName
-     * @param eventParameters
-     * @return
      */
     private int[] getCoordinateParameter(String              xParamName,