Changeset 996 for trunk/autoquest-core-events/src/main/java/de/ugoe/cs/autoquest/eventcore/Event.java

Timestamp:

11/16/12 13:51:11 (12 years ago)

Author:

pharms

Message:

• added support for storing timestamps with events

File:

• trunk/autoquest-core-events/src/main/java/de/ugoe/cs/autoquest/eventcore/Event.java (modified) (4 diffs)

trunk/autoquest-core-events/src/main/java/de/ugoe/cs/autoquest/eventcore/Event.java

@@ -24 +24 @@
  * <p>
  * Base class for all events. An event is described by its {@link #type} and its {@link #target}.
+ * An event may be provided with a timestamp and further parameters.
  * </p>
  * 
@@ -62 +63 @@
 
     /**
-     * </p> Target of the event.
+     * <p>
+     * Target of the event.
+     * </p>
      */
     private IEventTarget target = null;
+    
+    /**
+     * <p>
+     * Timestamp of when the event took place.
+     * </p>
+     */
+    private long timestamp = Long.MIN_VALUE;
     
     /**
@@ -114 +124 @@
     /**
      * <p>
-     * Two events are equal, if their {@link #type} and {@link #target} are equal.
+     * Two events are equal, if their {@link #type} and {@link #target} are equal. The timestamp
+     * and other parameters are ignored.
      * </p>
      * <p>
@@ -309 +320 @@
     /**
      * <p>
+     * Sets the timestamp of the event, i.e. when the event occurred. A timestamp for events is
+     * optional. Therefore it is also ignored by the {@link #equals(Object)}-method. A timestamp
+     * with a value smaller 0 means, that now timestamp for the event exists.
+     * </p>
+     * 
+     * @param timestamp the new value for the timestamp
+     */
+    public void setTimestamp(long timestamp) {
+        this.timestamp = timestamp;
+    }
+
+    /**
+     * <p>
+     * Returns the timestamp of the event or a value lower than 0 if no timestamp for the event
+     * exists.
+     * </p>
+     * 
+     * @return the timestamp of the event or a value lower than 0 if no timestamp exists
+     */
+    public long getTimestamp() {
+        return timestamp;
+    }
+
+    /**
+     * <p>
      * Returns a the list of replay events.
      * </p>