Changeset 837 for trunk/quest-plugin-mfc/src/main/java/de/ugoe/cs/quest/plugin/mfc/EventGenerator.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/EventGenerator.java (modified) (7 diffs)

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

@@ -32 +32 @@
  * <p>
  * Translates sequences of windows messages into {@link WindowsEvent}s that can be used by the
- * EventBench core libraries.
+ * QUEST core libraries.
  * </p>
  * 
- * @author Steffen Herbold
  * @version 1.0
+ * @author Steffen Herbold, Patrick Harms
  */
 public class EventGenerator {
@@ -220 +220 @@
     /**
      * <p>
-     * TODO: comment
+     * Evaluates whether the current message sequence matches a given rule.
      * </p>
      *
-     * @param currentRule
+     * @param currentRule rule that is matched
+     * @return true if the message sequence matches the rule; false otherwise
      */
     private boolean evaluateMessageConditions(EventGenerationRule currentRule) {
@@ -742 +743 @@
     /**
      * <p>
-     * TODO: comment
+     * Resolves the parameters described by {@link Term}s.
      * </p>
      *
-     * @param eventParameters
-     * @return
+     * @param eventParameters terms whose parameters are resolved
+     * @return resolved parameters
      */
     private Map<String, String> resolveParameters(List<Term> eventParameters) {
@@ -947 +948 @@
     /**
      * <p>
-     * convenience method for {@link #getTermValueAsList(WindowsMessage, Term)} with current
+     * Convenience method for {@link #getTermValueAsList(WindowsMessage, Term)} with current
      * message is null.
      * </p>
@@ -996 +997 @@
     /**
      * <p>
-     * TODO: comment
+     * Resolves term values.
      * </p>
      *
-     * @param value
-     * @param expectedType
-     * @return
+     * @param value value to be resolved
+     * @param expectedType class defining the expected type
+     * @return resolved value
      */
     @SuppressWarnings("unchecked")
@@ -1076 +1077 @@
     /**
      * <p>
-     * TODO: comment
+     * Parses the rules.
      * </p>
      *
@@ -1091 +1092 @@
         catch (JDOMException e) {
             Console.printerrln("Invalid rules file.");
-            // TODO handle Exception
-            e.printStackTrace();
+            Console.logException(e);
             return;
         }
         catch (IOException e) {
             Console.printerrln("Invalid rules file.");
-            // TODO handle Exception
-            e.printStackTrace();
+            Console.logException(e);
             return;
         }