Changeset 171 for trunk/EventBenchConsole/src/de/ugoe/cs/eventbench/web/data/WebEvent.java

Timestamp:

09/09/11 06:23:36 (13 years ago)

Author:

sherbold

Message:

• code documentation and formatting

File:

• trunk/EventBenchConsole/src/de/ugoe/cs/eventbench/web/data/WebEvent.java (modified) (2 diffs)

trunk/EventBenchConsole/src/de/ugoe/cs/eventbench/web/data/WebEvent.java

@@ -5 +5 @@
 import de.ugoe.cs.eventbench.data.ReplayableEvent;
 
+/**
+ * <p>
+ * This class defines web events (of PHP-based web applications).
+ * </p>
+ * 
+ * @author Steffen Herbold
+ * @version 1.0
+ * 
+ */
 public class WebEvent extends ReplayableEvent<WebRequest> {
 
@@ -13 +22 @@
          */
         private static final long serialVersionUID = 1L;
-        
+
+        /**
+         * Timestamp of the event.
+         */
         private final long timestamp;
-                
-        
-        private final static String makeType(String path, List<String> postVars, List<String> getVars) {
+
+        /**
+         * <p>
+         * Helper method that generates the type of the event based on the of the
+         * URI, the POST variables, and the GET variables.
+         * </p>
+         * 
+         * @param path
+         *            path of the URI of the event
+         * @param postVars
+         *            POST variables send with the event
+         * @param getVars
+         *            GET variables send with the event
+         * @return type of the event
+         */
+        private final static String makeType(String path, List<String> postVars,
+                        List<String> getVars) {
                 String type = path;
-                if( getVars!=null && !getVars.isEmpty() ) {
-                        type += "+GET"+getVars.toString().replace(" ", "");
+                if (getVars != null && !getVars.isEmpty()) {
+                        type += "+GET" + getVars.toString().replace(" ", "");
                 }
-                if( postVars!=null && !postVars.isEmpty() ) {
-                        type += "+POST"+postVars.toString().replace(" ", "");
+                if (postVars != null && !postVars.isEmpty()) {
+                        type += "+POST" + postVars.toString().replace(" ", "");
                 }
                 return type;
         }
-        
-        public WebEvent(String path, long timestamp, List<String> postVars, List<String> getVars) {
+
+        /**
+         * <p>
+         * Constructor. Creates a new WebEvent.
+         * </p>
+         * 
+         * @param path
+         *            path of the URI
+         * @param timestamp
+         *            timestamp of when the event took place
+         * @param postVars
+         *            POST variables send with the event
+         * @param getVars
+         *            GET variables send with the event
+         */
+        public WebEvent(String path, long timestamp, List<String> postVars,
+                        List<String> getVars) {
                 super(makeType(path, postVars, getVars));
                 this.timestamp = timestamp;
                 addReplayEvent(new WebRequest(path, postVars, getVars));
         }
-        
+
+        /**
+         * <p>
+         * Returns the timestamp of the event.
+         * </p>
+         * 
+         * @return timestamp of th event
+         */
         public long getTimestamp() {
                 return timestamp;