Changeset 958 for trunk/autoquest-core-events

Timestamp:

10/30/12 14:00:22 (12 years ago)

Author:

pharms

Message:

• made event final, so that it can't be derived of
• added support for adding further event parameters

Location:

trunk/autoquest-core-events/src/main/java/de/ugoe/cs/autoquest/eventcore

Files:

• Event.java (modified) (6 diffs)
• gui/MouseClickCondenser.java (modified) (1 diff)

trunk/autoquest-core-events/src/main/java/de/ugoe/cs/autoquest/eventcore/Event.java

@@ -16 +16 @@
 
 import java.io.Serializable;
+import java.util.HashMap;
 import java.util.LinkedList;
 import java.util.List;
+import java.util.Map;
 
 /**
@@ -30 +32 @@
  *            Can be used to declare that events belong to a specific platform without subclassing.
  */
-public class Event implements Serializable {
+public final class Event implements Serializable {
 
     /**
@@ -57 +59 @@
      * </p>
      */
-    protected IEventType type;
+    private IEventType type;
 
     /**
      * </p> Target of the event.
      */
-    protected IEventTarget target = null;
+    private IEventTarget target = null;
+    
+    /**
+     * <p>
+     * Map with further parameters of the event, which are not belonging to the type or target.
+     * </p>
+     */
+    private Map<String, String> parameters = new HashMap<String, String>();
 
     /**
@@ -71 +80 @@
      * </p>
      */
-    protected List<IReplayable> replay = new LinkedList<IReplayable>();
+    private List<IReplayable> replay = new LinkedList<IReplayable>();
 
     /**
@@ -235 +244 @@
     /**
      * <p>
-     * Adds a {@link List}ist of {@link IReplayable} to the replay sequence.
+     * Adds a {@link List} of {@link IReplayable} to the replay sequence.
      * </p>
      * 
@@ -249 +258 @@
         replay.addAll(generatedReplaySeq);
     }
+    
+    /**
+     * <p>
+     * Adds a parameter to the event or sets it to a new value. The key must not be null. If a
+     * parameter with the specified key already exists, its value is replaced with the new one.
+     * If the value is null, the parameter with the specified key is removed, if it exists.
+     * </p>
+     * 
+     * @param key   the key of the parameter
+     * @param value the value of the parameter
+     * 
+     * @throws IllegalArgumentException
+     *             if the provided key is null
+     */
+    public void setParameter(String key, String value) {
+        if (key == null) {
+            throw new IllegalArgumentException("key must not be null");
+        }
+        
+        if (value == null) {
+            parameters.remove(key);
+        }
+        else {
+            parameters.put(key, value);
+        }
+    }
+
+    /**
+     * <p>
+     * Returns the event parameter with the specified key if it exists or null if not. The key
+     * must not be null.
+     * </p>
+     * 
+     * @param key the key of the parameter to be returned
+     * 
+     * @return the value of the parameter with the specified key or null if there is no parameter
+     *         with that key
+     * 
+     * @throws IllegalArgumentException
+     *             if the provided key is null
+     */
+    public String getParameter(String key) {
+        if (key == null) {
+            throw new IllegalArgumentException("key must not be null");
+        }
+        
+        return parameters.get(key);
+    }
 
     /**

trunk/autoquest-core-events/src/main/java/de/ugoe/cs/autoquest/eventcore/gui/MouseClickCondenser.java

@@ -29 +29 @@
  * provided sequence and identifies any match of the named event sequence pattern. This match is
  * condensed to the mouse click event.
- * </p>
- * <p>
- * This class does not create events of proper type if the events are not of type {@link Event}
- * but derived from it.
  * </p>
  * TODO correctly identify drag and drop