Ignore:
Timestamp:
09/28/11 11:54:32 (13 years ago)
Author:
jhall
Message:

Added comments and renamed some parameters.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/EventBenchCore/src/de/ugoe/cs/eventbench/assertions/FileEqualsReplay.java

    r150 r217  
    44import de.ugoe.cs.util.StringTools; 
    55 
     6/** 
     7 * <p> 
     8 * This class defines the fileEquals assertion type. This type does have two 
     9 * parameters, actualFile and expectedFile. 
     10 * </p> 
     11 *  
     12 * @author jeffrey.hall 
     13 * @version 1.0 
     14 *  
     15 */ 
    616public class FileEqualsReplay implements IReplayable { 
    717 
     18        /** 
     19         * The file that should be equal to expectedFile. 
     20         */ 
    821        String actualFile = null; 
     22 
     23        /** 
     24         * The file that is used as the reference. 
     25         */ 
    926        String expectedFile = null; 
     27 
    1028        /** 
    1129         * Id for object serialization. 
     
    1331        private static final long serialVersionUID = 1L; 
    1432 
    15         public void setActualFile(String s) { 
    16                 actualFile = s; 
     33        /** 
     34         *  
     35         * @param actualFile 
     36         *            The file that should be equal to expectedFile. 
     37         */ 
     38        public void setActualFile(String actualFile) { 
     39                this.actualFile = actualFile; 
    1740        } 
    1841 
    19         public void setExpectedFile(String s) { 
    20                 expectedFile = s; 
     42        /** 
     43         * @param exptectedFile 
     44         *            The file that is used as the reference. 
     45         */ 
     46        public void setExpectedFile(String expectedFile) { 
     47                this.expectedFile = expectedFile; 
    2148        } 
    2249 
     50        /** 
     51         * Returns the string that has to be written to the replay file. 
     52         */ 
    2353        public String getReplay() { 
    2454 
     
    3464        } 
    3565 
     66        /** 
     67         * No target used by fileEquals. 
     68         */ 
    3669        public String getTarget() { 
    3770                return "targetNotUsed"; 
Note: See TracChangeset for help on using the changeset viewer.