Ignore:
Timestamp:
09/12/12 10:57:15 (12 years ago)
Author:
pharms
Message:
  • added some java doc for the classes, which are expected to be quite final
File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/quest-core-tasktrees/src/main/java/de/ugoe/cs/quest/tasktrees/temporalrelation/RuleApplicationResult.java

    r655 r809  
    77 
    88/** 
    9  * TODO comment 
     9 * <p> 
     10 * The rule application result describes the result of applying a {@link TemporalRelationshipRule} 
     11 * on a task tree node. It contains a {@link RuleApplicationStatus} and a list of all parent 
     12 * task tree nodes that were created during a rule application. See the description of 
     13 * {@link TemporalRelationshipRule} for more details. 
     14 * </p> 
    1015 *  
    11  * @version $Revision: $ $Date: 18.03.2012$ 
    12  * @author 2012, last modified by $Author: patrick$ 
     16 * @author Patrick Harms 
    1317 */ 
    14 public class RuleApplicationResult { 
     18class RuleApplicationResult { 
    1519 
    1620    /** */ 
    … …  
    2125 
    2226    /** 
    23      * TODO: comment 
    24      *  
    25      * @param b 
     27     * <p> 
     28     * create a rule application result with a status {@link RuleApplicationStatus#RULE_NOT_APPLIED} 
     29     * </p> 
    2630     */ 
    27     public RuleApplicationResult() { 
     31    RuleApplicationResult() { 
    2832        // this is the default indicating nothing so far 
    2933    } 
    3034 
    3135    /** 
    32      * TODO: comment 
    33      *  
    34      * @param b 
     36     * <p> 
     37     * set the rule application status 
     38     * </p> 
    3539     */ 
    36     public void setRuleApplicationStatus(RuleApplicationStatus status) { 
     40    void setRuleApplicationStatus(RuleApplicationStatus status) { 
    3741        this.status = status; 
    3842    } 
    3943 
    4044    /** 
    41      * TODO: comment 
    42      *  
    43      * @return 
     45     * <p> 
     46     * return the rule application status 
     47     * </p> 
    4448     */ 
    45     public RuleApplicationStatus getRuleApplicationStatus() { 
     49    RuleApplicationStatus getRuleApplicationStatus() { 
    4650        return status; 
    4751    } 
    4852 
    4953    /** 
    50      * TODO: comment 
    51      *  
    52      * @param sequence 
     54     * <p> 
     55     * add a further parent node created during the rule application 
     56     * </p> 
    5357     */ 
    54     public void addNewlyCreatedParentNode(ITaskTreeNode newParent) { 
     58    void addNewlyCreatedParentNode(ITaskTreeNode newParent) { 
    5559        newParents.add(newParent); 
    5660    } 
    5761 
    5862    /** 
    59      * TODO: comment 
    60      *  
    61      * @return 
     63     * <p> 
     64     * return all parent nodes created during the rule application 
     65     * </p> 
    6266     */ 
    63     public List<ITaskTreeNode> getNewlyCreatedParentNodes() { 
     67    List<ITaskTreeNode> getNewlyCreatedParentNodes() { 
    6468        return newParents; 
    6569    } 
Note: See TracChangeset for help on using the changeset viewer.