Changeset 786 for trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/MouseClickCondenser.java

Timestamp:

09/06/12 16:47:00 (12 years ago)

Author:

sherbold

Message:

• code documentation

File:

• trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/gui/MouseClickCondenser.java (modified) (4 diffs)

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

@@ -1 @@
-// Module    : $RCSfile: MouseClickCondenser.java,v $
-// Version   : $Revision: 0.0 $  $Author: pharms $  $Date: 31.08.2012 $
-// Project   : quest-core-events
-// Creation  : 2012 by pharms
-// Copyright : Patrick Harms, 2012
+
 package de.ugoe.cs.quest.eventcore.gui;
 
@@ -14 +10 @@
 /**
  * <p>
- * This class condenses mouse clicks, i.e. it reduces a sequence of mouse button down,
- * mouse button up and mouse click with the same button on the same event target to a single
- * mouse click with that button on that target. The mouse button down and mouse button up events
- * are discarded. For this, it iterates the provided sequence and identifies any match of the named
- * event sequence pattern. This match is condensed to the mouse click event.
+ * This class condenses mouse clicks, i.e. it reduces a sequence of mouse button down, mouse button
+ * up and mouse click with the same button on the same event target to a single mouse click with
+ * that button on that target. The mouse button down and mouse button up events are discarded. For
+ * this, it iterates the provided sequence and identifies any match of the named event sequence
+ * pattern. This match is condensed to the mouse click event.
  * </p>
  * 
- * @version $Revision: $ $Date: 31.08.2012$
- * @author 2012, last modified by $Author: pharms$
+ * @version 1.0
+ * @author Patrick Harms
  */
 public class MouseClickCondenser {
@@ -29 +25 @@
      * <p>
      * This method performs the work described in the description of the class. A new list is
-     * instantiated and returned. This list is filled with the events provided by the sequence
-     * being the parameter of the method except for mouse button down and mouse button up events
-     * which are followed by a mouse click event with the same button on the same target.
+     * instantiated and returned. This list is filled with the events provided by the sequence being
+     * the parameter of the method except for mouse button down and mouse button up events which are
+     * followed by a mouse click event with the same button on the same target.
      * </p>
      * 
-     * @param sequence the event sequence to condense the mouse clicks in
+     * @param sequence
+     *            the event sequence to condense the mouse clicks in
      * 
      * @return the resulting sequence, in which mouse clicks are condensed to single mouse click
@@ -41 +38 @@
     public List<Event> condenseMouseClicks(List<Event> sequence) {
         List<Event> resultingSequence = new LinkedList<Event>();
-        
+
         int index = 0;
         while (index < sequence.size()) // -2 because we don't need to go to the end