Merge branch '__rultor'

eo-cqrs · Apr 9, 2023 · 00bef04 · 00bef04
2 parents e5f56e5 + 4ffc3ab
commit 00bef04
Show file tree

Hide file tree

Showing 16 changed files with 33 additions and 10 deletions.
diff --git a/checkstyle-suppressions.xml b/checkstyle-suppressions.xml
@@ -30,10 +30,9 @@ and fix all documentation.
 <!DOCTYPE suppressions PUBLIC "-//Checkstyle//DTD SuppressionFilter Configuration 1.0//EN" "https://checkstyle.org/dtds/suppressions_1_0.dtd">
 <suppressions>
   <suppress checks="LineLength" files=".*\.java$" lines="0-23"/>
-  <suppress checks="JavadocType" files=".*\.java$" lines="23-9999"/>
   <suppress checks="JavadocVariable" files=".*\.java$" lines="23-9999"/>
   <suppress checks="JavadocMethod" files=".*\.java$" lines="23-9999"/>
   <suppress checks="HiddenField" files=".*\.java$" lines="23-9999"/>
-  <suppress checks="VisibilityModifier" files="KfFlexibleEnvelope.java" lines="44"/>
+  <suppress checks="VisibilityModifier" files="KfFlexibleEnvelope.java" lines="46"/>
   <suppress checks="VisibilityModifier" files="KfAttrEnvelope.java" lines="36-45"/>
 </suppressions>
diff --git a/src/main/java/io/github/eocqrs/kafka/Consumer.java b/src/main/java/io/github/eocqrs/kafka/Consumer.java
@@ -30,6 +30,8 @@
 /**
  * Consumer.
  *
+ * @param <K> The key
+ * @param <X> The value
  * @author Ivan Ivanchuck (l3r8y@duck.com)
  * @author Aliaksei Bialiauski (abialiauski.dev@gmail.com)
  * @since 0.0.0

diff --git a/src/main/java/io/github/eocqrs/kafka/ConsumerSettings.java b/src/main/java/io/github/eocqrs/kafka/ConsumerSettings.java
@@ -27,6 +27,8 @@
 /**
  * Consumer Settings.
  *
+ * @param <K> The key
+ * @param <X> The value
  * @author Aliaksei Bialiauski (abialiauski.dev@gmail.com)
  * @since 0.0.0
  */

diff --git a/src/main/java/io/github/eocqrs/kafka/Data.java b/src/main/java/io/github/eocqrs/kafka/Data.java
@@ -25,6 +25,7 @@
 /**
  * Message Data.
  *
+ * @param <X> The value
  * @author Aliaksei Bialiauski (abialiauski.dev@gmail.com)
  * @since 0.0.0
  */

diff --git a/src/main/java/io/github/eocqrs/kafka/Dataized.java b/src/main/java/io/github/eocqrs/kafka/Dataized.java
@@ -25,6 +25,7 @@
 /**
  * Dataized.
  *
+ * @param <T> The generic type for key
  * @author Aliaksei Bialiauski (abialiauski.dev@gmail.com)
  * @since 0.0.0
  */

diff --git a/src/main/java/io/github/eocqrs/kafka/Producer.java b/src/main/java/io/github/eocqrs/kafka/Producer.java
@@ -27,6 +27,8 @@
 /**
  * Producer.
  *
+ * @param <K> The key
+ * @param <X> The value
  * @author Aliaksei Bialiauski (abialiauski.dev@gmail.com)
  * @since 0.0.0
  */

diff --git a/src/main/java/io/github/eocqrs/kafka/ProducerSettings.java b/src/main/java/io/github/eocqrs/kafka/ProducerSettings.java
@@ -27,6 +27,8 @@
 /**
  * Producer Settings.
  *
+ * @param <K> The key
+ * @param <X> The value
  * @author Aliaksei Bialiauski (abialiauski.dev@gmail.com)
  * @since 0.0.0
  */

diff --git a/src/main/java/io/github/eocqrs/kafka/consumer/KfConsumer.java b/src/main/java/io/github/eocqrs/kafka/consumer/KfConsumer.java
@@ -36,6 +36,8 @@
 /**
  * Kafka Consumer.
  *
+ * @param <K> The key
+ * @param <X> The value
  * @author Aliaksei Bialiauski (abialiauski.dev@gmail.com)
  * @since 0.0.0
  */

diff --git a/src/main/java/io/github/eocqrs/kafka/data/KfData.java b/src/main/java/io/github/eocqrs/kafka/data/KfData.java
@@ -29,6 +29,7 @@
 /**
  * Kafka Message Data.
  *
+ * @param <X> The value
  * @author Aliaksei Bialiauski (abialiauski.dev@gmail.com)
  * @since 0.0.0
  */

diff --git a/src/main/java/io/github/eocqrs/kafka/data/KfDataized.java b/src/main/java/io/github/eocqrs/kafka/data/KfDataized.java
@@ -28,6 +28,7 @@
 /**
  * Kafka Dataized data.
  *
+ * @param <X> The value
  * @author Aliaksei Bialiauski (abialiauski.dev@gmail.com)
  * @since 0.0.0
  */

diff --git a/src/main/java/io/github/eocqrs/kafka/fake/FkConsumer.java b/src/main/java/io/github/eocqrs/kafka/fake/FkConsumer.java
@@ -19,6 +19,9 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+/*
+ * @todo #49:45m/DEV Fake Consumer implementation
+ */
 
 package io.github.eocqrs.kafka.fake;
 
@@ -32,13 +35,11 @@
 /**
  * Fake Consumer.
  *
+ * @param <K> The key
+ * @param <X> The value
  * @author Aliaksei Bialiauski (abialiauski.dev@gmail.com)
  * @since 0.0.0
  */
-
-/**
- * @todo #49:45m/DEV Fake Consumer implementation
- */
 public final class FkConsumer<K, X> implements Consumer<K, X> {
 
   @Override

diff --git a/src/main/java/io/github/eocqrs/kafka/fake/FkProducer.java b/src/main/java/io/github/eocqrs/kafka/fake/FkProducer.java
@@ -19,6 +19,9 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+/*
+ * @todo #10:45m/DEV Fake Producer implementation
+ */
 
 package io.github.eocqrs.kafka.fake;
 
@@ -28,13 +31,11 @@
 /**
  * Fake Producer.
  *
+ * @param <K> The key
+ * @param <X> The value
  * @author Aliaksei Bialiauski (abialiauski.dev@gmail.com)
  * @since 0.0.0
  */
-
-/**
- * @todo #10:45m/DEV Fake Producer implementation
- */
 public final class FkProducer<K, X> implements Producer<K, X> {
 
   @Override

diff --git a/src/main/java/io/github/eocqrs/kafka/parameters/KfFlexible.java b/src/main/java/io/github/eocqrs/kafka/parameters/KfFlexible.java
@@ -32,6 +32,8 @@
 /**
  * KfFlexibleSettings allow you to add custom settings.
  *
+ * @param <K> The key
+ * @param <X> The value
  * @author Ivan Ivanchuk (l3r8y@duck.com)
  * @since 0.0.2
  */

diff --git a/src/main/java/io/github/eocqrs/kafka/parameters/KfFlexibleEnvelope.java b/src/main/java/io/github/eocqrs/kafka/parameters/KfFlexibleEnvelope.java
@@ -32,6 +32,8 @@
 /**
  * Envelope for {@link ConsumerSettings}.
  *
+ * @param <K> The key
+ * @param <X> The value
  * @author Ivan Ivanchuk (l3r8y@duck.com)
  * @since 0.0.2
  */

diff --git a/src/main/java/io/github/eocqrs/kafka/producer/KfProducer.java b/src/main/java/io/github/eocqrs/kafka/producer/KfProducer.java
@@ -30,6 +30,8 @@
 /**
  * Kafka Producer.
  *
+ * @param <K> The key
+ * @param <X> The value
  * @author Aliaksei Bialiauski (abialiauski.dev@gmail.com)
  * @since 0.0.0
  */

diff --git a/src/main/java/io/github/eocqrs/kafka/xml/KfXmlFlexible.java b/src/main/java/io/github/eocqrs/kafka/xml/KfXmlFlexible.java
@@ -30,6 +30,8 @@
 /**
  * Allow creating custom Consumer/Producer from XML.
  *
+ * @param <K> The key
+ * @param <X> The value
  * @author Ivan Ivanchuk (l3r8y@duck.com)
  * @since 0.0.2
  */