From c02b06fcba5ed94a7848be15117b9f6de5957a36 Mon Sep 17 00:00:00 2001
From: Nelson Tavares de Sousa <ntd@informatik.uni-kiel.de>
Date: Mon, 20 Apr 2015 14:14:48 +0200
Subject: [PATCH] added javadoc
---
.../framework/AnalysisConfiguration.java | 42 +++++++++++++++++++
1 file changed, 42 insertions(+)
diff --git a/src/main/java/teetime/framework/AnalysisConfiguration.java b/src/main/java/teetime/framework/AnalysisConfiguration.java
index 31c1eddc..23a784ec 100644
--- a/src/main/java/teetime/framework/AnalysisConfiguration.java
+++ b/src/main/java/teetime/framework/AnalysisConfiguration.java
@@ -57,22 +57,64 @@ public abstract class AnalysisConfiguration {
this.threadableStageJobs.add(stage);
}
+ /**
+ * Connects two stages with a pipe within the same thread.
+ *
+ * @param sourcePort
+ * @param targetPort
+ * @return
+ * the pipe instance which connects the two given stages
+ */
protected static <T> IPipe connectIntraThreads(final OutputPort<? extends T> sourcePort, final InputPort<T> targetPort) {
return intraThreadFactory.create(sourcePort, targetPort);
}
+ /**
+ * Connects two stages with a bounded pipe within two separate threads.
+ *
+ * @param sourcePort
+ * @param targetPort
+ * @return
+ * the pipe instance which connects the two given stages
+ */
protected static <T> IPipe connectBoundedInterThreads(final OutputPort<? extends T> sourcePort, final InputPort<T> targetPort) {
return interBoundedThreadFactory.create(sourcePort, targetPort);
}
+ /**
+ * Connects two stages with a unbounded pipe within two separate threads.
+ *
+ * @param sourcePort
+ * @param targetPort
+ * @return
+ * the pipe instance which connects the two given stages
+ */
protected static <T> IPipe connectUnboundedInterThreads(final OutputPort<? extends T> sourcePort, final InputPort<T> targetPort) {
return interUnboundedThreadFactory.create(sourcePort, targetPort);
}
+ /**
+ * Connects two stages with a bounded pipe within two separate threads.
+ *
+ * @param sourcePort
+ * @param targetPort
+ * @param capacity
+ * capacity of the underlying queue
+ * @return
+ */
protected static <T> IPipe connectBoundedInterThreads(final OutputPort<? extends T> sourcePort, final InputPort<T> targetPort, final int capacity) {
return interBoundedThreadFactory.create(sourcePort, targetPort, capacity);
}
+ /**
+ * Connects two stages with a unbounded pipe within two separate threads.
+ *
+ * @param sourcePort
+ * @param targetPort
+ * @param capacity
+ * capacity of the underlying queue
+ * @return
+ */
protected static <T> IPipe connectUnboundedInterThreads(final OutputPort<? extends T> sourcePort, final InputPort<T> targetPort, final int capacity) {
return interUnboundedThreadFactory.create(sourcePort, targetPort, capacity);
}
--
GitLab