Polish

References #380

(cherry picked from commit dcf1f5c)

Author: acogoluegnes

src/main/java/com/rabbitmq/client/impl/nio/NioParams.java

@@ -20,44 +20,67 @@
 import com.rabbitmq.client.SslEngineConfigurator;
 
 import javax.net.ssl.SSLEngine;
-import java.io.IOException;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.ThreadFactory;
 
 /**
  * Parameters used to configure the NIO mode of a {@link com.rabbitmq.client.ConnectionFactory}.
+ *
  * @since 4.0.0
  */
 public class NioParams {
 
-    /** size of the byte buffer used for inbound data */
+    /**
+     * size of the byte buffer used for inbound data
+     */
     private int readByteBufferSize = 32768;
 
-    /** size of the byte buffer used for outbound data */
+    /**
+     * size of the byte buffer used for outbound data
+     */
     private int writeByteBufferSize = 32768;
 
-    /** the max number of IO threads */
+    /**
+     * the max number of IO threads
+     */
     private int nbIoThreads = 1;
 
-    /** the timeout to enqueue outbound frames */
+    /**
+     * the timeout to enqueue outbound frames
+     */
     private int writeEnqueuingTimeoutInMs = 10 * 1000;
 
-    /** the capacity of the queue used for outbound frames */
+    /**
+     * the capacity of the queue used for outbound frames
+     */
     private int writeQueueCapacity = 10000;
 
-    /** the executor service used for IO threads and connections shutdown */
+    /**
+     * the executor service used for IO threads and connections shutdown
+     */
     private ExecutorService nioExecutor;
 
-    /** the thread factory used for IO threads and connections shutdown */
+    /**
+     * the thread factory used for IO threads and connections shutdown
+     */
     private ThreadFactory threadFactory;
 
-    /** the hook to configure the socket channel before it's open */
+    /**
+     * the hook to configure the socket channel before it's open
+     */
     private SocketChannelConfigurator socketChannelConfigurator = new DefaultSocketChannelConfigurator();
 
-    /** the hook to configure the SSL engine before the connection is open */
-    private SslEngineConfigurator sslEngineConfigurator = sslEngine -> { };
+    /**
+     * the hook to configure the SSL engine before the connection is open
+     */
+    private SslEngineConfigurator sslEngineConfigurator = sslEngine -> {
+    };
 
-    /** the executor service used for connection shutdown */
+    /**
+     * the executor service used for connection shutdown
+     *
+     * @since 5.4.0
+     */
     private ExecutorService connectionShutdownExecutor;
 
     public NioParams() {
@@ -82,7 +105,7 @@ public int getReadByteBufferSize() {
     /**
      * Sets the size in byte of the read {@link java.nio.ByteBuffer} used in the NIO loop.
      * Default is 32768.
-     *
+     * <p>
      * This parameter isn't used when using SSL/TLS, where {@link java.nio.ByteBuffer}
      * size is set up according to the {@link javax.net.ssl.SSLSession} packet size.
      *
@@ -104,7 +127,7 @@ public int getWriteByteBufferSize() {
     /**
      * Sets the size in byte of the write {@link java.nio.ByteBuffer} used in the NIO loop.
      * Default is 32768.
-     *
+     * <p>
      * This parameter isn't used when using SSL/TLS, where {@link java.nio.ByteBuffer}
      * size is set up according to the {@link javax.net.ssl.SSLSession} packet size.
      *
@@ -131,7 +154,7 @@ public int getNbIoThreads() {
      * 10 connections have been created).
      * Once a connection is created, it's assigned to a thread/task and
      * all its IO activity is handled by this thread/task.
-     *
+     * <p>
      * When idle for a few seconds (i.e. without any connection to perform IO for),
      * a thread/task stops and is recreated if necessary.
      *
@@ -155,14 +178,14 @@ public int getWriteEnqueuingTimeoutInMs() {
      * Every requests to the server is divided into frames
      * that are then queued in a {@link java.util.concurrent.BlockingQueue} before
      * being sent on the network by a IO thread.
-     *
+     * <p>
      * If the IO thread cannot cope with the frames dispatch, the
      * {@link java.util.concurrent.BlockingQueue} gets filled up and blocks
      * (blocking the calling thread by the same occasion). This timeout is the
      * time the {@link java.util.concurrent.BlockingQueue} will wait before
      * rejecting the outbound frame. The calling thread will then received
      * an exception.
-     *
+     * <p>
      * The appropriate value depends on the application scenarios:
      * rate of outbound data (published messages, acknowledgment, etc), network speed...
      *
@@ -182,17 +205,17 @@ public ExecutorService getNioExecutor() {
     /**
      * Sets the {@link ExecutorService} to use for NIO threads/tasks.
      * Default is to use the thread factory.
-     *
+     * <p>
      * The {@link ExecutorService} should be able to run the
      * number of requested IO threads, plus a few more, as it's also
      * used to dispatch the shutdown of connections.
-     *
+     * <p>
      * Connection shutdown can also be handled by a dedicated {@link ExecutorService},
      * see {@link #setConnectionShutdownExecutor(ExecutorService)}.
-     *
+     * <p>
      * It's developer's responsibility to shut down the executor
      * when it is no longer needed.
-     *
+     * <p>
      * The thread factory isn't used if an executor service is set up.
      *
      * @param nioExecutor {@link ExecutorService} used for IO threads and connection shutdown
@@ -214,7 +237,7 @@ public ThreadFactory getThreadFactory() {
      * Sets the {@link ThreadFactory} to use for NIO threads/tasks.
      * Default is to use the {@link com.rabbitmq.client.ConnectionFactory}'s
      * {@link ThreadFactory}.
-     *
+     * <p>
      * The {@link ThreadFactory} is used to spawn the IO threads
      * and dispatch the shutdown of connections.
      *
@@ -248,6 +271,10 @@ public NioParams setWriteQueueCapacity(int writeQueueCapacity) {
         return this;
     }
 
+    public SocketChannelConfigurator getSocketChannelConfigurator() {
+        return socketChannelConfigurator;
+    }
+
     /**
      * Set the {@link java.nio.channels.SocketChannel} configurator.
      * This gets a chance to "configure" a socket channel
@@ -260,8 +287,8 @@ public void setSocketChannelConfigurator(SocketChannelConfigurator configurator)
         this.socketChannelConfigurator = configurator;
     }
 
-    public SocketChannelConfigurator getSocketChannelConfigurator() {
-        return socketChannelConfigurator;
+    public SslEngineConfigurator getSslEngineConfigurator() {
+        return sslEngineConfigurator;
     }
 
     /**
@@ -277,8 +304,8 @@ public void setSslEngineConfigurator(SslEngineConfigurator configurator) {
         this.sslEngineConfigurator = configurator;
     }
 
-    public SslEngineConfigurator getSslEngineConfigurator() {
-        return sslEngineConfigurator;
+    public ExecutorService getConnectionShutdownExecutor() {
+        return connectionShutdownExecutor;
     }
 
     /**
@@ -303,13 +330,10 @@ public SslEngineConfigurator getSslEngineConfigurator() {
      * @param connectionShutdownExecutor the executor service to use
      * @return this {@link NioParams} instance
      * @see NioParams#setNioExecutor(ExecutorService)
+     * @since 5.4.0
      */
     public NioParams setConnectionShutdownExecutor(ExecutorService connectionShutdownExecutor) {
         this.connectionShutdownExecutor = connectionShutdownExecutor;
         return this;
     }
-
-    public ExecutorService getConnectionShutdownExecutor() {
-        return connectionShutdownExecutor;
-    }
 }