Changeset 1217 for trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityResult.java

Timestamp:

06/06/13 17:08:25 (11 years ago)

Author:

adeicke

Message:

• Added proper formating and JavaDoc?.
• Several renaming refactorings.

File:

• trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityResult.java (modified) (2 diffs)

trunk/autoquest-core-usability-evaluation/src/main/java/de/ugoe/cs/autoquest/usability/rules/UsabilityResult.java

@@ -18 +18 @@
 import com.google.common.collect.Multimap;
 
-import de.ugoe.cs.autoquest.usability.result.UsabilityDefect;
-import de.ugoe.cs.autoquest.usability.result.UsabilityDefectSeverityLevel;
-
+import de.ugoe.cs.autoquest.usability.result.UsabilityProblemDescription;
+import de.ugoe.cs.autoquest.usability.result.UsabilityProblemSeverityLevel;
 
 /**
  * <p>
- * TODO comment
+ * The result of the usability evaluation, which contains all detected problems.
  * </p>
  * 
@@ -30 +29 @@
  */
 public class UsabilityResult {
-    
-    private Multimap<UsabilityDefectSeverityLevel, UsabilityDefect> detectedDefects;
-    
+
+    /**
+     * <p>
+     * All detected problems and their appropriate severity level.
+     * </p>
+     */
+    private Multimap<UsabilityProblemSeverityLevel, UsabilityProblemDescription> detectedProblems;
+
+    /**
+     * 
+     * <p>
+     * Constructor. Creates a new result.
+     * </p>
+     * 
+     */
     public UsabilityResult() {
-        this.detectedDefects = ArrayListMultimap.create();
+        this.detectedProblems = ArrayListMultimap.create();
     }
 
     /**
      * <p>
-     * TODO: comment
+     * Adds a usability problem to the result.
      * </p>
-     *
-     * @param usabilityDefect
+     * 
+     * @param usabilityProblem
+     *            the problem, which should be added.
      */
-    public void addDefect(UsabilityDefect usabilityDefect) {
-        this.detectedDefects.put(usabilityDefect.getSeverityLevel(), usabilityDefect);
+    public void addProblem(UsabilityProblemDescription usabilityProblem) {
+        this.detectedProblems.put(usabilityProblem.getSeverityLevel(), usabilityProblem);
     }
-    
-    public boolean hasDefects() {
-        return !this.detectedDefects.isEmpty();
+
+    /**
+     * 
+     * <p>
+     * Checks, if problems were found during the usability evaluation.
+     * </p>
+     * 
+     * @return true, iff problems were found
+     */
+    public boolean hasDetectedProblems() {
+        return !this.detectedProblems.isEmpty();
     }