From ea2aa9eefec92860971a500d0b31da61590b4bd2 Mon Sep 17 00:00:00 2001
From: Simon Ehrenstein <simon.ehrenstein@gmail.com>
Date: Sun, 14 Jun 2020 18:02:41 +0200
Subject: [PATCH] Add Javadoc
---
.../commons/workloadgeneration/functions/BeforeAction.java | 5 ++++-
.../workloadgeneration/functions/MessageGenerator.java | 6 ++++++
.../commons/workloadgeneration/functions/Transport.java | 6 ++++++
3 files changed, 16 insertions(+), 1 deletion(-)
diff --git a/workload-generator-commons/src/main/java/theodolite/commons/workloadgeneration/functions/BeforeAction.java b/workload-generator-commons/src/main/java/theodolite/commons/workloadgeneration/functions/BeforeAction.java
index 7bf2a415e..7914a4985 100644
--- a/workload-generator-commons/src/main/java/theodolite/commons/workloadgeneration/functions/BeforeAction.java
+++ b/workload-generator-commons/src/main/java/theodolite/commons/workloadgeneration/functions/BeforeAction.java
@@ -1,8 +1,11 @@
package theodolite.commons.workloadgeneration.functions;
+/**
+ * Describes the before action which is executed before every sub experiment.
+ */
@FunctionalInterface
public interface BeforeAction {
public void run();
-
+
}
diff --git a/workload-generator-commons/src/main/java/theodolite/commons/workloadgeneration/functions/MessageGenerator.java b/workload-generator-commons/src/main/java/theodolite/commons/workloadgeneration/functions/MessageGenerator.java
index 2d30e108b..8c59079dd 100644
--- a/workload-generator-commons/src/main/java/theodolite/commons/workloadgeneration/functions/MessageGenerator.java
+++ b/workload-generator-commons/src/main/java/theodolite/commons/workloadgeneration/functions/MessageGenerator.java
@@ -2,6 +2,12 @@ package theodolite.commons.workloadgeneration.functions;
import kieker.common.record.IMonitoringRecord;
+/**
+ * This interface describes a function that takes meta information from a string (e.g. an ID) and
+ * produces an {@link IMonitoringRecord}.
+ *
+ * @param <T> the type of the objects that will be generated by the function.
+ */
@FunctionalInterface
public interface MessageGenerator<T extends IMonitoringRecord> {
diff --git a/workload-generator-commons/src/main/java/theodolite/commons/workloadgeneration/functions/Transport.java b/workload-generator-commons/src/main/java/theodolite/commons/workloadgeneration/functions/Transport.java
index 1175b35e7..7c95e24f2 100644
--- a/workload-generator-commons/src/main/java/theodolite/commons/workloadgeneration/functions/Transport.java
+++ b/workload-generator-commons/src/main/java/theodolite/commons/workloadgeneration/functions/Transport.java
@@ -2,6 +2,12 @@ package theodolite.commons.workloadgeneration.functions;
import kieker.common.record.IMonitoringRecord;
+/**
+ * This interface describes a function that consumes a {@link IMonitoringRecord}. This function is
+ * dedicated to be used to transport individual messages to the messaging system.
+ *
+ * @param <T> the type of records to send as messages.
+ */
@FunctionalInterface
public interface Transport<T extends IMonitoringRecord> {
--
GitLab