("START");
-
- /**
- *
- * Global end event that can be used to indicate the end of a sequence.
- */
- public static final Event ENDEVENT = new Event("END");
-
- /**
- *
- * Type of the event.
- *
- */
- protected String type;
-
- /**
- *
Target of the event.
- */
- protected String target = null;
-
- /**
- *
- * Short description of the event target.
- *
- */
- protected String targetShort = null;
-
- /**
- * Further information about the event that shall be included in its Id.
- */
- protected String idInfo = "";
-
- /**
- *
- * Constructor. Creates a new Event with a given type.
- *
- *
- * @param type
- * type of the event
- */
- public Event(String type) {
- if (type == null) {
- throw new InvalidParameterException("Event type must not be null");
- }
- this.type = type;
- }
-
- /**
- *
- * Two events are equal, if their {@link #type} and {@link #target} are
- * equal.
- *
- *
- * See {@link Object#equals(Object)} for further information.
- *
- *
- * @param other
- * Event that is compared to this
- * @return true, if events are equal, false otherwise
- */
- @Override
- public boolean equals(Object other) {
- if (this == other) {
- return true;
- }
- if (other instanceof Event) {
- Event otherEvent = (Event) other;
- if (otherEvent.canEqual(this)) {
- if (type != null) {
- return targetEquals(otherEvent.target)
- && type.equals(otherEvent.type);
- } else {
- return targetEquals(otherEvent.target)
- && otherEvent.type == null;
- }
- } else {
- return false;
- }
- } else {
- return false;
- }
- }
-
- public boolean canEqual(Object other) {
- return (other instanceof Event);
- }
-
- /**
- *
- * Returns {@link #getStandardId()} as String representation of the event.
- *
- *
- * @return String represenation of the event
- */
- @Override
- public String toString() {
- return getStandardId();
- }
-
- /**
- * Informations about the event important for its Id that is neither target
- * nor type.
- *
- * @return {@link #idInfo} of the event
- */
- public String getIdInfo() {
- return idInfo;
- }
-
- /**
- *
- * If {@link #targetShort} is set, a shortend version of the Id is returned
- * of the form {@link #targetShort}.{@link #type}.{@link #idInfo} is
- * returned. Otherwise the standard Id is returned (see
- * {@link #getStandardId()}).
- *
- *
- * @return if available, shortend Id string; {@link #getStandardId()}
- * otherwise
- */
- public String getShortId() {
- String shortId = null;
- if (targetShort != null) {
- shortId = targetShort + "." + getType();
- if (!"".equals(idInfo)) {
- shortId += "." + idInfo;
- }
- } else {
- shortId = getStandardId();
- }
- return shortId;
- }
-
- /**
- *
- * Returns the Id string of the event. It has the form {@link #target}.
- * {@link #type}.{@link #idInfo};
- *
- *
- * @return Id string of the event
- */
- public String getStandardId() {
- String id = "";
- if (target != null) {
- id += target + ".";
- }
- id += getType();
- if (!"".equals(idInfo)) {
- id += "." + idInfo;
- }
- return id;
- }
-
- /**
- *
- * Returns the {@link #target} of the event.
- *
- *
- * @return {@link #target} of the event
- */
- public String getTarget() {
- return target;
- }
-
- /**
- *
- * Returns the {@link #targetShort} of the event.
- *
- *
- * @return {@link #targetShort} of the event
- */
- protected String getTargetShort() {
- return targetShort;
- }
-
- /**
- *
- * Returns the {@link #type} of the event.
- *
- *
- * @return {@link #type} of the event
- */
- public String getType() {
- return type;
- }
-
- /*
- * (non-Javadoc)
- *
- * @see java.lang.Object#hashCode()
- */
- @Override
- public int hashCode() {
- int multiplier = 17;
- int hash = 42;
- if (type != null) {
- hash = multiplier * hash + type.hashCode();
- }
- hash = multiplier * hash + targetHashCode();
-
- return hash;
- }
-
- /**
- *
- * Sets the {@link #idInfo} of the event. The idInfo is optional and
- * contains information important for the event's Id that is neither target
- * nor type.
- *
- *
- * @param info
- * {@link #idInfo} of the event
- */
- public void setIdInfo(String info) {
- idInfo = info;
- }
-
- /**
- *
- * Sets the target of the event. Once set, the target cannot be changed.
- *
- *
- * @param target
- * target of the event
- * @return true, if target was changed, false otherwise
- */
- public boolean setTarget(String target) {
- if (this.target != null) {
- return false;
- }
- this.target = target;
- return true;
- }
-
- /**
- *
- * Sets the short description of the event target. Once set, the target
- * cannot be changed.
- *
- *
- * @param targetShort
- * short target description
- * @return true, if target was changed, false otherwise
- */
- public boolean setTargetShort(String targetShort) {
- if (this.targetShort != null) {
- return false;
- }
- this.targetShort = targetShort;
- return true;
- }
-
- /**
- *
- * This function is used by {@link #equals(Object)} to determine if the
- * targets of both events are equal. The standard implementation provided by
- * this class performs a String comparison between the target strings.
- *
- *
- * Subclasses can override this method to implemented more sophisticated
- * means for the target comparison, e.g., to account for changes in the
- * title of a widget.
- *
- *
- * @param otherTarget
- * other target string to which the target if this event is
- * compared to
- * @return true if the targets are equals; false otherwise
- */
- protected boolean targetEquals(String otherTarget) {
- boolean retVal;
- if (target != null) {
- retVal = target.equals(otherTarget);
- } else {
- retVal = (otherTarget == null);
- }
- return retVal;
- }
-
- /**
- *
- * This function is used by {@link #hashCode()} to determine how the hash of
- * the {@link #target}. It has to be overridden by subclasses that implement
- * {@link #targetEquals(String)}, to ensure that the equals/hashCode
- * contract remains valid.
- *
- *
- * @return hash of the target
- */
- protected int targetHashCode() {
- if (target != null) {
- return target.hashCode();
- } else {
- return 0;
- }
- }
+public class Event implements Serializable {
+
+ /**
+ * Id for object serialization.
+ */
+ private static final long serialVersionUID = 1L;
+
+ /**
+ *
+ * Global start event that can be used to indicate the start of a sequence.
+ *
+ */
+ public static final Event STARTEVENT = new Event(new DummyEventType());
+
+ /**
+ *
+ * Global end event that can be used to indicate the end of a sequence.
+ */
+ public static final Event ENDEVENT = new Event(new DummyEventType());
+
+ /**
+ *
+ * Type of the event.
+ *
+ */
+ protected IEventType type;
+
+ /**
+ * Target of the event.
+ */
+ protected IEventTarget target = null;
+
+ /**
+ *
+ * List of {@link IReplayable}s of type T that describes the replay of an event. The
+ * {@link IReplayable}s can be interpreted as sub-events on the platform level that
+ * make up the abstract event.
+ *
+ */
+ protected List replay = new LinkedList();
+
+ /**
+ *
+ * Constructor. Creates a new Event with a given type. The type must not be null.
+ *
+ *
+ * @param type
+ * type of the event
+ */
+ public Event(IEventType type) {
+ if (type == null) {
+ throw new InvalidParameterException("Event type must not be null");
+ }
+ this.type = type;
+ }
+
+ /**
+ *
+ * Constructor. Creates a new Event with a given type and target. The type must not be null.
+ *
+ *
+ * @param type
+ * type of the event
+ * @param target
+ * target of the event
+ */
+ public Event(IEventType type, IEventTarget target) {
+ this(type);
+ this.target = target;
+ }
+
+ /**
+ *
+ * Two events are equal, if their {@link #type} and {@link #target} are equal.
+ *
+ *
+ * See {@link Object#equals(Object)} for further information.
+ *
+ *
+ * @param other
+ * Event that is compared to this
+ * @return true, if events are equal, false otherwise
+ */
+ @Override
+ public boolean equals(Object other) {
+ if (this == other) {
+ return true;
+ }
+ if (other instanceof Event) {
+ Event otherEvent = (Event) other;
+ if (target != null) {
+ return type.equals(otherEvent.type) && target.equals(otherEvent.target);
+ }
+ else {
+ return type.equals(otherEvent.type) && otherEvent.target == null;
+ }
+ }
+ return false;
+ }
+
+ /**
+ *
+ * Returns {@link #getStandardId()} as String representation of the event.
+ *
+ *
+ * @return String representation of the event
+ */
+ @Override
+ public String toString() {
+ return "(" + type.toString() + ";" + target.toString() + ")";
+ }
+
+ /**
+ *
+ * Returns the {@link #target} of the event.
+ *
+ *
+ * @return {@link #target} of the event
+ */
+ public IEventTarget getTarget() {
+ return target;
+ }
+
+ /**
+ *
+ * Returns the {@link #type} of the event.
+ *
+ *
+ * @return {@link #type} of the event
+ */
+ public IEventType getType() {
+ return type;
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see java.lang.Object#hashCode()
+ */
+ @Override
+ public int hashCode() {
+ int multiplier = 17;
+ int hash = 42;
+ if (type != null) {
+ hash = multiplier * hash + type.hashCode();
+ }
+ if (target != null) {
+ hash = multiplier * hash + target.hashCode();
+ }
+ return hash;
+ }
+
+ /**
+ *
+ * Sets the target of the event. Once set, the target cannot be changed.
+ *
+ *
+ * @param target
+ * target of the event
+ * @return true, if target was changed, false otherwise
+ */
+ public boolean setTarget(IEventTarget target) {
+ if (this.target != null) {
+ return false;
+ }
+ this.target = target;
+ return true;
+ }
+
+ /**
+ *
+ * Adds a new {@link IReplayable} of type T to the replay sequence.
+ *
+ *
+ * @param replayable
+ * element that is added to the sequence
+ * @throws InvalidParameterException
+ * thrown is replayable is null
+ */
+ public void addReplayable(IReplayable replayable) {
+ if (replayable == null) {
+ throw new InvalidParameterException("replayble must not be null");
+ }
+ replay.add(replayable);
+ }
+
+ /**
+ *
+ * Adds a {@link List}ist of {@link IReplayable} to the replay sequence.
+ *
+ *
+ * @param generatedReplaySeq
+ * {@link List} that is added to the sequence
+ * @throws InvalidParameterException
+ * thrown if generatedReplaySeq is null
+ */
+ public void addReplayableSequence(List generatedReplaySeq) {
+ if (generatedReplaySeq == null) {
+ throw new InvalidParameterException("generatedReplaySeq must not be null");
+ }
+ replay.addAll(generatedReplaySeq);
+ }
+
+ /**
+ *
+ * Returns a the list of replay events.
+ *
+ *
+ * The return value is a copy of the list used internally!
+ *
+ *
+ * @return list of replay events.
+ */
+ public List getReplayables() {
+ return new LinkedList(replay);
+ }
}
Index: /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/IEventTarget.java
===================================================================
--- /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/IEventTarget.java (revision 541)
+++ /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/IEventTarget.java (revision 541)
@@ -0,0 +1,16 @@
+
+package de.ugoe.cs.quest.eventcore;
+
+/**
+ *
+ *
+ * TODO comment
+ *
+ *
+ * @version $Revision: $ $Date: Aug 16, 2012$
+ * @author 2012, last modified by $Author: sherbold$
+ */
+public interface IEventTarget {
+
+ public String getPlatform();
+}
Index: /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/IEventType.java
===================================================================
--- /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/IEventType.java (revision 541)
+++ /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/IEventType.java (revision 541)
@@ -0,0 +1,13 @@
+package de.ugoe.cs.quest.eventcore;
+
+/**
+ *
+ * TODO comment
+ *
+ *
+ * @version $Revision: $ $Date: Aug 16, 2012$
+ * @author 2012, last modified by $Author: sherbold$
+ */
+public interface IEventType {
+
+}
Index: /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/IReplayable.java
===================================================================
--- /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/IReplayable.java (revision 540)
+++ /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/IReplayable.java (revision 541)
@@ -24,12 +24,3 @@
*/
String getReplay();
-
- /**
- *
- * Returns the target of the replayable.
- *
- *
- * @return target of the replayable
- */
- String getTarget();
}
Index: unk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/ReplayableEvent.java
===================================================================
--- /trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/ReplayableEvent.java (revision 540)
+++ (revision )
@@ -1,167 +1,0 @@
-package de.ugoe.cs.quest.eventcore;
-
-import java.security.InvalidParameterException;
-import java.util.LinkedList;
-import java.util.List;
-
-import de.ugoe.cs.quest.IReplayDecorator;
-
-/**
- *
- * Subclass of {@link Event} for events that contain all informations required
- * for replaying them, i.e., generating scripts that can used for automated
- * software execution.
- *
- *
- * @author Steffen Herbold
- * @version 1.0
- *
- * @param
- * Allows only types that extend {@link IReplayable} and is used to
- * define a list of replayables that describe the replay of the
- * event.
- */
-public class ReplayableEvent extends Event {
-
- /**
- * Id for object serialization.
- */
- private static final long serialVersionUID = 1L;
-
- /**
- *
- * List of {@link IReplayable}s of type T that describes the replay of an
- * event. The {@link IReplayable}s can be interpreted as sub-events
- * on the platform level that make up the abstract event.
- *
- */
- protected List replayEvents = new LinkedList();;
-
- /**
- *
- * Defines whether the replay is valid or invalid. It may be invalid, e.g.,
- * due to errors during the generation of the event or lack of vital
- * information.
- *
- */
- protected boolean replayValid = true;
-
- /**
- *
- * {@link IReplayDecorator} used when replays of this type are written.
- *
- */
- protected IReplayDecorator decorator = null;
-
- /**
- *
- * Constructor. Creates a new event with the given type.
- *
- *
- * @param type
- * type of the event
- * @see Event#Event(String)
- */
- public ReplayableEvent(String type) {
- super(type);
- }
-
- /**
- *
- * Adds a new {@link IReplayable} of type T to the replay sequence.
- *
- *
- * @param replayable
- * element that is added to the sequence
- * @throws InvalidParameterException
- * thrown is replayable is null
- */
- public void addReplayEvent(T replayable) {
- if (replayable == null) {
- throw new InvalidParameterException("replayble must not be null");
- }
- replayEvents.add(replayable);
- }
-
- /**
- *
- * Adds a {@link List}ist of {@link IReplayable} to the replay sequence.
- *
- *
- * @param generatedReplaySeq
- * {@link List} that is added to the sequence
- * @throws InvalidParameterException
- * thrown if generatedReplaySeq is null
- */
- public void addReplaySequence(List generatedReplaySeq) {
- if (generatedReplaySeq == null) {
- throw new InvalidParameterException(
- "generatedReplaySeq must not be null");
- }
- replayEvents.addAll(generatedReplaySeq);
- }
-
- /**
- *
- * Returns the {@link IReplayDecorator} of the event.
- *
- *
- * @return {@link IReplayDecorator} of the event; null if no decorator has
- * been set
- */
- public IReplayDecorator getReplayDecorator() {
- return decorator;
- }
-
- /**
- *
- * Returns a the list of replay events.
- *
- *
- * The return value is a copy of the list used internally!
- *
- *
- * @return list of replay events.
- */
- public List getReplayMessages() {
- return new LinkedList(replayEvents);
- }
-
- /**
- *
- * Returns whether the replay is valid or not.
- *
- *
- * @return true, if replay is valid; false otherwise.
- */
- public boolean hasValidReplay() {
- return replayValid;
- }
-
- /**
- *
- * Marks the replay as invalid. Once marked as invalid, it remains so and
- * cannot be changed back to valid.
- *
- */
- public void invalidateReplay() {
- replayValid = false;
- }
-
- /**
- *
- * Sets the {@link IReplayDecorator} associated with the event.
- *
- *
- * @param decorator
- * decorator associated with the event
- */
- public void setDecorator(IReplayDecorator decorator) {
- this.decorator = decorator;
- }
-
- @Override
- public boolean canEqual(Object other) {
- return (other instanceof ReplayableEvent);
- }
-}