Changeset 557 for trunk/quest-core-tasktrees/src/main/java/de/ugoe/cs/quest/tasktrees/nodeequality/NodeComparisonRule.java

Timestamp:

08/17/12 08:33:29 (12 years ago)

Author:

pharms

Message:

• adapted task tree creation stuff to more general event handling

File:

• trunk/quest-core-tasktrees/src/main/java/de/ugoe/cs/quest/tasktrees/nodeequality/NodeComparisonRule.java (modified) (2 diffs)

trunk/quest-core-tasktrees/src/main/java/de/ugoe/cs/quest/tasktrees/nodeequality/NodeComparisonRule.java

@@ -1 @@
-//-------------------------------------------------------------------------------------------------
 // Module    : $RCSfile: EqualityRule.java,v $
 // Version   : $Revision: 0.0 $  $Author: patrick $  $Date: 19.02.2012 $
@@ -5 +4 @@
 // Creation  : 2012 by patrick
 // Copyright : Patrick Harms, 2012
-//-------------------------------------------------------------------------------------------------
+
 package de.ugoe.cs.quest.tasktrees.nodeequality;
 
-import de.ugoe.cs.quest.tasktrees.treeifc.TaskTreeNode;
+import de.ugoe.cs.quest.tasktrees.treeifc.ITaskTreeNode;
 
-//-------------------------------------------------------------------------------------------------
 /**
- * TODO comment
+ * <p>
+ * A node comparison rule is used by the {@link NodeEqualityRuleManager} to compare task tree
+ * nodes with each other. It provides one method to be called for a comparison.
+ * </p>
  * 
  * @version $Revision: $ $Date: 19.02.2012$
  * @author 2012, last modified by $Author: patrick$
  */
-//-------------------------------------------------------------------------------------------------
-public interface NodeComparisonRule
-{
+public interface NodeComparisonRule {
 
-  //-----------------------------------------------------------------------------------------------
-  /**
-   * compares two nodes with each other. The result of the method is either a node equality or
-   * null. If it is null, it means, that the rule is not able to correctly compare the two
-   * given nodes
-   */
-  //-----------------------------------------------------------------------------------------------
-  public NodeEquality compare(TaskTreeNode node1, TaskTreeNode node2);
-  
+    /**
+     * <p>
+     * compares two nodes with each other. The result of the method is either a node equality or
+     * null. If it is null, it means, that the rule is not able to correctly compare the two given
+     * nodes
+     * </p>
+     * 
+     * @param node1 the first task tree node to compare
+     * @param node2 the second task tree node to compare
+     * 
+     * @return as described
+     */
+    public NodeEquality compare(ITaskTreeNode node1, ITaskTreeNode node2);
+
 }