From cb8bd1ca53461988ae558605ea183198721bbd78 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=B6ren=20Henning?= <soeren.henning@email.uni-kiel.de>
Date: Wed, 16 Feb 2022 16:51:54 +0100
Subject: [PATCH] Fix checkstyle warnings
---
.../src/main/java/application/ConverterAdapter.java | 6 ++++++
.../uc1-beam/src/main/java/application/WriterAdapter.java | 2 ++
.../java/theodolite/uc1/application/ConverterAdapter.java | 2 ++
.../main/java/theodolite/uc1/application/WriterAdapter.java | 2 ++
4 files changed, 12 insertions(+)
diff --git a/theodolite-benchmarks/uc1-beam/src/main/java/application/ConverterAdapter.java b/theodolite-benchmarks/uc1-beam/src/main/java/application/ConverterAdapter.java
index 521a47afd..e368c3a06 100644
--- a/theodolite-benchmarks/uc1-beam/src/main/java/application/ConverterAdapter.java
+++ b/theodolite-benchmarks/uc1-beam/src/main/java/application/ConverterAdapter.java
@@ -7,6 +7,8 @@ import titan.ccp.model.records.ActivePowerRecord;
/**
* {@link SimpleFunction} which wraps a {@link RecordConverter} to be used with Beam.
+ *
+ * @param <T> type the {@link RecordConverter} is associated with.
*/
public class ConverterAdapter<T> extends SimpleFunction<ActivePowerRecord, T> {
@@ -15,6 +17,10 @@ public class ConverterAdapter<T> extends SimpleFunction<ActivePowerRecord, T> {
private final RecordConverter<T> recordConverter;
private final TypeDescriptor<T> type;
+ /**
+ * Create a new {@link ConverterAdapter} with a given {@link RecordConverter} and the associated
+ * type.
+ */
public ConverterAdapter(final RecordConverter<T> recordConverter, final Class<T> type) {
super();
this.recordConverter = recordConverter;
diff --git a/theodolite-benchmarks/uc1-beam/src/main/java/application/WriterAdapter.java b/theodolite-benchmarks/uc1-beam/src/main/java/application/WriterAdapter.java
index 5fc9ed3e1..eb9a2670c 100644
--- a/theodolite-benchmarks/uc1-beam/src/main/java/application/WriterAdapter.java
+++ b/theodolite-benchmarks/uc1-beam/src/main/java/application/WriterAdapter.java
@@ -6,6 +6,8 @@ import rocks.theodolite.benchmarks.uc1.commons.DatabaseWriter;
/**
* {@link DoFn} which wraps a {@link DatabaseAdapter} to be used with Beam.
+ *
+ * @param <T> type the {@link DatabaseWriter} is associated with.
*/
public class WriterAdapter<T> extends DoFn<T, Void> {
diff --git a/theodolite-benchmarks/uc1-flink/src/main/java/theodolite/uc1/application/ConverterAdapter.java b/theodolite-benchmarks/uc1-flink/src/main/java/theodolite/uc1/application/ConverterAdapter.java
index d8b833169..af0a0b1cf 100644
--- a/theodolite-benchmarks/uc1-flink/src/main/java/theodolite/uc1/application/ConverterAdapter.java
+++ b/theodolite-benchmarks/uc1-flink/src/main/java/theodolite/uc1/application/ConverterAdapter.java
@@ -6,6 +6,8 @@ import titan.ccp.model.records.ActivePowerRecord;
/**
* {@link MapFunction} which wraps a {@link RecordConverter} to be used with Flink.
+ *
+ * @param <T> type the {@link RecordConverter} is associated with.
*/
public class ConverterAdapter<T> implements MapFunction<ActivePowerRecord, T> {
diff --git a/theodolite-benchmarks/uc1-flink/src/main/java/theodolite/uc1/application/WriterAdapter.java b/theodolite-benchmarks/uc1-flink/src/main/java/theodolite/uc1/application/WriterAdapter.java
index 7974fd19b..b2f375ec5 100644
--- a/theodolite-benchmarks/uc1-flink/src/main/java/theodolite/uc1/application/WriterAdapter.java
+++ b/theodolite-benchmarks/uc1-flink/src/main/java/theodolite/uc1/application/WriterAdapter.java
@@ -7,6 +7,8 @@ import rocks.theodolite.benchmarks.uc1.commons.DatabaseWriter;
/**
* {@link FlatMapFunction} which wraps a {@link DatabaseAdapter} to be used with Flink.
+ *
+ * @param <T> type the {@link DatabaseWriter} is associated with.
*/
public class WriterAdapter<T> implements FlatMapFunction<T, Void> {
--
GitLab