Changeset 171 for trunk/EventBenchConsole/src/de/ugoe/cs/eventbench/ReplayGenerator.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/ReplayGenerator.java (modified) (4 diffs)

trunk/EventBenchConsole/src/de/ugoe/cs/eventbench/ReplayGenerator.java

@@ -12 +12 @@
 import de.ugoe.cs.util.console.Console;
 
+/**
+ * <p>
+ * This class provides the functionality to generate replay files from sequences
+ * if {@link ReplayableEvent}s.
+ * </p>
+ * 
+ * @author Steffen Herbold
+ * @version 1.0
+ */
 public class ReplayGenerator {
-        
+
+        /**
+         * <p>
+         * {@link IReplayDecorator} to be used. If this field is {@code null}, no
+         * decorator is used. Default: {@code null}
+         * </p>
+         */
         private IReplayDecorator decorator = null;
-        
+
+        /**
+         * <p>
+         * Id of the current session. The starting id is 1.
+         * </p>
+         */
         int sessionId = 1;
-        
-        public void createLogfileMultipleSessions(List<List<ReplayableEvent<?>>> sequences, String filename) {
+
+        /**
+         * <p>
+         * Creates a replay file that contains multiple event sequences.
+         * </p>
+         * 
+         * @param sequences
+         *            collection of event sequences from which the sessions are
+         *            generated
+         * @param filename
+         *            name and path of the replay file
+         */
+        public void createLogfileMultipleSessions(
+                        List<List<ReplayableEvent<?>>> sequences, String filename) {
                 OutputStreamWriter writer = openReplayFile(filename);
-                if( writer!=null ) {            
+                if (writer != null) {
                         try {
                                 decorator = sequences.get(0).get(0).getReplayDecorator();
-                                if( decorator!=null ) {
+                                if (decorator != null) {
                                         writer.write(decorator.getHeader());
                                 }
-                                for( List<ReplayableEvent<?>> actions : sequences ) {
+                                for (List<ReplayableEvent<?>> actions : sequences) {
                                         writeSession(actions, writer);
                                 }
-                                if( decorator!=null ) {
-                                        writer.write(decorator.getFooter());
-                                }
-                                decorator = null;
-                                writer.close();
-                        } catch (IOException e) {
-                                Console.printerrln("Unable to write replay file " + filename);
-                        }
-                }
-        }
-        
-        public void createLogfileSingleSession(List<ReplayableEvent<?>> actions, String filename) {
-                OutputStreamWriter writer = openReplayFile(filename);
-                if( writer!=null ) {            
-                        try {
-                                actions.get(0).getReplayDecorator();
-                                if( decorator!=null ) {
-                                        writer.write(decorator.getHeader());
-                                }
-                                writeSession(actions, writer);
-                                if( decorator!=null ) {
+                                if (decorator != null) {
                                         writer.write(decorator.getFooter());
                                 }
@@ -60 +72 @@
         }
 
+        /**
+         * <p>
+         * Creates a replay file that from a single event sequence.
+         * </p>
+         * 
+         * @param actions
+         *            event sequence from which the sessions are generated
+         * @param filename
+         *            name and path of the replay file
+         */
+        public void createLogfileSingleSession(List<ReplayableEvent<?>> actions,
+                        String filename) {
+                OutputStreamWriter writer = openReplayFile(filename);
+                if (writer != null) {
+                        try {
+                                actions.get(0).getReplayDecorator();
+                                if (decorator != null) {
+                                        writer.write(decorator.getHeader());
+                                }
+                                writeSession(actions, writer);
+                                if (decorator != null) {
+                                        writer.write(decorator.getFooter());
+                                }
+                                decorator = null;
+                                writer.close();
+                        } catch (IOException e) {
+                                Console.printerrln("Unable to write replay file " + filename);
+                        }
+                }
+        }
+
+        /**
+         * <p>
+         * Helper function that opens the replay file for writing.
+         * </p>
+         * 
+         * @param filename
+         *            name and path of the replay file
+         * @return {@link OutputStreamWriter} that writes to the replay file
+         */
         private OutputStreamWriter openReplayFile(String filename) {
                 File file = new File(filename);
@@ -65 +117 @@
                 try {
                         fileCreated = file.createNewFile();
-                        if( !fileCreated ) {
+                        if (!fileCreated) {
                                 Console.traceln("Created logfile " + filename);
                         } else {
@@ -76 +128 @@
                 OutputStreamWriter writer = null;
                 try {
-                        writer = new OutputStreamWriter(new FileOutputStream(file), "UTF-16");
+                        writer = new OutputStreamWriter(new FileOutputStream(file),
+                                        "UTF-16");
                 } catch (IOException e) {
-                        Console.printerrln("Unable to open file for writing (read-only file):" + filename);
+                        Console.printerrln("Unable to open file for writing (read-only file):"
+                                        + filename);
                         Console.printStacktrace(e);
                 }
                 return writer;
         }
-        
-        private void writeSession(List<ReplayableEvent<?>> actions, OutputStreamWriter writer)
-                        throws IOException {
-                if( decorator!=null ) {
+
+        /**
+         * <p>
+         * Helper function that adds an event sequence to the replay.
+         * </p>
+         * 
+         * @param actions
+         *            event sequences to be added
+         * @param writer
+         *            {@link OutputStreamWriter} to which the replay is added
+         * @throws IOException
+         *             thrown if there is a problem writing to writer
+         */
+        private void writeSession(List<ReplayableEvent<?>> actions,
+                        OutputStreamWriter writer) throws IOException {
+                if (decorator != null) {
                         writer.write(decorator.getSessionHeader(sessionId));
                 }
-                for( ReplayableEvent<?> currentAction : actions ) {
-                        
-                        List<? extends IReplayable> replayables = currentAction.getReplayMessages();
-                        for( IReplayable replayble : replayables ) {
-                                writer.write(replayble.getReplay()+StringTools.ENDLINE);
+                for (ReplayableEvent<?> currentAction : actions) {
+
+                        List<? extends IReplayable> replayables = currentAction
+                                        .getReplayMessages();
+                        for (IReplayable replayble : replayables) {
+                                writer.write(replayble.getReplay() + StringTools.ENDLINE);
                                 writer.flush();
                         }
                 }
-                if( decorator!=null ) {
+                if (decorator != null) {
                         writer.write(decorator.getSessionFooter(sessionId));
                 }