Merge branch 'added-javadoc' into 'master'

Added javadoc

See merge request !24

src/main/java/teetime/framework/Analysis.java

@@ -30,8 +30,6 @@ public class Analysis implements UncaughtExceptionHandler {
 
 	private final Collection<Pair<Thread, Throwable>> exceptions = new ConcurrentLinkedQueue<Pair<Thread, Throwable>>();
 
-	private boolean initExecuted = false;
-
 	public Analysis(final AnalysisConfiguration configuration) {
 		this.configuration = configuration;
 	}
@@ -40,7 +38,6 @@ public class Analysis implements UncaughtExceptionHandler {
 	 * This initializes Analysis and needs to be run right before starting it.
 	 */
 	public void init() {
-		initExecuted = true;
 		final List<Stage> threadableStageJobs = this.configuration.getThreadableStageJobs();
 		for (Stage stage : threadableStageJobs) {
 			final Thread thread = new Thread(new RunnableStage(stage));
@@ -67,9 +64,6 @@ public class Analysis implements UncaughtExceptionHandler {
 	 * @return a collection of thread/throwable pairs
 	 */
 	public Collection<Pair<Thread, Throwable>> start() {
-		if (!initExecuted) {
-			LOGGER.error("init() not executed before starting the analysis");
-		}
 		// start analysis
 		startThreads(this.consumerThreads);
 		startThreads(this.finiteProducerThreads);

src/main/java/teetime/framework/package-info.java

+/**
+ * Contains the implementation of the TeeTime framework.
+ */
+package teetime.framework;
\ No newline at end of file

src/main/java/teetime/framework/pipe/package-info.java

+/**
+ * Contains all pipes related classes, such as factories and pre-defined pipes.
+ */
+package teetime.framework.pipe;
\ No newline at end of file

src/main/java/teetime/framework/signal/package-info.java

+/**
+ * Contains the signals that are used within the framework.
+ */
+package teetime.framework.signal;
\ No newline at end of file

src/main/java/teetime/stage/package-info.java

+/**
+ * Contains a set of pre-defined stages, which are ready-to-go and can be used for analysis configuration.
+ */
+package teetime.stage;
\ No newline at end of file

src/main/java/teetime/util/package-info.java

+/**
+ * Contains a set of utility classes, which are used by the TeeTime framework.
+ */
+package teetime.util;
\ No newline at end of file