From ddd93895a7f70c54744c8c34cc59cf5ab24bb4b7 Mon Sep 17 00:00:00 2001
From: Nelson Tavares de Sousa <ntd@informatik.uni-kiel.de>
Date: Fri, 21 Nov 2014 15:13:04 +0100
Subject: [PATCH] added javadoc, explaning the behavior on multiple signals
---
src/main/java/teetime/stage/basic/merger/Merger.java | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/src/main/java/teetime/stage/basic/merger/Merger.java b/src/main/java/teetime/stage/basic/merger/Merger.java
index fdff5c5b..b36c5bc9 100644
--- a/src/main/java/teetime/stage/basic/merger/Merger.java
+++ b/src/main/java/teetime/stage/basic/merger/Merger.java
@@ -54,6 +54,17 @@ public class Merger<T> extends AbstractStage {
this.send(this.outputPort, token);
}
+ /**
+ * This method is executed, if a signal is sent to a instance of this class.
+ * Multiple signals of one certain type are ignored, if they are sent to same port.
+ * Hence a signal is only passed on, when it arrived on all input ports, regardless how often.
+ *
+ * @param signal
+ * Signal which is sent
+ *
+ * @param inputPort
+ * The port which the signal was sent to
+ */
@Override
public void onSignal(final ISignal signal, final InputPort<?> inputPort) {
this.logger.trace("Got signal: " + signal + " from input port: " + inputPort);
--
GitLab