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

Timestamp:

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

Author:

sherbold

Message:

• code documentation and formatting

Location:

trunk/EventBenchConsole/src/de/ugoe/cs/eventbench/web/data

Files:

• WebEvent.java (modified) (2 diffs)
• WebRequest.java (modified) (5 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;

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

@@ -6 +6 @@
 import de.ugoe.cs.eventbench.data.IReplayable;
 
+/**
+ * <p>
+ * Contains all information related to a web request, i.e., the path, the POST
+ * variables and the GET variables.
+ * </p>
+ * 
+ * @author Steffen Herbold
+ * @version 1.0
+ */
 public class WebRequest implements IReplayable {
 
         /**
+         * <p>
          * Id for object serialization.
+         * </p>
          */
         private static final long serialVersionUID = 1L;
 
+        /**
+         * <p>
+         * POST variables of the web request.
+         * </p>
+         */
         List<String> postVars;
+
+        /**
+         * <p>
+         * GET variables of the web request.
+         * </p>
+         */
         List<String> getVars;
-        
+
+        /**
+         * <p>
+         * URI of the web request.
+         * </p>
+         */
         String targetUri;
-        
+
+        /**
+         * <p>
+         * Constructor. Creates a new WebRequest.
+         * </p>
+         * 
+         * @param uri
+         *            URI of the request
+         * @param postVars
+         *            POST variables of the request
+         * @param getVars
+         *            GET variables of the request
+         */
         public WebRequest(String uri, List<String> postVars, List<String> getVars) {
                 targetUri = uri;
@@ -23 +62 @@
                 this.getVars = new ArrayList<String>(getVars);
         }
-        
+
+        /*
+         * (non-Javadoc)
+         * 
+         * @see de.ugoe.cs.eventbench.data.IReplayable#getReplay()
+         */
         @Override
         public String getReplay() {
@@ -30 +74 @@
         }
 
+        /*
+         * (non-Javadoc)
+         * 
+         * @see de.ugoe.cs.eventbench.data.IReplayable#getTarget()
+         */
         @Override
         public String getTarget() {
@@ -35 +84 @@
                 return null;
         }
-        
+
+        /**
+         * <p>
+         * Two {@link WebRequest}s are equal, if their {@link #targetUri},
+         * {@link #postVars}, and {@link #getVars} are equal.
+         * </p>
+         * 
+         * @see java.lang.Object#equals(java.lang.Object)
+         */
         @Override
         public boolean equals(Object other) {
-                if( this==other ) {
+                if (this == other) {
                         return true;
                 }
-                if( other instanceof WebRequest ) {
-                        return targetUri.equals(((WebRequest) other).targetUri) && postVars.equals(((WebRequest) other).postVars);
+                if (other instanceof WebRequest) {
+                        return targetUri.equals(((WebRequest) other).targetUri)
+                                        && postVars.equals(((WebRequest) other).postVars)
+                                        && getVars.equals(((WebRequest) other).getVars);
                 }
                 return false;
         }
-        
+
+        /*
+         * (non-Javadoc)
+         * 
+         * @see java.lang.Object#hashCode()
+         */
         @Override
         public int hashCode() {
@@ -54 +118 @@
                 hash = multiplier * hash + targetUri.hashCode();
                 hash = multiplier * hash + postVars.hashCode();
+                hash = multiplier * hash + getVars.hashCode();
 
                 return hash;