Create v3

streams-bootstrap/src/main/java/com/bakdata/kafka/EnvironmentArgumentsParser.java → streams-bootstrap-picocli/src/main/java/com/bakdata/kafka/EnvironmentArgumentsParser.java

@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2023 bakdata
+ * Copyright (c) 2024 bakdata
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

streams-bootstrap/src/test/java/com/bakdata/kafka/EnvironmentArgumentsParserTest.java → streams-bootstrap-picocli/src/test/java/com/bakdata/kafka/EnvironmentArgumentsParserTest.java

@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2023 bakdata
+ * Copyright (c) 2024 bakdata
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

streams-bootstrap/src/main/java/com/bakdata/kafka/ConfiguredProducerApp.java

@@ -97,6 +97,7 @@ private static Map<String, Object> createKafkaProperties(final KafkaEndpointConf
      *     </li>
      * </ul>
      *
+     * @param endpointConfig endpoint to run app on
      * @return Kafka configuration
      */
     public Map<String, Object> getKafkaProperties(final KafkaEndpointConfig endpointConfig) {

streams-bootstrap/src/main/java/com/bakdata/kafka/ConfiguredStreamsApp.java

@@ -108,6 +108,7 @@ private static Map<String, Object> createKafkaProperties(final KafkaEndpointConf
      *     </li>
      * </ul>
      *
+     * @param endpointConfig endpoint to run app on
      * @return Kafka configuration
      */
     public Map<String, Object> getKafkaProperties(final KafkaEndpointConfig endpointConfig) {
@@ -174,11 +175,11 @@ public void close() {
     }
 
     private void setupApp(final Map<String, Object> kafkaProperties) {
-        final StreamsAppSetupConfiguration configuration = StreamsAppSetupConfiguration.builder()
+        final StreamsAppSetupConfiguration setupConfiguration = StreamsAppSetupConfiguration.builder()
                 .kafkaProperties(kafkaProperties)
                 .topics(this.getTopics())
                 .build();
-        this.app.setup(configuration);
+        this.app.setup(setupConfiguration);
     }
 
 }

streams-bootstrap/src/main/java/com/bakdata/kafka/HasTopicHooks.java

@@ -57,6 +57,11 @@ default void deleted(final String topic) {
      */
     @FunctionalInterface
     interface TopicHookFactory {
+        /**
+         * Create a new {@code TopicHook}
+         * @param kafkaConfig Kafka configuration for creating {@code TopicHook}
+         * @return {@code TopicHook}
+         */
         TopicHook create(Map<String, Object> kafkaConfig);
     }
 }

streams-bootstrap/src/main/java/com/bakdata/kafka/ProducerAppSetupConfiguration.java

@@ -32,6 +32,10 @@
 import lombok.NonNull;
 import lombok.Value;
 
+/**
+ * Configuration for setting up a {@link ProducerApp}
+ * @see ProducerApp#setup(ProducerAppSetupConfiguration)
+ */
 @Builder
 @Value
 public class ProducerAppSetupConfiguration {

streams-bootstrap/src/main/java/com/bakdata/kafka/StreamsAppSetupConfiguration.java

@@ -32,6 +32,10 @@
 import lombok.NonNull;
 import lombok.Value;
 
+/**
+ * Configuration for setting up a {@link StreamsApp}
+ * @see StreamsApp#setup(StreamsAppSetupConfiguration)
+ */
 @Builder
 @Value
 public class StreamsAppSetupConfiguration {

streams-bootstrap/src/main/java/com/bakdata/kafka/util/ImprovedAdminClient.java

@@ -52,10 +52,21 @@ public final class ImprovedAdminClient implements Closeable {
     private final SchemaRegistryClient schemaRegistryClient;
     private final @NonNull Duration timeout;
 
+    /**
+     * Create a new admin client with default timeout
+     * @param properties Kafka configuration
+     * @return admin client
+     */
     public static ImprovedAdminClient create(@NonNull final Map<String, Object> properties) {
         return create(properties, ADMIN_TIMEOUT);
     }
 
+    /**
+     * Create a new admin client
+     * @param properties Kafka configuration
+     * @param timeout timeout when performing admin operations
+     * @return admin client
+     */
     public static ImprovedAdminClient create(@NonNull final Map<String, Object> properties,
             @NonNull final Duration timeout) {
         Preconditions.checkNotNull(properties.get(AdminClientConfig.BOOTSTRAP_SERVERS_CONFIG),

streams-bootstrap/src/test/java/com/bakdata/kafka/StreamsExecutionOptionsTest.java

@@ -31,7 +31,7 @@
 import org.apache.kafka.clients.consumer.ConsumerConfig;
 import org.junit.jupiter.api.Test;
 
-public class StreamsExecutionOptionsTest {
+class StreamsExecutionOptionsTest {
 
     @Test
     void shouldLeaveGroup() {