From 7274fdd5841f218a9cfbedac33464631f8b03894 Mon Sep 17 00:00:00 2001
From: Nelson Tavares de Sousa <stu103017@mail.uni-kiel.de>
Date: Wed, 26 Aug 2015 13:07:51 +0200
Subject: [PATCH] distributor javadoc
---
.../stage/basic/distributor/Distributor.java | 27 +++++++++++++
.../teetime/stage/basic/merger/Merger.java | 38 ++++++++++---------
2 files changed, 48 insertions(+), 17 deletions(-)
diff --git a/src/main/java/teetime/stage/basic/distributor/Distributor.java b/src/main/java/teetime/stage/basic/distributor/Distributor.java
index fe7aee22..416af650 100644
--- a/src/main/java/teetime/stage/basic/distributor/Distributor.java
+++ b/src/main/java/teetime/stage/basic/distributor/Distributor.java
@@ -23,6 +23,33 @@ import teetime.stage.basic.distributor.strategy.IDistributorStrategy;
import teetime.stage.basic.distributor.strategy.RoundRobinStrategy2;
/**
+ *
+ * <pre>
+ * Illustration:
+ *
+ * Inputports Outputport
+ * | |
+ * v v
+ *
+ * +---------------------------+
+ * | |
+ * +---+ |
+ * | | +-----------+ |
+ * +---+ | |
+ * | | |
+ * | +---+
+ * . . . . ---+-------> | |
+ * | +---+
+ * | | |
+ * +---+ | |
+ * | | +-----------+ |
+ * +---+ |
+ * | |
+ * +---------------------------+
+ *
+ *
+ * </pre>
+ *
* @author Christian Wulf
*
* @since 1.0
diff --git a/src/main/java/teetime/stage/basic/merger/Merger.java b/src/main/java/teetime/stage/basic/merger/Merger.java
index 04cf447a..2e0f48e2 100644
--- a/src/main/java/teetime/stage/basic/merger/Merger.java
+++ b/src/main/java/teetime/stage/basic/merger/Merger.java
@@ -20,31 +20,35 @@ import java.util.List;
import teetime.framework.AbstractStage;
import teetime.framework.InputPort;
import teetime.framework.OutputPort;
-import teetime.framework.signal.ISignal;
import teetime.stage.basic.merger.strategy.IMergerStrategy;
import teetime.stage.basic.merger.strategy.RoundRobinStrategy;
/**
*
* This stage merges data from the input ports, by taking elements according to the chosen merge strategy and by putting them to the output port.
- * For its signal handling behavior see {@link #onSignal(ISignal, InputPort)}
*
* <pre>
- * +--------------------------------+
- * | |
- * | +---+
- * | +------------> | |
- * | | +---+
- * | | |
- * +---+ | +---+
- * | | +-----------+------------> | |
- * +---+ | +---+
- * | | |
- * | | +---+
- * | +------------> | |
- * | +---+
- * | |
- * +--------------------------------+
+ * Illustration:
+ *
+ * Inputport Outputports
+ * | |
+ * v v
+ *
+ * +----------------------------+
+ * | |
+ * | +---+
+ * | +------------> | |
+ * | | +---+
+ * | | |
+ * +---+ |
+ * | | +-------+--- . . . .
+ * +---+ |
+ * | | |
+ * | | +---+
+ * | +------------> | |
+ * | +---+
+ * | |
+ * +----------------------------+
* </pre>
*
*
--
GitLab