Improve deduplication Javadoc

Author: acogoluegnes

src/main/java/com/rabbitmq/stream/Message.java

@@ -1,4 +1,4 @@
-// Copyright (c) 2020-2023 Broadcom. All Rights Reserved.
+// Copyright (c) 2020-2024 Broadcom. All Rights Reserved.
 // The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
 //
 // This software, the RabbitMQ Stream Java client library, is dual-licensed under the
@@ -32,18 +32,26 @@ public interface Message {
   /**
    * Does this message has a publishing ID?
    *
-   * <p>Publishing IDs are used for de-duplication of outbound messages. They are not persisted.
+   * <p>Publishing IDs are used for deduplication of outbound messages. They are not persisted.
    *
    * @return true if the message has a publishing ID, false otherwise
+   * @see ProducerBuilder#name(String)
+   * @see <a
+   *     href="https://rabbitmq.github.io/rabbitmq-stream-java-client/stable/htmlsingle/#outbound-message-deduplication">Deduplication
+   *     documentation</a>
    */
   boolean hasPublishingId();
 
   /**
    * Get the publishing ID for the message.
    *
-   * <p>Publishing IDs are used for de-duplication of outbound messages. They are not persisted.
+   * <p>Publishing IDs are used for deduplication of outbound messages. They are not persisted.
    *
    * @return the publishing ID of the message
+   * @see ProducerBuilder#name(String)
+   * @see <a
+   *     href="https://rabbitmq.github.io/rabbitmq-stream-java-client/stable/htmlsingle/#outbound-message-deduplication">Deduplication
+   *     documentation</a>
    */
   long getPublishingId();
 

src/main/java/com/rabbitmq/stream/MessageBuilder.java

@@ -1,4 +1,4 @@
-// Copyright (c) 2020-2023 Broadcom. All Rights Reserved.
+// Copyright (c) 2020-2024 Broadcom. All Rights Reserved.
 // The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
 //
 // This software, the RabbitMQ Stream Java client library, is dual-licensed under the
@@ -38,12 +38,16 @@ public interface MessageBuilder {
   Message build();
 
   /**
-   * Set the publishing ID (for de-duplication).
+   * Set the publishing ID (for deduplication).
    *
    * <p>This is value is used only for outbound messages and is not persisted.
    *
    * @param publishingId
    * @return this builder instance
+   * @see ProducerBuilder#name(String)
+   * @see <a
+   *     href="https://rabbitmq.github.io/rabbitmq-stream-java-client/stable/htmlsingle/#outbound-message-deduplication">Deduplication
+   *     documentation</a>
    */
   MessageBuilder publishingId(long publishingId);
 

src/main/java/com/rabbitmq/stream/ProducerBuilder.java

@@ -23,12 +23,18 @@
 public interface ProducerBuilder {
 
   /**
-   * The logical name of the producer.
+   * The producer name for deduplication (<b>read the <a
+   * href="https://rabbitmq.github.io/rabbitmq-stream-java-client/stable/htmlsingle/#outbound-message-deduplication">documentation</a>
+   * before use</b>).
    *
-   * <p>Set a value to enable de-duplication.
+   * <p>There must be only one producer instance at the same time using a given name.
    *
    * @param name
    * @return this builder instance
+   * @see MessageBuilder#publishingId(long)
+   * @see <a
+   *     href="https://rabbitmq.github.io/rabbitmq-stream-java-client/stable/htmlsingle/#outbound-message-deduplication">Deduplication
+   *     documentation</a>
    */
   ProducerBuilder name(String name);