From 876348e83054e71118e25260bb10cb628032fe8e Mon Sep 17 00:00:00 2001
From: Nelson Tavares de Sousa <stu103017@mail.uni-kiel.de>
Date: Tue, 2 Jun 2015 13:36:03 +0200
Subject: [PATCH] javadoc
---
.../framework/AnalysisConfiguration.java | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/src/main/java/teetime/framework/AnalysisConfiguration.java b/src/main/java/teetime/framework/AnalysisConfiguration.java
index 9755a33c..4a4c8901 100644
--- a/src/main/java/teetime/framework/AnalysisConfiguration.java
+++ b/src/main/java/teetime/framework/AnalysisConfiguration.java
@@ -145,10 +145,28 @@ public abstract class AnalysisConfiguration {
return interUnboundedThreadFactory.create(sourcePort, targetPort, capacity);
}
+ /**
+ * Connects two ports with a pipe.
+ *
+ * @param sourcePort
+ * port from the sending stage
+ * @param targetPort
+ * port from the receiving stage
+ */
protected <T> void connectPorts(final OutputPort<? extends T> sourcePort, final InputPort<T> targetPort) {
connectPorts(sourcePort, targetPort, 4);
}
+ /**
+ * Connects to ports with a pipe of a certain capacity
+ *
+ * @param sourcePort
+ * port from the sending stage
+ * @param targetPort
+ * port from the receiving stage
+ * @param capacity
+ * the pipe is set to this capacity, if the value is greater than 0. If it is 0, than the pipe is unbounded, thus growing of the pipe is enabled.
+ */
protected <T> void connectPorts(final OutputPort<? extends T> sourcePort, final InputPort<T> targetPort, final int capacity) {
connections.add(new Connection(sourcePort, targetPort, capacity));
}
--
GitLab