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 7bf2a415e1567497da672fd70c75fcf7ecf99c1b..7914a4985b6df40f7146c1fd681d1fba063f8b98 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 2d30e108b16548e5e9137463aca91056b204bb08..8c59079ddabafa4fb1de398b7d58503362fa721e 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 1175b35e7c445ede30423805510b6b7756980eea..7c95e24f2b97d6259ec8c1bb4c75a356ef477287 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> {