Changeset 2218 for trunk/autoquest-core-events/src/main/java/de/ugoe/cs/autoquest/eventcore/HierarchicalEventTargetTree.java

Timestamp:

11/29/17 14:55:48 (7 years ago)

Author:

pharms

Message:

• java doc issues removal

File:

• trunk/autoquest-core-events/src/main/java/de/ugoe/cs/autoquest/eventcore/HierarchicalEventTargetTree.java (modified) (11 diffs)

trunk/autoquest-core-events/src/main/java/de/ugoe/cs/autoquest/eventcore/HierarchicalEventTargetTree.java

@@ -25 +25 @@
 /**
  * <p>
- * This class provides the interfaces for GUI element trees.
+ * This class provides the interfaces for hierarchical event target trees.
  * </p>
  * <p>
- * The GUIElementTree represents the hierarchical structure of the GUI elements "as it is"
- * currently during a session. It may change during the session due to creation and destruction
- * of GUI elements. The parameter T represents the id type of the GUI elements that are handled
- * internally.
+ * The HierarchicalEventTargetTree represents the hierarchical structure of the event targets
+ * "as it is" currently during a session. It may change during the session due to creation and
+ * destruction of event targets. The parameter ID represents the id type of the event targets
+ * that are handled internally. The other type parameters specify the concrete target type.
  * </p>
  * 
@@ -44 +44 @@
     /**
      * <p>
-     * Map of all GUI elements that are part of the tree for efficient searching. The keys of the
-     * map are the ids of the GUI elements.
+     * Map of all event targets that are part of the tree for efficient searching. The keys of the
+     * map are the ids of the event targets.
      * </p>
      */
@@ -52 +52 @@
     /**
      * <p>
-     * Map of all GUI element specifications that are part of the tree for efficient searching. The
-     * keys of the map are the ids of the GUI elements.
+     * Map of all event target specifications that are part of the tree for efficient searching. The
+     * keys of the map are the ids of the event targets.
      * </p>
      */
@@ -60 +60 @@
     /**
      * <p>
-     * Map of all children of GUI elements that are part of the tree. The keys of the map are the
-     * ids of the parent GUI elements.
+     * Map of all children of event targets that are part of the tree. The keys of the map are the
+     * ids of the parent event targets.
      * </p>
      */
@@ -68 +68 @@
     /**
      * <p>
-     * Map of all parents of GUI elements that are part of the tree. The keys of the map are the
-     * ids of the child GUI elements.
+     * Map of all parents of event targets that are part of the tree. The keys of the map are the
+     * ids of the child event targets.
      * </p>
      */
@@ -83 +83 @@
     /**
      * <p>
-     * the GUI element factory used in the model
+     * the event target factory used in the model
      * </p>
      */
@@ -106 +106 @@
     /**
      * <p>
-     * Adds a new GUI element to the tree.
+     * Adds a new event target to the tree.
      * </p>
      * 
      * @param eventTargetID
-     *            id of the GUI element to be created
+     *            id of the event target to be created
      * @param parentID
-     *            id of the parent GUI element 
+     *            id of the parent event target 
      * @param eventTargetSpec
-     *            the GUI element specification
+     *            the event target specification
      *            
-     * @throws EventTargetModelException if the GUI element can not be added to the underlying GUI model
+     * @throws EventTargetModelException if the event target can not be added to the underlying GUI model
      */
     public void add(ID               eventTargetID,
@@ -159 +159 @@
     /**
      * <p>
-     * Searches the tree for a GUI element with the specified id and returns its
+     * Searches the tree for a event target with the specified id and returns its
      * {@link IGUIElement} .
      * </p>
@@ -165 +165 @@
      * @param id
      *            id that is looked for
-     * @return {@link IGUIElementSpec} of the GUI element with the given id if found, null otherwise
+     * @return {@link IEventTargetSpec} of the event target with the given id if found, null otherwise
      */
     public TARGET_TYPE find(ID id) {
@@ -173 +173 @@
     /**
      * <p>
-     * Returns the id of the provided {@link IGUIElement}. The comparison is performed using the
-     * equals method of the GUI element.
+     * Returns the id of the provided {@link IHierachicalEventTarget}. The comparison is performed using the
+     * equals method of the event target.
      * </p>
      * 
      * @param eventTarget
      *            guiElement that is looked for
-     * @return the id of the GUI element, null if the GUI element can not be found
+     * @return the id of the event target, null if the event target can not be found
      */
     public ID find(TARGET_TYPE eventTarget) {
@@ -193 +193 @@
     /**
      * <p>
-     * Removes a GUI element (defined by its id) from the tree. All children of the GUI element will be
+     * Removes a event target (defined by its id) from the tree. All children of the event target will be
      * removed recursively.
      * </p>
      * 
      * @param id
-     *            id of the GUI element to be removed
-     * @return number of GUI elements that were removed
+     *            id of the event target to be removed
+     * @return number of event targets that were removed
      */
     public int remove(ID id) {