Changeset 1154 for trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/SelectionComparisonRule.java

Timestamp:

04/19/13 17:02:50 (11 years ago)

Author:

pharms

Message:

• improved java doc

File:

• trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/SelectionComparisonRule.java (modified) (5 diffs)

trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/SelectionComparisonRule.java

@@ -29 +29 @@
  * equal, then the selections are syntactically equal. If all children are at least semantically
  * equal, then the selections are semantically equal. If only one of the selections has children,
- * then the selections are unequal.
+ * then the selections are unequal. The comparison is broken up, if only a specific equality is
+ * checked for and this equality is ensured.
  * </p>
  * 
@@ -97 +98 @@
 
     /**
-     * 
+     * <p>
+     * compares two selections with each other checking for the provided required level of
+     * equality. If this level is ensured, the method immediately returns. The more concrete
+     * the required equality level, the more checks this method performs.
+     * </p>
+     * 
+     * @param task1                 the first task to be compared
+     * @param task2                 the second task to be compared
+     * @param requiredEqualityLevel the equality level to be checked for
+     * 
+     * @return the determined equality.
      */
     private TaskEquality getEquality(ITask task1, ITask task2, TaskEquality requiredEqualityLevel) {
@@ -141 +152 @@
     /**
      * <p>
-     * TODO: comment
+     * determines the common equality level for all tasks in the first list compared to all
+     * tasks in the second list. If for one task in the first list, there is no equal task in the
+     * second list, the method return unequality. 
      * </p>
      *
-     * @param children1
-     * @param children2
-     * @param requiredEqualityLevel
+     * @param children1 the first list to be compared
+     * @param children2 the second list to be compared
+     * 
+     * @return the common task equality identified for all tasks in the first list with respect to
+     *         the second list
      */
     private TaskEquality getCommonEqualityLevel(List<ITask> children1, List<ITask> children2) {
@@ -188 +203 @@
     /**
      * <p>
-     * TODO: comment
-     * </p>
-     *
-     * @param children1
-     * @param children2
-     * @param requiredEqualityLevel
+     * ensures for the two given lists, that for each task in the first list there is a task
+     * in the second list being on the given level equal to the task in the first list.
+     * </p> 
+     * 
+     * @param children1             the first list to be compared
+     * @param children2             the second list to be compared
+     * @param requiredEqualityLevel the equality level to be checked for
+     * 
+     * @return true if each task in the first list has an equal task in the second list when
+     *         considering the given equality level, false else.
      */
     private boolean checkEqualityLevel(List<ITask>  children1,
@@ -227 +246 @@
     /**
      * <p>
-     * TODO: comment
-     * </p>
-     *
-     * @param child1
-     * @param child2
-     * @param requiredEqualityLevel
-     * @return
+     * used to to call the task equality rule manager for the comparison of the two provided
+     * children. If no required equality level is provided, than the most concrete equality is
+     * returned. Otherwise, the required equality is returned as long as the children are equal
+     * on that level.
+     * </p> 
+     * 
+     * @param child1                the first task to be compared
+     * @param child2                the second task to be compared
+     * @param requiredEqualityLevel the equality level to be checked for
+     * 
+     * @return the determined equality
      */
     private TaskEquality callRuleManager(ITask        child1,