From 45a4171a27083c31ce4bbbe57b98257029390b6a Mon Sep 17 00:00:00 2001
From: Nelson Tavares de Sousa <ntd@informatik.uni-kiel.de>
Date: Fri, 12 Dec 2014 17:22:25 +0100
Subject: [PATCH] #83 added JavaDoc
---
src/main/java/teetime/framework/Stage.java | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/src/main/java/teetime/framework/Stage.java b/src/main/java/teetime/framework/Stage.java
index f947b215..d9dc3c67 100644
--- a/src/main/java/teetime/framework/Stage.java
+++ b/src/main/java/teetime/framework/Stage.java
@@ -25,6 +25,11 @@ public abstract class Stage { // NOPMD (should not start with "Abstract")
this.logger = LoggerFactory.getLogger(this.id);
}
+ /**
+ * Retrieves the identifier associated with the stage
+ *
+ * @return An id as String
+ */
public String getId() {
return this.id;
}
@@ -56,6 +61,7 @@ public abstract class Stage { // NOPMD (should not start with "Abstract")
// public abstract void setParentStage(Stage parentStage, int index);
/**
+ * This should check, if the OutputPorts are connected correctly. This is needed to avoid NullPointerExceptions and other errors.
*
* @param invalidPortConnections
* <i>(Passed as parameter for performance reasons)</i>
--
GitLab