Changeset 837 for trunk/quest-plugin-mfc/src/main/java/de/ugoe/cs/quest/plugin/mfc/guimodel/MFCGUIElementSpec.java

Timestamp:

09/20/12 12:03:03 (12 years ago)

Author:

sherbold

Message:

• code documentation and clean-up

File:

• trunk/quest-plugin-mfc/src/main/java/de/ugoe/cs/quest/plugin/mfc/guimodel/MFCGUIElementSpec.java (modified) (16 diffs)

trunk/quest-plugin-mfc/src/main/java/de/ugoe/cs/quest/plugin/mfc/guimodel/MFCGUIElementSpec.java

@@ +1 @@
+
 package de.ugoe.cs.quest.plugin.mfc.guimodel;
 
@@ -99 +100 @@
      *            modality of the window
      */
-    protected MFCGUIElementSpec(long    hwnd,
-                                String  name,
-                                int     resourceId,
-                                String  type,
-                                boolean isModal)
+    protected MFCGUIElementSpec(long hwnd, String name, int resourceId, String type, boolean isModal)
     {
         this.hwnd = hwnd;
@@ -121 +118 @@
     public String getName() {
         StringBuffer names = new StringBuffer();
-        
+
         if (name != null) {
             names.append('"');
@@ -130 +127 @@
             names.append("NOT_SET");
         }
-        
+
         if (formerNames.size() > 0) {
-            
+
             names.append(" (aka ");
-            
+
             for (int i = 0; i < formerNames.size(); i++) {
                 if (i > 0) {
@@ -144 +141 @@
                 names.append('"');
             }
-            
+
             names.append(")");
         }
-        
+
         return names.toString();
     }
@@ -173 +170 @@
     }
 
-    /* (non-Javadoc)
+    /*
+     * (non-Javadoc)
+     * 
      * @see de.ugoe.cs.quest.eventcore.guimodel.IGUIElementSpec#getType()
      */
@@ -183 +182 @@
     /**
      * <p>
-     * TODO: comment
-     * </p>
-     *
-     * @return
+     * Returns the modality of the specified GUI element.
+     * </p>
+     * 
+     * @return the modality
      */
     public boolean isModal() {
@@ -201 +200 @@
      */
     public void setName(String newName) {
-        if ((this.name != null) &&
-            (!this.name.equals(newName)) &&
+        if ((this.name != null) && (!this.name.equals(newName)) &&
             (!this.formerNames.contains(this.name)))
         {
             this.formerNames.add(this.name);
         }
-        
+
         this.name = newName;
     }
@@ -223 +221 @@
             this.formerHwnds.add(this.hwnd);
         }
-        
+
         this.hwnd = newHwnd;
     }
 
-    /* (non-Javadoc)
-     * @see de.ugoe.cs.quest.eventcore.guimodel.IGUIElementSpec#getSimilarity(de.ugoe.cs.quest.eventcore.guimodel.IGUIElementSpec)
+    /*
+     * (non-Javadoc)
+     * 
+     * @see
+     * de.ugoe.cs.quest.eventcore.guimodel.IGUIElementSpec#getSimilarity(de.ugoe.cs.quest.eventcore
+     * .guimodel.IGUIElementSpec)
      */
     @Override
     public boolean getSimilarity(IGUIElementSpec other) {
-        
+
         if (this == other) {
             return true;
         }
-        
+
         if (!(other instanceof MFCGUIElementSpec)) {
             return false;
         }
-        
+
         MFCGUIElementSpec otherSpec = (MFCGUIElementSpec) other;
 
@@ -260 +262 @@
         // and reopend, i.e. a new instance is created. If one of them stays the same, then
         // similarity is given. Therefore these are the first two comparisons
-        
+
         if (hwnd == otherSpec.hwnd) {
             return true;
         }
-        
+
         if ((name != null) && (name.equals(otherSpec.name))) {
             return true;
         }
-        
-        if ((((name == null) && (otherSpec.name == null)) ||
-             (("".equals(name)) && ("".equals(otherSpec.name)))) &&
-            (formerNames.size() == 0) && (otherSpec.formerNames.size() == 0))
+
+        if ((((name == null) && (otherSpec.name == null)) || (("".equals(name)) && (""
+            .equals(otherSpec.name)))) &&
+            (formerNames.size() == 0) &&
+            (otherSpec.formerNames.size() == 0))
         {
             return true;
         }
-        
+
         // if the hwnd and the name did not stay the same, then the name should be checked first.
         // The current name of one of the specs must be contained in the former names of the
@@ -291 +294 @@
             return true;
         }
-        
+
         // ok. Even the names do not match. This is usually a clear indication, that the elements
         // are distinct. However, we check, if the former handles matched. This is very unlikely
@@ -302 +305 @@
 
         // now we can be really sure, that the GUI elements differ
-        
+
         return false;
     }
 
-    /* (non-Javadoc)
+    /*
+     * (non-Javadoc)
+     * 
      * @see de.ugoe.cs.quest.eventcore.guimodel.IGUIElementSpec#equals(IGUIElementSpec)
      */
     @Override
     public boolean equals(Object other) {
-        
+
         if (this == other) {
             return true;
         }
-        
+
         if (!(other instanceof MFCGUIElementSpec)) {
             return false;
         }
-        
+
         MFCGUIElementSpec otherSpec = (MFCGUIElementSpec) other;
-        
-        return
-            (hwnd == otherSpec.hwnd) && (isModal == otherSpec.isModal) &&
+
+        return (hwnd == otherSpec.hwnd) && (isModal == otherSpec.isModal) &&
             (resourceId == otherSpec.resourceId) &&
             ((type == otherSpec.type) || ((type != null) && (type.equals(otherSpec.type)))) &&
@@ -329 +333 @@
     }
 
-    /* (non-Javadoc)
+    /*
+     * (non-Javadoc)
+     * 
      * @see java.lang.Object#hashCode()
      */
@@ -340 +346 @@
     /**
      * <p>
-     * Returns a string identfier of the window:<br>
+     * Returns a string identifier of the window:<br>
      * {@code [resourceId;"windowName";"className";modality]}
      * </p>
@@ -348 +354 @@
     @Override
     public String toString() {
-        return "[" + resourceId + ";" + getName() + ";\"" + type + "\";" + isModal + ";" +
-            hwnd + "]";
-    }
-
-    /**
-     * <p>
-     * TODO: comment
-     * </p>
+        return "[" + resourceId + ";" + getName() + ";\"" + type + "\";" + isModal + ";" + hwnd +
+            "]";
+    }
+
+    /**
+     * <p>
+     * Returns the XML representation of this specification.
+     * </p>
+     * 
+     * @return the XML representation
      */
     String toXML() {
-        return
-            "<window name=\"" + (name != null ? StringTools.xmlEntityReplacement(name) : "") +
-            "\" class=\"" + StringTools.xmlEntityReplacement(type) +
-            "\" resourceId=\"" + resourceId + "\" isModal=\"" +
-            isModal + "\"/>";
-    }
-
-    /**
-     * <p>
-     * TODO: comment
-     * </p>
-     *
+        return "<window name=\"" + (name != null ? StringTools.xmlEntityReplacement(name) : "") +
+            "\" class=\"" + StringTools.xmlEntityReplacement(type) + "\" resourceId=\"" +
+            resourceId + "\" isModal=\"" + isModal + "\"/>";
+    }
+
+    /**
+     * <p>
+     * Updates the specification with another specification.
+     * </p>
+     * 
      * @param furtherSpec
+     *            specification used to update the current specification
      */
     void update(IGUIElementSpec furtherSpec) {
         MFCGUIElementSpec other = (MFCGUIElementSpec) furtherSpec;
-        
+
         if (other != this) {
             for (long formerHwnd : other.formerHwnds) {
@@ -388 +395 @@
             }
 
-            if ((name != other.name) && (name != null) && (!name.equals(other.name)))
-            {
+            if ((name != other.name) && (name != null) && (!name.equals(other.name))) {
                 setName(other.name);
             }