Changeset 217 for trunk/EventBenchCore/src/de

Timestamp:

09/28/11 11:54:32 (13 years ago)

Author:

jhall

Message:

Added comments and renamed some parameters.

File:

• trunk/EventBenchCore/src/de/ugoe/cs/eventbench/assertions/FileEqualsReplay.java (modified) (3 diffs)

trunk/EventBenchCore/src/de/ugoe/cs/eventbench/assertions/FileEqualsReplay.java

@@ -4 +4 @@
 import de.ugoe.cs.util.StringTools;
 
+/**
+ * <p>
+ * This class defines the fileEquals assertion type. This type does have two
+ * parameters, actualFile and expectedFile.
+ * </p>
+ * 
+ * @author jeffrey.hall
+ * @version 1.0
+ * 
+ */
 public class FileEqualsReplay implements IReplayable {
 
+        /**
+         * The file that should be equal to expectedFile.
+         */
         String actualFile = null;
+
+        /**
+         * The file that is used as the reference.
+         */
         String expectedFile = null;
+
         /**
          * Id for object serialization.
@@ -13 +31 @@
         private static final long serialVersionUID = 1L;
 
-        public void setActualFile(String s) {
-                actualFile = s;
+        /**
+         * 
+         * @param actualFile
+         *            The file that should be equal to expectedFile.
+         */
+        public void setActualFile(String actualFile) {
+                this.actualFile = actualFile;
         }
 
-        public void setExpectedFile(String s) {
-                expectedFile = s;
+        /**
+         * @param exptectedFile
+         *            The file that is used as the reference.
+         */
+        public void setExpectedFile(String expectedFile) {
+                this.expectedFile = expectedFile;
         }
 
+        /**
+         * Returns the string that has to be written to the replay file.
+         */
         public String getReplay() {
 
@@ -34 +64 @@
         }
 
+        /**
+         * No target used by fileEquals.
+         */
         public String getTarget() {
                 return "targetNotUsed";