Skip to content

Commit 7590d09

Browse files
committed
Correct copy&paste errors
1 parent 2b9ef0a commit 7590d09

File tree

4 files changed

+16
-14
lines changed

4 files changed

+16
-14
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ enum KafkaTopicState {
108108
* <ul>
109109
* <li> Network degradation between HiveMQ and the Kafka cluster
110110
* <li> Insufficient permissions to perform the operation
111-
* <li> An unsuitable configuration in either the HiveMQ Enterprise Extension for Kafka or the Kafka cluster
111+
* <li> An unsuitable configuration in either the "HiveMQ Enterprise Extension for Kafka" or the Kafka cluster
112112
* <li> The internal state of the Kafka cluster
113113
* </ul>
114114
*

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
import com.hivemq.extension.sdk.api.annotations.NotNull;
2222

2323
/**
24-
* This is the base interface for all HiveMQ Enterprise Extension for Kafka transformer.
24+
* This is the base interface for all "HiveMQ Enterprise Extension for Kafka" transformer.
2525
*
2626
* @author Christoph Schäbel
2727
* @author Georg Held

src/main/java/com/hivemq/extensions/kafka/api/transformers/kafkatomqtt/KafkaToMqttInput.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
* The input parameter of the {@link KafkaToMqttTransformer}. It contains the information of the to be transformed
2727
* {@link KafkaRecord}.
2828
* <p>
29-
* The MqttToKafkaInput allows access to the {@link KafkaCluster}.
29+
* Additionally, the KafkaToMqttInput allows access to the {@link KafkaCluster}.
3030
*
3131
* @author Christoph Schäbel
3232
* @author Georg Held
@@ -37,13 +37,13 @@
3737
public interface KafkaToMqttInput {
3838

3939
/**
40-
* @return the {@link KafkaRecord} that triggered this transformer call.
40+
* @return The {@link KafkaRecord} that triggered this transformer call.
4141
* @since 4.5.0
4242
*/
4343
@NotNull KafkaRecord getKafkaRecord();
4444

4545
/**
46-
* @return the {@link KafkaCluster} the transformer is associated with.
46+
* @return The {@link KafkaCluster} the transformer is associated with.
4747
* @since 4.5.0
4848
*/
4949
@NotNull KafkaCluster getKafkaCluster();

src/main/java/com/hivemq/extensions/kafka/api/transformers/kafkatomqtt/KafkaToMqttTransformer.java

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@
2828
* called concurrently and must be thread-safe.
2929
* <p>
3030
* Your implementation of the KafkaToMqttTransformer must be placed in a Java archive (.jar) together with all its
31-
* dependencies in the {@code customizations} folder of the HiveMQ Enterprise Extension for Kafka. In addition a {@code
32-
* <kafka-to-mqtt-transformer>} referencing the implementing class via its canonical name must be configured in the
33-
* {@code kafka-extension.xml} file.
31+
* dependencies in the {@code customizations} folder of the "HiveMQ Enterprise Extension for Kafka". In addition, a
32+
* {@code <kafka-to-mqtt-transformer>} referencing the implementing class via its canonical name must be configured in
33+
* the {@code kafka-extension.xml} file.
3434
*
3535
* @author Christoph Schäbel
3636
* @author Georg Held
@@ -41,19 +41,21 @@
4141
public interface KafkaToMqttTransformer extends Transformer<KafkaToMqttInitInput> {
4242

4343
/**
44-
* This callback is executed for every {@link com.hivemq.extensions.kafka.api.model.KafkaRecord KafkaRecord} that is
45-
* polled by the HiveMQ Enterprise Extension for Kafka and matches the {@code <mqtt-to-kafka-transformer>} tag
46-
* configured in the {@code <mqtt-topic-filters>}. It allows the publication of any number of {@link
44+
* This callback is executed for every {@link com.hivemq.extensions.kafka.api.model.KafkaRecord KafkaRecord} that
45+
* the "HiveMQ Enterprise Extension for Kafka" polls from Kafka according to the configured {@code <kafka-topics>}
46+
* in the {@code <kafka-to-mqtt-transformer>} tag.
47+
* <p>
48+
* It allows the publication of any number of {@link
4749
* com.hivemq.extension.sdk.api.services.publish.Publish Publishes} via the {@link KafkaToMqttOutput} object. This
4850
* method is called by multiple threads concurrently. Extensions are responsible for their own exception handling
4951
* and this method must not throw any {@link Exception}.
5052
*
51-
* @param input the {@link KafkaToMqttInput} contains the triggering
53+
* @param input The {@link KafkaToMqttInput} contains the triggering
5254
* {@link com.hivemq.extensions.kafka.api.model.KafkaRecord
5355
* KafkaRecord} and the {@link com.hivemq.extensions.kafka.api.model.KafkaCluster KafkaCluster}
5456
* information.
55-
* @param output the {@link KafkaToMqttOutput} allows to {@link KafkaToMqttOutput#setPublishes(java.util.List)
56-
* provide a list of Publishes}. If no output is set, a empty List is used as default and the kafka
57+
* @param output The {@link KafkaToMqttOutput} allows to {@link KafkaToMqttOutput#setPublishes(java.util.List)
58+
* provide a list of Publishes}. If no output is set, an empty List is used as default and the kafka
5759
* record will not be processed again, but ignored.
5860
* @since 4.5.0
5961
*/

0 commit comments

Comments
 (0)