Ignore:
Timestamp:
04/19/13 17:02:50 (11 years ago)
Author:
pharms
Message:
  • improved java doc
File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r1146 r1154  
    2323 * <p> 
    2424 * The task equality rule manager is capable of comparing tasks based on its internal list 
    25  * of comparison rules. The current list of rules contains the {@link TaskIdentityRule}, the 
    26  * {@link IterationComparisonRule}, the {@link SequenceComparisonRule}, and 
    27  * {@link SelectionComparisonRule}. These rules are asked for comparing the two provided tasks 
    28  * in the mentioned order. If a rule returns a task equality other than null, this equality is 
    29  * returned. Otherwise the next rule is asked. 
     25 * of comparison rules. These rules are asked for comparing the two provided tasks. If a rule 
     26 * returns a task equality other than null, this equality is returned. Otherwise the next rule 
     27 * is asked. 
    3028 * </p> 
    3129 *  
    … …  
    3533public class TaskEqualityRuleManager { 
    3634 
    37     /** */ 
     35    /** 
     36     * <p> 
     37     * the rules that can be used for comparing tasks 
     38     * </p> 
     39     */ 
    3840    private List<TaskComparisonRule> mRuleIndex = null; 
    3941 
    … …  
    99101    /** 
    100102     * <p> 
    101      * TODO: comment 
    102      * </p> 
    103      * 
    104      * @param child1 
    105      * @param child2 
    106      * @param equalityLevel 
    107      * @return 
     103     * this method two tasks with respect to the fiven equality level and returns true, if this 
     104     * level is given. 
     105     * </p> 
     106     *  
     107     * @param task1         the first task to be compared 
     108     * @param task2         the second task to be compared 
     109     * @param equalityLevel the level of equality to be checked for 
     110     *  
     111     * @return as described 
     112     *  
     113     * @throws IllegalStateException in the case, the {@link #init()} method was not called on the 
     114     *                               manager before a call to this method. 
    108115     */ 
    109116    public boolean areAtLeastEqual(ITask task1, ITask task2, TaskEquality equalityLevel) { 
    … …  
    130137    /** 
    131138     * <p> 
    132      * TODO: comment 
    133      * </p> 
    134      * 
    135      * @param child1 
    136      * @param child2 
    137      * @return 
     139     * this method checks if the two given tasks are identical. For this, it iterates its internal 
     140     * comparison rules. If the first rule returns true, than this method returns true as well. 
     141     * If no rule returns true, this method returns false. 
     142     * </p> 
     143     *  
     144     * @param task1 the first task to be compared 
     145     * @param task2 the second task to be compared 
     146     *  
     147     * @return as described 
     148     *  
     149     * @throws IllegalStateException in the case, the {@link #init()} method was not called on the 
     150     *                               manager before a call to this method. 
    138151     */ 
    139152    public boolean areIdentical(ITask task1, ITask task2) { 
    … …  
    153166    /** 
    154167     * <p> 
    155      * TODO: comment 
    156      * </p> 
    157      * 
    158      * @param child1 
    159      * @param child2 
    160      * @return 
     168     * this method checks if the two given tasks are lexically equal. For this, it iterates its 
     169     * internal comparison rules. If the first rule returns true, than this method returns true 
     170     * as well. If no rule returns true, this method returns false. 
     171     * </p> 
     172     *  
     173     * @param task1 the first task to be compared 
     174     * @param task2 the second task to be compared 
     175     *  
     176     * @return as described 
     177     *  
     178     * @throws IllegalStateException in the case, the {@link #init()} method was not called on the 
     179     *                               manager before a call to this method. 
    161180     */ 
    162181    public boolean areLexicallyEqual(ITask task1, ITask task2) { 
    … …  
    176195    /** 
    177196     * <p> 
    178      * TODO: comment 
    179      * </p> 
    180      * 
    181      * @param child1 
    182      * @param child2 
    183      * @return 
     197     * this method checks if the two given tasks are syntactically equal. For this, it iterates its 
     198     * internal comparison rules. If the first rule returns true, than this method returns true 
     199     * as well. If no rule returns true, this method returns false. 
     200     * </p> 
     201     *  
     202     * @param task1 the first task to be compared 
     203     * @param task2 the second task to be compared 
     204     *  
     205     * @return as described 
     206     *  
     207     * @throws IllegalStateException in the case, the {@link #init()} method was not called on the 
     208     *                               manager before a call to this method. 
    184209     */ 
    185210    public boolean areSyntacticallyEqual(ITask task1, ITask task2) { 
    … …  
    199224    /** 
    200225     * <p> 
    201      * TODO: comment 
    202      * </p> 
    203      * 
    204      * @param child1 
    205      * @param child2 
    206      * @return 
     226     * this method checks if the two given tasks are semantically equal. For this, it iterates its 
     227     * internal comparison rules. If the first rule returns true, than this method returns true 
     228     * as well. If no rule returns true, this method returns false. 
     229     * </p> 
     230     *  
     231     * @param task1 the first task to be compared 
     232     * @param task2 the second task to be compared 
     233     *  
     234     * @return as described 
     235     *  
     236     * @throws IllegalStateException in the case, the {@link #init()} method was not called on the 
     237     *                               manager before a call to this method. 
    207238     */ 
    208239    public boolean areSemanticallyEqual(ITask task1, ITask task2) { 
Note: See TracChangeset for help on using the changeset viewer.