More Javadoc

Author: acogoluegnes

src/main/java/com/rabbitmq/client/amqp/AmqpException.java

@@ -32,9 +32,7 @@ public AmqpException(String message, Throwable cause) {
     super(message, cause);
   }
 
-  /**
-   * Exception related to connectivity problems.
-   */
+  /** Exception related to connectivity problems. */
   public static class AmqpConnectionException extends AmqpException {
 
     public AmqpConnectionException(String message, Throwable cause) {
@@ -54,9 +52,7 @@ public AmqpSecurityException(Throwable cause) {
     }
   }
 
-  /**
-   * Exception thrown when an entity (exchange, queue) does not exit.
-   */
+  /** Exception thrown when an entity (exchange, queue) does not exit. */
   public static class AmqpEntityDoesNotExistException extends AmqpException {
 
     public AmqpEntityDoesNotExistException(String message, Throwable cause) {

src/main/java/com/rabbitmq/client/amqp/BackOffDelayPolicy.java

@@ -72,9 +72,7 @@ static BackOffDelayPolicy fixedWithInitialDelay(
     return new FixedWithInitialDelayAndTimeoutBackOffPolicy(initialDelay, delay, timeout);
   }
 
-  /**
-   * Policy with an initial delay for the first attempt, then a fixed delay.
-   */
+  /** Policy with an initial delay for the first attempt, then a fixed delay. */
   final class FixedWithInitialDelayBackOffPolicy implements BackOffDelayPolicy {
 
     private final Duration initialDelay;
@@ -101,9 +99,7 @@ public String toString() {
     }
   }
 
-  /**
-   * Policy with an initial delay for the first attempt, then a fixed delay, and a timeout.
-   */
+  /** Policy with an initial delay for the first attempt, then a fixed delay, and a timeout. */
   final class FixedWithInitialDelayAndTimeoutBackOffPolicy implements BackOffDelayPolicy {
 
     private final int attemptLimitBeforeTimeout;

src/main/java/com/rabbitmq/client/amqp/metrics/MetricsCollector.java

@@ -17,37 +17,68 @@
 // info@rabbitmq.com.
 package com.rabbitmq.client.amqp.metrics;
 
+/** Interface to collect execution data of the client. */
 public interface MetricsCollector {
 
+  /** Called when a new {@link com.rabbitmq.client.amqp.Connection} is opened. */
   void openConnection();
 
+  /** Called when a {@link com.rabbitmq.client.amqp.Connection} is closed. */
   void closeConnection();
 
+  /** Called when a new {@link com.rabbitmq.client.amqp.Publisher} is opened. */
   void openPublisher();
 
+  /** Called when a {@link com.rabbitmq.client.amqp.Publisher} is closed. */
   void closePublisher();
 
+  /** Called when a new {@link com.rabbitmq.client.amqp.Consumer} is opened. */
   void openConsumer();
 
+  /** Called when a {@link com.rabbitmq.client.amqp.Consumer} is closed. */
   void closeConsumer();
 
+  /** Called when a {@link com.rabbitmq.client.amqp.Message} is published. */
   void publish();
 
+  /**
+   * Called when a {@link com.rabbitmq.client.amqp.Message} is settled by the broker.
+   *
+   * @param disposition disposition (outcome)
+   */
   void publishDisposition(PublishDisposition disposition);
 
+  /**
+   * Called when a {@link com.rabbitmq.client.amqp.Message} is dispatched to a {@link
+   * com.rabbitmq.client.amqp.Consumer}.
+   */
   void consume();
 
+  /**
+   * Called when a {@link com.rabbitmq.client.amqp.Message} is settled by a {@link
+   * com.rabbitmq.client.amqp.Consumer}.
+   *
+   * @param disposition
+   */
   void consumeDisposition(ConsumeDisposition disposition);
 
+  /** The broker-to-client dispositions. */
   enum PublishDisposition {
+    /** see {@link com.rabbitmq.client.amqp.Publisher.Status#ACCEPTED} */
     ACCEPTED,
+    /** see {@link com.rabbitmq.client.amqp.Publisher.Status#REJECTED} */
     REJECTED,
+    /** see {@link com.rabbitmq.client.amqp.Publisher.Status#RELEASED} */
     RELEASED
   }
 
+  /** The client-to-broker dispositions. */
   enum ConsumeDisposition {
+    /** see {@link com.rabbitmq.client.amqp.Consumer.Context#accept()} */
     ACCEPTED,
+    /** see {@link com.rabbitmq.client.amqp.Consumer.Context#discard()} */
     DISCARDED,
+    /** see {@link com.rabbitmq.client.amqp.Consumer.Context#requeue()} */
     REQUEUED
   }
 }

src/main/java/com/rabbitmq/client/amqp/metrics/MicrometerMetricsCollector.java

@@ -24,6 +24,9 @@
 import java.util.Collections;
 import java.util.concurrent.atomic.AtomicLong;
 
+/**
+ * {@link MetricsCollector} implementation using <a href="https://micrometer.io/">Micrometer</a>.
+ */
 public class MicrometerMetricsCollector implements MetricsCollector {
 
   private final AtomicLong connections;

src/main/java/com/rabbitmq/client/amqp/metrics/NoOpMetricsCollector.java

@@ -17,6 +17,7 @@
 // info@rabbitmq.com.
 package com.rabbitmq.client.amqp.metrics;
 
+/** No-operation implementation of {@link MetricsCollector}. */
 public final class NoOpMetricsCollector implements MetricsCollector {
 
   public static final MetricsCollector INSTANCE = new NoOpMetricsCollector();

src/main/java/com/rabbitmq/client/amqp/observation/micrometer/AmqpObservationDocumentation.java

@@ -22,6 +22,7 @@
 import io.micrometer.observation.ObservationConvention;
 import io.micrometer.observation.docs.ObservationDocumentation;
 
+/** To generate documentation. */
 public enum AmqpObservationDocumentation implements ObservationDocumentation {
   /** Observation for publishing a message. */
   PUBLISH_OBSERVATION {

src/main/java/com/rabbitmq/client/amqp/observation/micrometer/DefaultProcessObservationConvention.java

@@ -20,6 +20,7 @@
 import io.micrometer.common.KeyValues;
 import io.micrometer.common.util.StringUtils;
 
+/** Default {@link io.micrometer.observation.ObservationConvention} for processing (consuming). */
 public class DefaultProcessObservationConvention implements DeliverObservationConvention {
 
   private static final String OPERATION = "process";

src/main/java/com/rabbitmq/client/amqp/observation/micrometer/DefaultPublishObservationConvention.java

@@ -20,6 +20,7 @@
 import io.micrometer.common.KeyValues;
 import io.micrometer.common.util.StringUtils;
 
+/** Default {@link io.micrometer.observation.ObservationConvention} for publishing. */
 public class DefaultPublishObservationConvention implements PublishObservationConvention {
 
   private static final String OPERATION = "publish";

src/main/java/com/rabbitmq/client/amqp/observation/micrometer/DeliverContext.java

@@ -20,6 +20,7 @@
 import com.rabbitmq.client.amqp.Message;
 import io.micrometer.observation.transport.ReceiverContext;
 
+/** Delivery context. */
 public class DeliverContext extends ReceiverContext<Message> {
 
   private final String exchange;

src/main/java/com/rabbitmq/client/amqp/observation/micrometer/DeliverObservationConvention.java

@@ -20,6 +20,7 @@
 import io.micrometer.observation.Observation;
 import io.micrometer.observation.ObservationConvention;
 
+/** Contract for delivery (processing/consuming) {@link ObservationConvention}. */
 public interface DeliverObservationConvention extends ObservationConvention<DeliverContext> {
 
   @Override