Changeset 79 for trunk/EventBenchCore/src/de/ugoe/cs/eventbench/data/IReplayable.java

Timestamp:

06/21/11 11:25:45 (13 years ago)

Author:

sherbold

Message:

• documentation

File:

• trunk/EventBenchCore/src/de/ugoe/cs/eventbench/data/IReplayable.java (modified) (1 diff)

trunk/EventBenchCore/src/de/ugoe/cs/eventbench/data/IReplayable.java

@@ -1 +1 @@
 package de.ugoe.cs.eventbench.data;
 
+/**
+ * <p>
+ * This interface is used by {@link ReplayableEvent}to describe how events can
+ * be replayed. It can be used to define a sequence of fine-grained platform
+ * events that make up an abstract event.
+ * </p>
+ * 
+ * @author Steffen Herbold
+ * @version 1.0
+ */
 public interface IReplayable {
-        
+
+        /**
+         * <p>
+         * Returns a string to be written to the replay script that describes the
+         * replayable platform event.
+         * </p>
+         * 
+         * @return string for the replay script
+         */
         String getReplayXml();
-        
+
+        /**
+         * <p>
+         * Returns the target of the replayable.
+         * </p>
+         * 
+         * @return target of the replayable
+         */
         String getTarget();
 }