From d107f574c8881f9c7983d586ccd17feb806910e5 Mon Sep 17 00:00:00 2001
From: Nelson Tavares de Sousa <stu103017@mail.uni-kiel.de>
Date: Tue, 4 Aug 2015 14:51:53 +0200
Subject: [PATCH] visibility and javadoc
---
src/main/java/teetime/framework/A0UnconnectedPort.java | 5 ++++-
.../teetime/framework/A1ThreadableStageCollector.java | 5 ++++-
.../framework/A2InvalidThreadAssignmentCheck.java | 9 ++++++---
src/main/java/teetime/framework/A3PipeInstantiation.java | 8 +++++---
.../java/teetime/framework/A4StageAttributeSetter.java | 5 ++++-
5 files changed, 23 insertions(+), 9 deletions(-)
diff --git a/src/main/java/teetime/framework/A0UnconnectedPort.java b/src/main/java/teetime/framework/A0UnconnectedPort.java
index c3fd19bd..0ffe8960 100644
--- a/src/main/java/teetime/framework/A0UnconnectedPort.java
+++ b/src/main/java/teetime/framework/A0UnconnectedPort.java
@@ -21,7 +21,10 @@ import org.slf4j.LoggerFactory;
import teetime.framework.Traverser.VisitorBehavior;
import teetime.framework.pipe.DummyPipe;
-public class A0UnconnectedPort implements ITraverserVisitor {
+/**
+ * Connects unconnected ports to a dummy pipe
+ */
+class A0UnconnectedPort implements ITraverserVisitor {
private static final Logger LOGGER = LoggerFactory.getLogger(A0UnconnectedPort.class);
diff --git a/src/main/java/teetime/framework/A1ThreadableStageCollector.java b/src/main/java/teetime/framework/A1ThreadableStageCollector.java
index 29f639c1..0b34c30b 100644
--- a/src/main/java/teetime/framework/A1ThreadableStageCollector.java
+++ b/src/main/java/teetime/framework/A1ThreadableStageCollector.java
@@ -20,7 +20,10 @@ import java.util.Set;
import teetime.framework.Traverser.VisitorBehavior;
-public class A1ThreadableStageCollector implements ITraverserVisitor {
+/**
+ * Searches for threadable stages
+ */
+class A1ThreadableStageCollector implements ITraverserVisitor {
private final Set<Stage> threadableStages = new HashSet<Stage>();
diff --git a/src/main/java/teetime/framework/A2InvalidThreadAssignmentCheck.java b/src/main/java/teetime/framework/A2InvalidThreadAssignmentCheck.java
index 63dda410..043c31ee 100644
--- a/src/main/java/teetime/framework/A2InvalidThreadAssignmentCheck.java
+++ b/src/main/java/teetime/framework/A2InvalidThreadAssignmentCheck.java
@@ -17,12 +17,15 @@ package teetime.framework;
import java.util.Set;
-import teetime.framework.Traverser.VisitorBehavior;
-import teetime.framework.pipe.IPipe;
-
import com.carrotsearch.hppc.ObjectIntHashMap;
import com.carrotsearch.hppc.ObjectIntMap;
+import teetime.framework.Traverser.VisitorBehavior;
+import teetime.framework.pipe.IPipe;
+
+/**
+ * Checks for invalid thread assignments
+ */
public class A2InvalidThreadAssignmentCheck {
private static final int DEFAULT_COLOR = 0;
diff --git a/src/main/java/teetime/framework/A3PipeInstantiation.java b/src/main/java/teetime/framework/A3PipeInstantiation.java
index 9d6ca928..4bbe1a9c 100644
--- a/src/main/java/teetime/framework/A3PipeInstantiation.java
+++ b/src/main/java/teetime/framework/A3PipeInstantiation.java
@@ -26,7 +26,10 @@ import teetime.framework.pipe.SingleElementPipeFactory;
import teetime.framework.pipe.SpScPipeFactory;
import teetime.framework.pipe.UnboundedSpScPipeFactory;
-public class A3PipeInstantiation implements ITraverserVisitor {
+/**
+ * Automatically instantiates the correct pipes
+ */
+class A3PipeInstantiation implements ITraverserVisitor {
private static final IPipeFactory interBoundedThreadPipeFactory = new SpScPipeFactory();
private static final IPipeFactory interUnboundedThreadPipeFactory = new UnboundedSpScPipeFactory();
@@ -67,12 +70,11 @@ public class A3PipeInstantiation implements ITraverserVisitor {
} else {
interUnboundedThreadPipeFactory.create(pipe.getSourcePort(), pipe.getTargetPort(), 4);
}
- return;
} else {
// normal or reflexive pipe => intra
+ intraThreadPipeFactory.create(pipe.getSourcePort(), pipe.getTargetPort(), 4);
}
- intraThreadPipeFactory.create(pipe.getSourcePort(), pipe.getTargetPort(), 4);
}
}
diff --git a/src/main/java/teetime/framework/A4StageAttributeSetter.java b/src/main/java/teetime/framework/A4StageAttributeSetter.java
index 1e8ea4c0..3b57d5eb 100644
--- a/src/main/java/teetime/framework/A4StageAttributeSetter.java
+++ b/src/main/java/teetime/framework/A4StageAttributeSetter.java
@@ -17,7 +17,10 @@ package teetime.framework;
import java.util.Set;
-public class A4StageAttributeSetter {
+/**
+ * Sets the attributes of all stages within the same thread
+ */
+class A4StageAttributeSetter {
private final Configuration configuration;
private final Set<Stage> threadableStages;
--
GitLab