Ignore:
Timestamp:
09/28/11 11:55:30 (13 years ago)
Author:
jhall
Message:

Added comments and renamed some variables.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/EventBenchCore/src/de/ugoe/cs/eventbench/assertions/TextEqualsReplay.java

    r150 r218  
    44import de.ugoe.cs.util.StringTools; 
    55 
     6/** 
     7 * <p> 
     8 * This class defines the textEquals assertion type. This type does have two 
     9 * parameters, expectedValue and target. 
     10 * </p> 
     11 *  
     12 * @author jeffrey.hall 
     13 * @version 1.0 
     14 *  
     15 */ 
    616public class TextEqualsReplay implements IReplayable { 
    717 
     18        /** 
     19         * The reference value which is compared to the targets text. 
     20         */ 
    821        private String expectedValue = null; 
     22 
     23        /** 
     24         * The window which text is compared to expectedValue. 
     25         */ 
    926        private String target = null; 
     27 
    1028        /** 
    1129         * Id for object serialization. 
    … …  
    1331        private static final long serialVersionUID = 1L; 
    1432 
    15         public void setExpectedValue(String s) { 
    16                 expectedValue = s; 
     33        /** 
     34         * @param expectedValue 
     35         *            The reference value which is compared to the targets text. 
     36         */ 
     37        public void setExpectedValue(String expectedValue) { 
     38                this.expectedValue = expectedValue; 
    1739        } 
    1840 
    19         public void setTarget(String s) { 
    20                 target = s; 
     41        /** 
     42         * @param target 
     43         *            The window which text is compared to expectedValue. 
     44         */ 
     45        public void setTarget(String target) { 
     46                this.target = target; 
    2147        } 
    2248 
     49        /** 
     50         * Returns the string that has to be written to the replay file. 
     51         */ 
    2352        public String getReplay() { 
    2453 
    2554                expectedValue = StringTools.xmlEntityReplacement(expectedValue); 
    26                  
     55 
    2756                StringBuilder currentMsgStr = new StringBuilder(400); 
    28                 currentMsgStr.append(" <textEquals expectedValue=\"" + expectedValue + "\">"); 
     57                currentMsgStr.append(" <textEquals expectedValue=\"" + expectedValue 
     58                                + "\">"); 
    2959                currentMsgStr.append(StringTools.ENDLINE); 
    3060                currentMsgStr.append("<target>"); 
    … …  
    3969        } 
    4070 
    41  
     71        /** 
     72         * Returns the target window. 
     73         */ 
    4274        public String getTarget() { 
    4375                return target; 
Note: See TracChangeset for help on using the changeset viewer.