More javadoc improvements.

Author: sauroter

README.adoc

@@ -26,5 +26,5 @@ To use the SDK, add the following dependency to your Maven project:
 
 == License
 
-The HiveMQ Extension SDK is licensed under the `APACHE LICENSE, VERSION 2.0`.
+The HiveMQ Kafka Extension SDK is licensed under the `APACHE LICENSE, VERSION 2.0`.
 A copy of the license can be found link:LICENSE[here].

build.gradle.kts

@@ -63,7 +63,6 @@ metadata {
 /* ******************** dependencies ******************** */
 
 repositories {
-    mavenLocal()
     mavenCentral()
 }
 
@@ -130,12 +129,6 @@ bintray {
             gpg.apply {
                 sign = true
             }
-            mavenCentralSync.apply {
-                sync = false
-                user = "${project.findProperty("mavenCentralUser") ?: System.getenv("MAVEN_CENTRAL_USER")}"
-                password = "${project.findProperty("mavenCentralKey") ?: System.getenv("MAVEN_CENTRAL_KEY")}"
-                close = "0"
-            }
         }
     }
 }

src/main/java/com/hivemq/extensions/kafka/api/builders/KafkaRecordBuilder.java

@@ -16,6 +16,7 @@
 
 package com.hivemq.extensions.kafka.api.builders;
 
+import com.hivemq.extension.sdk.api.annotations.DoNotImplement;
 import com.hivemq.extension.sdk.api.annotations.NotNull;
 import com.hivemq.extensions.kafka.api.model.KafkaRecord;
 
@@ -35,6 +36,7 @@
  * @author Georg Held
  * @since 4.4.0
  */
+@DoNotImplement
 public interface KafkaRecordBuilder {
 
     /**
@@ -64,7 +66,7 @@ public interface KafkaRecordBuilder {
      * @return this builder
      * @since 4.4.0
      */
-    @NotNull KafkaRecordBuilder key(@NotNull byte[] key);
+    @NotNull KafkaRecordBuilder key(byte @NotNull [] key);
 
     /**
      * Set the key of the Kafka record.

src/main/java/com/hivemq/extensions/kafka/api/model/KafkaCluster.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package com.hivemq.extensions.kafka.api.model;
 
 import com.hivemq.extension.sdk.api.annotations.DoNotImplement;
@@ -39,6 +40,7 @@ public interface KafkaCluster {
 
     /**
      * @return the configured {@code <bootstrap-servers>} of the cluster.
+     * @since 4.4.0
      */
     @NotNull String getBootstrapServers();
 }

src/main/java/com/hivemq/extensions/kafka/api/services/KafkaTopicService.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package com.hivemq.extensions.kafka.api.services;
 
 import com.hivemq.extension.sdk.api.annotations.DoNotImplement;
@@ -79,7 +80,7 @@ public interface KafkaTopicService {
      * Create multiple Kafka topics on the associated cluster. Use {@link KafkaTopicService#getKafkaTopicStates(Set)} if
      * you would like to check, whether the topics already exists.
      * <p>
-     * * The returned map contains exactly one entry per queried topic in the argument set.
+     * The returned map contains exactly one entry per given topic in the argument set.
      * <p>
      * This method can block the calling transformer.
      *

src/main/java/com/hivemq/extensions/kafka/api/transformers/Transformer.java

@@ -13,24 +13,29 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package com.hivemq.extensions.kafka.api.transformers;
 
 import com.hivemq.extension.sdk.api.annotations.DoNotImplement;
+import com.hivemq.extension.sdk.api.annotations.Immutable;
 import com.hivemq.extension.sdk.api.annotations.NotNull;
 
 /**
  * This is the base interface for all HiveMQ Enterprise Extension for Kafka transformer.
  *
  * @author Christoph Schäbel
  * @author Georg Held
+ * @since 4.4.0
  */
+@Immutable
 @DoNotImplement
 public interface Transformer<I extends TransformerInitInput> {
 
     /**
      * Use the init method to set up static runtime context for the execution of your transformer.
      *
      * @param input see the specific input e.g. {@link com.hivemq.extensions.kafka.api.transformers.mqtttokafka.MqttToKafkaInitInput}.
+     * @since 4.4.0
      */
     default void init(@NotNull I input) {
     }

src/main/java/com/hivemq/extensions/kafka/api/transformers/TransformerInitInput.java

@@ -13,9 +13,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package com.hivemq.extensions.kafka.api.transformers;
 
 import com.hivemq.extension.sdk.api.annotations.DoNotImplement;
+import com.hivemq.extension.sdk.api.annotations.Immutable;
 
 /**
  * A marker interface for the input object of the {@link Transformer#init(TransformerInitInput)} method.
@@ -24,6 +26,7 @@
  * @author Georg Held
  * @since 4.4.0
  */
+@Immutable
 @DoNotImplement
 public interface TransformerInitInput {