Ignore:
Timestamp:
05/27/13 15:24:09 (12 years ago)
Author:
pharms
Message:
  • improved java doc
Location:
trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl
Files:
8 edited

Legend:

Unmodified
Added
Removed

  • trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/EventTask.java

    r1157 r1215  
    2121 
    2222/** 
    23  * TODO comment 
    24  *  
    25  * @version $Revision: $ $Date: $ 
    26  * @author 2011, last modified by $Author: $ 
     23 * <p> 
     24 * this is the default implementation of the interface {@link IEventTask}. It does not do anything 
     25 * fancy except implementing the interface. 
     26 * </p>  
     27 * 
     28 * @author Patrick Harms 
    2729 */ 
    2830class EventTask extends Task implements IEventTask { 
    2931     
    30     /**  */ 
     32    /** 
     33     * <p> 
     34     * default serial version UID 
     35     * </p> 
     36     */ 
    3137    private static final long serialVersionUID = 1L; 
    3238 
    33     /** */ 
     39    /** 
     40     * <p> 
     41     * the type of the represented event 
     42     * </p>  
     43     */ 
    3444    private IEventType eventType; 
    3545 
    36     /** */ 
     46    /** 
     47     * <p> 
     48     * the target of the represented event 
     49     * </p>  
     50     */ 
    3751    private IEventTarget eventTarget; 
    3852 
    3953    /** 
    40      * @param eventType 
    41      * @param eventTarget 
     54     * <p> 
     55     * simple constructor initializing this task with an event type and an event target 
     56     * </p> 
     57     *  
     58     * @param eventType   the type of the represented event 
     59     * @param eventTarget the target of the represented event 
    4260     */ 
    4361    EventTask(IEventType eventType, IEventTarget eventTarget) { 
    … …  
    4765    } 
    4866 
    49     /** 
    50      * @return Returns the interaction. 
     67    /* (non-Javadoc) 
     68     * @see de.ugoe.cs.autoquest.tasktrees.treeifc.IEventTask#getEventType() 
    5169     */ 
     70    @Override 
    5271    public IEventType getEventType() { 
    5372        return eventType; 
    5473    } 
    5574 
    56     /** 
    57      * @return Returns the GUIElement. 
     75    /* (non-Javadoc) 
     76     * @see de.ugoe.cs.autoquest.tasktrees.treeifc.IEventTask#getEventTarget() 
    5877     */ 
     78    @Override 
    5979    public IEventTarget getEventTarget() { 
    6080        return eventTarget; 
    6181    } 
    6282 
    63     /* 
    64      * (non-Javadoc) 
    65      *  
    66      * @see de.harms.tasktrees.TreeNode#clone() 
     83    /* (non-Javadoc) 
     84     * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.Task#clone() 
    6785     */ 
    6886    @Override 
    … …  
    7391 
    7492    /* (non-Javadoc) 
    75      * @see de.ugoe.cs.autoquest.tasktrees.treeifc.IEventTask#accept(de.ugoe.cs.autoquest.tasktrees.treeifc.TaskVisitor) 
     93     * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.Task#accept(ITaskVisitor) 
    7694     */ 
    7795    @Override 

  • trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/Iteration.java

    r1157 r1215  
    1818import de.ugoe.cs.autoquest.tasktrees.treeifc.IOptional; 
    1919import de.ugoe.cs.autoquest.tasktrees.treeifc.ITask; 
    20 import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskVisitor; 
    2120 
    2221/** 
    23  * TODO comment 
    24  *  
    25  * @version $Revision: $ $Date: 19.02.2012$ 
    26  * @author 2012, last modified by $Author: patrick$ 
     22 * <p> 
     23 * this is the default implementation of the interface {@link IIteration}. It does not do anything 
     24 * fancy except implementing the interface. 
     25 * </p>  
     26 * 
     27 * @author Patrick Harms 
    2728 */ 
    2829class Iteration extends MarkingTemporalRelationship implements IIteration { 
    2930 
    30     /**  */ 
     31    /** 
     32     * <p> 
     33     * default serial version UID 
     34     * </p> 
     35     */ 
    3136    private static final long serialVersionUID = 1L; 
    3237 
    3338    /** 
    34      * 
     39     * <p> 
     40     * simple constructor providing the base class with a human readable name of the type of this 
     41     * task 
     42     * </p> 
    3543     */ 
    3644    Iteration() { 
    … …  
    3947 
    4048    /* (non-Javadoc) 
    41      * @see MarkingTemporalRelationship#setMarkedTask(ITask) 
     49     * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.MarkingTemporalRelationship#setMarkedTask(ITask) 
    4250     */ 
    4351    @Override 
    … …  
    5563    } 
    5664 
    57     /* 
    58      * (non-Javadoc) 
    59      *  
    60      * @see java.lang.Object#clone() 
     65    /* (non-Javadoc) 
     66     * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.MarkingTemporalRelationship#clone() 
    6167     */ 
    6268    @Override 
    … …  
    6571    } 
    6672     
    67     /* (non-Javadoc) 
    68      * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.TaskTreeNode#accept(de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor) 
    69      */ 
    70     @Override 
    71     public void accept(ITaskVisitor visitor) { 
    72         visitor.visit(this); 
    73     } 
    74  
    7573} 

  • trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/MarkingTemporalRelationship.java

    r1146 r1215  
    2020/** 
    2121 * <p> 
    22  * TODO comment 
     22 * this is the default implementation of the interface {@link IMarkingTemporalRelationship}. It 
     23 * does not do anything fancy except implementing the interface. 
    2324 * </p> 
    2425 *  
    … …  
    2930{ 
    3031 
    31     /**  */ 
     32    /** 
     33     * <p> 
     34     * default serial version UID 
     35     * </p> 
     36     */ 
    3237    private static final long serialVersionUID = 1L; 
    3338 
    3439    /** 
    35      *  
     40     * <p> 
     41     * the task marked through this marking temporal relationship 
     42     * </p> 
    3643     */ 
    3744    private ITask markedTask; 
    3845     
    3946    /** 
    40      *  
     47     * <p> 
     48     * a human readable name for this temporal relationship 
     49     * </p> 
    4150     */ 
    4251    private String relationshipType; 
    … …  
    4453    /** 
    4554     * <p> 
    46      * TODO: comment 
     55     * initializes this temporal relationship with a human readable name 
    4756     * </p> 
    4857     * 
    49      * @param description 
     58     * @param relationshipType the human readable name of this temporal relationship 
    5059     */ 
    5160    MarkingTemporalRelationship(String relationshipType) { 
    … …  
    8392 
    8493    /** 
    85      * @param markedTask the markedTask to set 
     94     * <p> 
     95     * used to set the marked task 
     96     * </p> 
     97     *  
     98     * @param markedTask the marked task to set 
    8699     */ 
    87100    protected void setMarkedTask(ITask markedTask) { 

  • trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/Optional.java

    r1157 r1215  
    1717import de.ugoe.cs.autoquest.tasktrees.treeifc.IOptional; 
    1818import de.ugoe.cs.autoquest.tasktrees.treeifc.ITask; 
    19 import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskVisitor; 
    2019 
    2120/** 
    22  * TODO comment 
    23  *  
    24  * @version $Revision: $ $Date: 19.02.2012$ 
    25  * @author 2012, last modified by $Author: patrick$ 
     21 * <p> 
     22 * this is the default implementation of the interface {@link IOptional}. It does not do anything 
     23 * fancy except implementing the interface. 
     24 * </p>  
     25 * 
     26 * @author Patrick Harms 
    2627 */ 
    2728class Optional extends MarkingTemporalRelationship implements IOptional { 
    2829 
    29     /**  */ 
     30    /** 
     31     * <p> 
     32     * default serial version UID 
     33     * </p> 
     34     */ 
    3035    private static final long serialVersionUID = 1L; 
    3136 
    3237    /** 
    33      * 
     38     * <p> 
     39     * simple constructor providing the base class with a human readable name of the type of this 
     40     * task 
     41     * </p> 
    3442     */ 
    3543    Optional() { 
    … …  
    3846     
    3947    /* (non-Javadoc) 
    40      * @see MarkingTemporalRelationship#setMarkedTask(ITask) 
     48     * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.MarkingTemporalRelationship#setMarkedTask(ITask) 
    4149     */ 
    4250    @Override 
    … …  
    5058    } 
    5159 
    52     /* 
    53      * (non-Javadoc) 
    54      *  
    55      * @see java.lang.Object#clone() 
     60    /* (non-Javadoc) 
     61     * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.MarkingTemporalRelationship#clone() 
    5662     */ 
    5763    @Override 
    … …  
    6066    } 
    6167 
    62     /* (non-Javadoc) 
    63      * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITemporalRelationship#accept(de.ugoe.cs.autoquest.tasktrees.treeifc.TaskVisitor) 
    64      */ 
    65     @Override 
    66     public void accept(ITaskVisitor visitor) { 
    67         // TODO Auto-generated method stub 
    68         System.out.println("TODO: implement ITemporalRelationship.accept "); 
    69          
    70     } 
    7168} 

  • trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/Selection.java

    r1157 r1215  
    1717import de.ugoe.cs.autoquest.tasktrees.treeifc.ISelection; 
    1818import de.ugoe.cs.autoquest.tasktrees.treeifc.ITask; 
    19 import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskVisitor; 
    2019 
    2120/** 
    22  * TODO comment 
    23  *  
    24  * @version $Revision: $ $Date: 19.02.2012$ 
    25  * @author 2012, last modified by $Author: patrick$ 
     21 * <p> 
     22 * this is the default implementation of the interface {@link ISelection}. It does not do anything 
     23 * fancy except implementing the interface. 
     24 * </p>  
     25 * 
     26 * @author Patrick Harms 
    2627 */ 
    2728class Selection extends StructuringTemporalRelationship implements ISelection { 
    2829 
    29     /**  */ 
     30    /** 
     31     * <p> 
     32     * default serial version UID 
     33     * </p> 
     34     */ 
    3035    private static final long serialVersionUID = 1L; 
    3136 
    3237    /** 
    33      * TODO: comment 
    34      *  
    35      * @param name 
     38     * <p> 
     39     * simple constructor providing the base class with a human readable name of the type of this 
     40     * task 
     41     * </p> 
    3642     */ 
    3743    Selection() { 
    … …  
    3945    } 
    4046 
    41     /* 
    42      * (non-Javadoc) 
    43      *  
    44      * @see java.lang.Object#clone() 
     47    /* (non-Javadoc) 
     48     * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.StructuringTemporalRelationship#clone() 
    4549     */ 
    4650    @Override 
    … …  
    4953    } 
    5054 
    51     /** 
    52      * <p> 
    53      * TODO: comment 
    54      * </p> 
    55      * 
    56      * @param i 
    57      * @param newChild 
     55    /* (non-Javadoc) 
     56     * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.StructuringTemporalRelationship#addChild(ITask) 
    5857     */ 
    59     public void addChild(ITask newChild) { 
     58    @Override 
     59    void addChild(ITask newChild) { 
    6060        super.addChild(newChild); 
    6161        super.setDescription("selection of " + newChild); 
    6262    } 
    6363 
    64     /** 
    65      * <p> 
    66      * TODO: comment 
    67      * </p> 
    68      * 
    69      * @param i 
    70      * @param newChild 
     64    /* (non-Javadoc) 
     65     * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.StructuringTemporalRelationship#addChild(int,ITask) 
    7166     */ 
    72     public void addChild(int index, ITask newChild) { 
     67    @Override 
     68    void addChild(int index, ITask newChild) { 
    7369        super.addChild(index, newChild); 
    7470        super.setDescription("selection of " + newChild); 
    7571    } 
    7672 
    77     /* (non-Javadoc) 
    78      * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITemporalRelationship#accept(de.ugoe.cs.autoquest.tasktrees.treeifc.TaskVisitor) 
    79      */ 
    80     @Override 
    81     public void accept(ITaskVisitor visitor) { 
    82         visitor.visit(this); 
    83     } 
    84  
    8573} 

  • trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/Sequence.java

    r1157 r1215  
    1616 
    1717import de.ugoe.cs.autoquest.tasktrees.treeifc.ISequence; 
    18 import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskVisitor; 
    1918 
    2019/** 
    21  * TODO comment 
    22  *  
    23  * @version $Revision: $ $Date: 19.02.2012$ 
    24  * @author 2012, last modified by $Author: patrick$ 
     20 * <p> 
     21 * this is the default implementation of the interface {@link ISequence}. It does not do anything 
     22 * fancy except implementing the interface. 
     23 * </p>  
     24 * 
     25 * @author Patrick Harms 
    2526 */ 
    2627class Sequence extends StructuringTemporalRelationship implements ISequence { 
    2728     
    28     /**  */ 
     29    /** 
     30     * <p> 
     31     * default serial version UID 
     32     * </p> 
     33     */ 
    2934    private static final long serialVersionUID = 1L; 
    3035 
    3136    /** 
    32      * TODO: comment 
    33      *  
    34      * @param name 
     37     * <p> 
     38     * simple constructor providing the base class with a human readable name of the type of this 
     39     * task 
     40     * </p> 
    3541     */ 
    3642    Sequence() { 
    … …  
    3844    } 
    3945 
    40     /* 
    41      * (non-Javadoc) 
    42      *  
    43      * @see de.ugoe.cs.tasktree.treeimpl.TaskTreeNodeImpl#clone() 
     46    /* (non-Javadoc) 
     47     * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.StructuringTemporalRelationship#clone() 
    4448     */ 
    4549    @Override 
    … …  
    4852    } 
    4953     
    50     /* (non-Javadoc) 
    51      * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.TaskTreeNode#accept(de.ugoe.cs.autoquest.tasktrees.treeifc.NodeVisitor) 
    52      */ 
    53     @Override 
    54     public void accept(ITaskVisitor visitor) { 
    55         visitor.visit(this); 
    56     } 
    57  
    5854} 

  • trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/StructuringTemporalRelationship.java

    r1146 r1215  
    2323/** 
    2424 * <p> 
    25  * TODO comment 
     25 * this is the default implementation of the interface {@link IStructuringTemporalRelationship}. It 
     26 * does not do anything fancy except implementing the interface. 
    2627 * </p> 
    2728 *  
    … …  
    3233{ 
    3334 
    34     /**  */ 
     35    /** 
     36     * <p> 
     37     * default serial version UID 
     38     * </p> 
     39     */ 
    3540    private static final long serialVersionUID = 1L; 
    3641     
    3742    /** 
    38      *  
     43     * <p> 
     44     * the list of children of this temporal relationship 
     45     * </p> 
    3946     */ 
    4047    private List<ITask> children = new LinkedList<ITask>(); 
    … …  
    4249    /** 
    4350     * <p> 
    44      * TODO: comment 
     51     * initializes this temporal relationship with a human readable name 
    4552     * </p> 
    4653     * 
    47      * @param description 
     54     * @param relationshipType the human readable name of this temporal relationship 
    4855     */ 
    4956    StructuringTemporalRelationship(String relationshipType) { 
    … …  
    8390    /** 
    8491     * <p> 
    85      * TODO: comment 
     92     * used to add a new child to this temporal relationship. 
    8693     * </p> 
    8794     * 
    88      * @param i 
    89      * @param newChild 
     95     * @param newChild the new child to be added 
    9096     */ 
    91     public void addChild(ITask newChild) { 
     97    void addChild(ITask newChild) { 
    9298        children.add(newChild); 
    9399    } 
    … …  
    95101    /** 
    96102     * <p> 
    97      * TODO: comment 
     103     * used to add a new child to this temporal relationship at a specific position. 
    98104     * </p> 
    99105     * 
    100      * @param i 
    101      * @param newChild 
     106     * @param index    the index of the new child to be added. 
     107     * @param newChild the new child to be added 
    102108     */ 
    103     public void addChild(int index, ITask newChild) { 
     109    void addChild(int index, ITask newChild) { 
    104110        children.add(index, newChild); 
    105111    } 
    … …  
    107113    /** 
    108114     * <p> 
    109      * TODO: comment 
     115     * removes a child from this temporal relationship at a specific position. 
    110116     * </p> 
    111117     * 
    112      * @param index 
     118     * @param index the index of the child to be removed. 
    113119     */ 
    114120    void removeChild(int index) { 

  • trunk/autoquest-core-tasktrees/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/Task.java

    r1157 r1215  
    1919 
    2020/** 
    21  * TODO comment 
     21 * <p> 
     22 * this is the default implementation of the interface {@link ITask}. It 
     23 * does not do anything fancy except implementing the interface. 
     24 * </p> 
    2225 *  
    23  * @version $Revision: $ $Date: $ 
    24  * @author 2011, last modified by $Author: $ 
     26 * @author Patrick Harms 
    2527 */ 
    2628class Task implements ITask { 
    2729 
    28     /**  */ 
     30    /** 
     31     * <p> 
     32     * default serial version UID 
     33     * </p> 
     34     */ 
    2935    private static final long serialVersionUID = 1L; 
    3036 
    31     /** */ 
     37    /** 
     38     * <p> 
     39     * used as a counter to generate new ids for each newly created task. May overflow. 
     40     * </p> 
     41     */ 
    3242    private static int temporalId = 0; 
    3343 
    34     /** */ 
     44    /** 
     45     * <p> 
     46     * the id of the task (unique throughout the system as long as {@link #temporalId} does not 
     47     * overflow. 
     48     * </p> 
     49     */ 
    3550    private int id; 
    3651 
    37     /** */ 
     52    /** 
     53     * <p> 
     54     * a human readable description of the task 
     55     * </p> 
     56     */ 
    3857    private String description; 
    3958 
    4059    /** 
    41      *  
     60     * <p> 
     61     * constructs a new task with a new id. The id is generated using the {@link #getNewId()} 
     62     * methdod 
     63     * </p> 
    4264     */ 
    4365    Task() { 
    … …  
    4668 
    4769    /** 
    48      * TODO: comment 
     70     * <p> 
     71     * creates a new id for a task using {@link #temporalId} by incrementing it an returning its 
     72     * current value. Resets the counter if {@link Integer.MAX_VALUE} is reached. 
     73     * </p> 
    4974     *  
    50      * @return 
     75     * @return a new unique id for a task as long as {@link #temporalId} does not overflow 
    5176     */ 
    5277    private static synchronized int getNewId() { 
    … …  
    5883    } 
    5984 
    60     /** 
    61      * @return Returns the name. 
     85    /* (non-Javadoc) 
     86     * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#geId() 
    6287     */ 
     88    @Override 
    6389    public int getId() { 
    6490        return id; 
    6591    } 
    6692 
    67     /* 
    68      * (non-Javadoc) 
    69      *  
    70      * @see de.ugoe.cs.tasktree.treeifc.TaskTreeNode#getDescription() 
     93    /* (non-Javadoc) 
     94     * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#getDescription() 
    7195     */ 
    7296    @Override 
    … …  
    7599    } 
    76100 
    77     /* 
    78      * (non-Javadoc) 
    79      *  
    80      * @see de.ugoe.cs.autoquest.tasktrees.treeifc.TaskTreeNode#equals(TaskTreeNode) 
     101    /* (non-Javadoc) 
     102     * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#equals(ITask) 
    81103     */ 
    82104    @Override 
    … …  
    87109    } 
    88110 
    89     /* 
    90      * (non-Javadoc) 
    91      *  
    92      * @see java.lang.Object#hashCode() 
     111    /* (non-Javadoc) 
     112     * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#hashCode() 
    93113     */ 
    94114    @Override 
    … …  
    97117    } 
    98118 
    99     /* 
    100      * (non-Javadoc) 
    101      *  
     119    /* (non-Javadoc) 
    102120     * @see java.lang.Object#toString() 
    103121     */ 
    … …  
    117135    } 
    118136 
    119     /* 
    120      * (non-Javadoc) 
    121      *  
    122      * @see java.lang.Object#clone() 
     137    /* (non-Javadoc) 
     138     * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#clone() 
    123139     */ 
    124140    @Override 
    … …  
    137153 
    138154    /** 
    139      * TODO: comment 
     155     * <p> 
     156     * internally used to set the human readable description of the task 
     157     * </p> 
    140158     *  
    141      * @param i 
    142      * @return 
     159     * @param description the new human readable description of the task 
    143160     */ 
    144161    void setDescription(String description) { 
    … …  
    147164 
    148165    /* (non-Javadoc) 
    149      * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#accept(de.ugoe.cs.autoquest.tasktrees.treeifc.TaskVisitor) 
     166     * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#accept(ITaskVisitor) 
    150167     */ 
    151168    @Override 
Note: See TracChangeset for help on using the changeset viewer.