Start writing Javadoc

Author: acogoluegnes

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

@@ -19,7 +19,14 @@
 
 import java.util.List;
 
+/** Contract to pick an {@link Address} to connect to a cluster node. */
 public interface AddressSelector {
 
+  /**
+   * Pick an address from a list.
+   *
+   * @param addresses list of addresses
+   * @return the address to connect to
+   */
   Address select(List<Address> addresses);
 }

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

@@ -19,18 +19,45 @@
 
 import java.io.Closeable;
 
+/** A connection to the broker. */
 public interface Connection extends Closeable, Resource {
 
+  /**
+   * The {@link Management} instance of this connection.
+   *
+   * @return management instance
+   */
   Management management();
 
+  /**
+   * Create a builder to configure and create a {@link Publisher}.
+   *
+   * @return publisher builder
+   */
   PublisherBuilder publisherBuilder();
 
+  /**
+   * Create a builder to configure and create a {@link Consumer}.
+   *
+   * @return consumer builder
+   */
   ConsumerBuilder consumerBuilder();
 
+  /**
+   * Create a builder to configure and create a {@link RpcClientBuilder}.
+   *
+   * @return RPC client builder
+   */
   RpcClientBuilder rpcClientBuilder();
 
+  /**
+   * Create a builder to configure and create a {@link RpcServerBuilder}.
+   *
+   * @return RPC server builder
+   */
   RpcServerBuilder rpcServerBuilder();
 
+  /** Close the connection and its resources */
   @Override
   void close();
 }

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

@@ -17,22 +17,70 @@
 // info@rabbitmq.com.
 package com.rabbitmq.client.amqp;
 
+/** Builder for {@link Connection} instances. */
 public interface ConnectionBuilder extends ConnectionSettings<ConnectionBuilder> {
 
+  /**
+   * Configuration for recovery.
+   *
+   * @return recovery configuration
+   */
   RecoveryConfiguration recovery();
 
+  /**
+   * Add {@link com.rabbitmq.client.amqp.Resource.StateListener}s to the connection.
+   *
+   * @param listeners
+   * @return this builder instance
+   */
   ConnectionBuilder listeners(Resource.StateListener... listeners);
 
+  /**
+   * Create the connection instance.
+   *
+   * @return the configured connection
+   */
   Connection build();
 
+  /** Configuration for recovery. */
   interface RecoveryConfiguration {
 
+    /**
+     * Whether to activate recovery or not.
+     *
+     * <p>Activated by default.
+     *
+     * @param activated activation flag
+     * @return the configuration instance
+     */
     RecoveryConfiguration activated(boolean activated);
 
+    /**
+     * Delay policy for connection attempts.
+     *
+     * @param backOffDelayPolicy back-off delay policy
+     * @return the configuration instance
+     */
     RecoveryConfiguration backOffDelayPolicy(BackOffDelayPolicy backOffDelayPolicy);
 
+    /**
+     * Whether to activate topology recovery or not.
+     *
+     * <p>Topology recovery includes recovery of exchanges, queues, bindings, publishers, and
+     * consumers.
+     *
+     * <p>Activated by default.
+     *
+     * @param activated activation flag
+     * @return the configuration instance
+     */
     RecoveryConfiguration topology(boolean activated);
 
+    /**
+     * The connection builder.
+     *
+     * @return connection builder
+     */
     ConnectionBuilder connectionBuilder();
   }
 }