From fe4c728cb6435dfcfec306d1e96831a422a54cd8 Mon Sep 17 00:00:00 2001
From: Christian Wulf <chw@informatik.uni-kiel.de>
Date: Fri, 15 Aug 2014 05:38:54 +0200
Subject: [PATCH] updated javadoc
---
.../framework/core/ConsumerStage.java | 5 -----
.../framework/core/ProducerStage.java | 13 +++++++++++++
.../framework/core/StageWithPort.java | 4 ++++
submodules/JCTools | 2 +-
4 files changed, 18 insertions(+), 6 deletions(-)
diff --git a/src/main/java/teetime/variant/methodcallWithPorts/framework/core/ConsumerStage.java b/src/main/java/teetime/variant/methodcallWithPorts/framework/core/ConsumerStage.java
index 1540b1fb..046395a5 100644
--- a/src/main/java/teetime/variant/methodcallWithPorts/framework/core/ConsumerStage.java
+++ b/src/main/java/teetime/variant/methodcallWithPorts/framework/core/ConsumerStage.java
@@ -23,11 +23,6 @@ public abstract class ConsumerStage<I> extends AbstractStage {
// do nothing
}
- /**
- *
- * @return <code>true</code> iff this stage makes progress when it is re-executed by the scheduler, otherwise <code>false</code>.<br>
- * For example, many stages are re-schedulable if at least one of their input ports are not empty.
- */
protected boolean determineReschedulability() {
return this.inputPort.getPipe().size() > 0;
}
diff --git a/src/main/java/teetime/variant/methodcallWithPorts/framework/core/ProducerStage.java b/src/main/java/teetime/variant/methodcallWithPorts/framework/core/ProducerStage.java
index c1e7c693..5a949215 100644
--- a/src/main/java/teetime/variant/methodcallWithPorts/framework/core/ProducerStage.java
+++ b/src/main/java/teetime/variant/methodcallWithPorts/framework/core/ProducerStage.java
@@ -1,5 +1,18 @@
package teetime.variant.methodcallWithPorts.framework.core;
+/**
+ * The <code>ProducerStage</code> produces at least one element at each execution.<br>
+ *
+ * @reschedulability
+ * This stage is executed as long as its execute() method decided to do so.<br>
+ * Refer to {@link AbstractStage#isReschedulable} for more information.
+ *
+ * @author Christian Wulf
+ *
+ * @param <O>
+ * the type of the default output port
+ *
+ */
public abstract class ProducerStage<O> extends AbstractStage {
protected final OutputPort<O> outputPort = this.createOutputPort();
diff --git a/src/main/java/teetime/variant/methodcallWithPorts/framework/core/StageWithPort.java b/src/main/java/teetime/variant/methodcallWithPorts/framework/core/StageWithPort.java
index bbeb1631..72563660 100644
--- a/src/main/java/teetime/variant/methodcallWithPorts/framework/core/StageWithPort.java
+++ b/src/main/java/teetime/variant/methodcallWithPorts/framework/core/StageWithPort.java
@@ -12,6 +12,10 @@ public interface StageWithPort {
// void setListener(OnDisableListener listener);
+ /**
+ * @return <code>true</code> iff this stage makes progress when it is re-executed by the scheduler, otherwise <code>false</code>.<br>
+ * For example, many stages are re-schedulable if at least one of their input ports are not empty.
+ */
boolean isReschedulable();
void onIsPipelineHead();
diff --git a/submodules/JCTools b/submodules/JCTools
index 75998aa2..88e1e25f 160000
--- a/submodules/JCTools
+++ b/submodules/JCTools
@@ -1 +1 @@
-Subproject commit 75998aa20b7ec897ec321c1f94192de888f2dc6e
+Subproject commit 88e1e25f9519b250258c7e5ada30935975ab2d10
--
GitLab