This is an automated email from the ASF dual-hosted git repository. btellier pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/james-project.git
commit b3605f83f60cdc06aa47ccd66e6505fb4f172f18 Author: Benoit Tellier <[email protected]> AuthorDate: Thu Nov 7 11:17:33 2019 +0700 [REFACTORING] Clean protocols-netty javadoc - Solve IntellijJ warnings related to javaDoc - Remove verbose, meaningless entries --- .../james/protocols/netty/AbstractAsyncServer.java | 17 ----------------- .../protocols/netty/AbstractChannelPipelineFactory.java | 6 ++---- .../netty/AbstractSSLAwareChannelPipelineFactory.java | 8 +------- .../protocols/netty/BasicChannelUpstreamHandler.java | 2 -- .../james/protocols/netty/ChannelGroupHandler.java | 1 - .../apache/james/protocols/netty/HandlerConstants.java | 2 -- .../apache/james/protocols/netty/TimeoutHandler.java | 1 - 7 files changed, 3 insertions(+), 34 deletions(-) diff --git a/protocols/netty/src/main/java/org/apache/james/protocols/netty/AbstractAsyncServer.java b/protocols/netty/src/main/java/org/apache/james/protocols/netty/AbstractAsyncServer.java index ef8554d..a7aef3c 100644 --- a/protocols/netty/src/main/java/org/apache/james/protocols/netty/AbstractAsyncServer.java +++ b/protocols/netty/src/main/java/org/apache/james/protocols/netty/AbstractAsyncServer.java @@ -40,7 +40,6 @@ import com.google.common.collect.ImmutableList; /** * Abstract base class for Servers which want to use async io - * */ public abstract class AbstractAsyncServer implements ProtocolServer { @@ -68,8 +67,6 @@ public abstract class AbstractAsyncServer implements ProtocolServer { /** * Set the IO-worker thread count to use. Default is nCores * 2 - * - * @param ioWorker */ public void setIoWorkerCount(int ioWorker) { if (started) { @@ -80,8 +77,6 @@ public abstract class AbstractAsyncServer implements ProtocolServer { /** * Return the IO worker thread count to use - * - * @return ioWorker */ public int getIoWorkerCount() { return ioWorker; @@ -114,8 +109,6 @@ public abstract class AbstractAsyncServer implements ProtocolServer { /** * Configure the bootstrap before it get bound - * - * @param bootstrap */ protected void configureBootstrap(ServerBootstrap bootstrap) { // Bind and start to accept incoming connections. @@ -155,16 +148,12 @@ public abstract class AbstractAsyncServer implements ProtocolServer { /** * Create ChannelPipelineFactory to use by this Server implementation - * - * @return factory */ protected abstract ChannelPipelineFactory createPipelineFactory(ChannelGroup group); /** * Set the read/write timeout for the server. This will throw a {@link IllegalStateException} if the * server is running. - * - * @param timeout */ public void setTimeout(int timeout) { if (started) { @@ -176,8 +165,6 @@ public abstract class AbstractAsyncServer implements ProtocolServer { /** * Set the Backlog for the socket. This will throw a {@link IllegalStateException} if the server is running. - * - * @param backlog */ public void setBacklog(int backlog) { if (started) { @@ -201,8 +188,6 @@ public abstract class AbstractAsyncServer implements ProtocolServer { /** * Create a new {@link Executor} used for dispatch messages to the workers. One Thread will be used per port which is bound. * This can get overridden if needed, by default it use a {@link Executors#newCachedThreadPool()} - * - * @return bossExecutor */ protected Executor createBossExecutor() { ThreadFactory threadFactory = NamedThreadFactory.withClassName(getClass()); @@ -211,8 +196,6 @@ public abstract class AbstractAsyncServer implements ProtocolServer { /** * Create a new {@link Executor} used for workers. This can get overridden if needed, by default it use a {@link Executors#newCachedThreadPool()} - * - * @return workerExecutor */ protected Executor createWorkerExecutor() { ThreadFactory threadFactory = NamedThreadFactory.withClassName(getClass()); diff --git a/protocols/netty/src/main/java/org/apache/james/protocols/netty/AbstractChannelPipelineFactory.java b/protocols/netty/src/main/java/org/apache/james/protocols/netty/AbstractChannelPipelineFactory.java index 67377d8..5f242e7 100644 --- a/protocols/netty/src/main/java/org/apache/james/protocols/netty/AbstractChannelPipelineFactory.java +++ b/protocols/netty/src/main/java/org/apache/james/protocols/netty/AbstractChannelPipelineFactory.java @@ -30,8 +30,6 @@ import org.jboss.netty.util.HashedWheelTimer; /** * Abstract base class for {@link ChannelPipelineFactory} implementations - * - * */ public abstract class AbstractChannelPipelineFactory implements ChannelPipelineFactory { public static final int MAX_LINE_LENGTH = 8192; @@ -94,8 +92,8 @@ public abstract class AbstractChannelPipelineFactory implements ChannelPipelineF /** * Create the core {@link ChannelUpstreamHandler} to use - * - * @return coreHandeler + * + * @return coreHandler */ protected abstract ChannelUpstreamHandler createHandler(); diff --git a/protocols/netty/src/main/java/org/apache/james/protocols/netty/AbstractSSLAwareChannelPipelineFactory.java b/protocols/netty/src/main/java/org/apache/james/protocols/netty/AbstractSSLAwareChannelPipelineFactory.java index 8039dc7..5dee691 100644 --- a/protocols/netty/src/main/java/org/apache/james/protocols/netty/AbstractSSLAwareChannelPipelineFactory.java +++ b/protocols/netty/src/main/java/org/apache/james/protocols/netty/AbstractSSLAwareChannelPipelineFactory.java @@ -28,9 +28,7 @@ import org.jboss.netty.handler.ssl.SslHandler; import org.jboss.netty.util.HashedWheelTimer; /** - * Abstract base class for {@link ChannelPipeline} implementations which use TLS - * - * + * Abstract base class for {@link ChannelPipeline} implementations which use TLS */ public abstract class AbstractSSLAwareChannelPipelineFactory extends AbstractChannelPipelineFactory { @@ -78,15 +76,11 @@ public abstract class AbstractSSLAwareChannelPipelineFactory extends AbstractCha /** * Return if the socket is using SSL/TLS - * - * @return isSSL */ protected abstract boolean isSSLSocket(); /** * Return the SSL context - * - * @return context */ protected abstract SSLContext getSSLContext(); } diff --git a/protocols/netty/src/main/java/org/apache/james/protocols/netty/BasicChannelUpstreamHandler.java b/protocols/netty/src/main/java/org/apache/james/protocols/netty/BasicChannelUpstreamHandler.java index 59b5239..b3246ab 100644 --- a/protocols/netty/src/main/java/org/apache/james/protocols/netty/BasicChannelUpstreamHandler.java +++ b/protocols/netty/src/main/java/org/apache/james/protocols/netty/BasicChannelUpstreamHandler.java @@ -177,8 +177,6 @@ public class BasicChannelUpstreamHandler extends SimpleChannelUpstreamHandler { /** * Cleanup the channel - * - * @param ctx */ protected void cleanup(ChannelHandlerContext ctx) { ProtocolSession session = (ProtocolSession) ctx.getAttachment(); diff --git a/protocols/netty/src/main/java/org/apache/james/protocols/netty/ChannelGroupHandler.java b/protocols/netty/src/main/java/org/apache/james/protocols/netty/ChannelGroupHandler.java index 7c79c55..74d1431 100644 --- a/protocols/netty/src/main/java/org/apache/james/protocols/netty/ChannelGroupHandler.java +++ b/protocols/netty/src/main/java/org/apache/james/protocols/netty/ChannelGroupHandler.java @@ -28,7 +28,6 @@ import org.jboss.netty.channel.group.ChannelGroup; * Add channels to the channel group after the channel was opened. * * This handler is thread-safe and thus can be shared across pipelines - * */ public final class ChannelGroupHandler extends SimpleChannelUpstreamHandler { private final ChannelGroup channels; diff --git a/protocols/netty/src/main/java/org/apache/james/protocols/netty/HandlerConstants.java b/protocols/netty/src/main/java/org/apache/james/protocols/netty/HandlerConstants.java index 04e8974..f9c7b4f 100644 --- a/protocols/netty/src/main/java/org/apache/james/protocols/netty/HandlerConstants.java +++ b/protocols/netty/src/main/java/org/apache/james/protocols/netty/HandlerConstants.java @@ -24,8 +24,6 @@ import org.jboss.netty.channel.ChannelPipeline; /** * Provide the keys under which the {@link ChannelHandler}'s are stored in the * {@link ChannelPipeline} - * - * */ public interface HandlerConstants { diff --git a/protocols/netty/src/main/java/org/apache/james/protocols/netty/TimeoutHandler.java b/protocols/netty/src/main/java/org/apache/james/protocols/netty/TimeoutHandler.java index 99c456b..46c1568 100644 --- a/protocols/netty/src/main/java/org/apache/james/protocols/netty/TimeoutHandler.java +++ b/protocols/netty/src/main/java/org/apache/james/protocols/netty/TimeoutHandler.java @@ -27,7 +27,6 @@ import org.jboss.netty.util.Timer; /** * {@link IdleStateHandler} implementation which disconnect the {@link Channel} after a configured * idle timeout. Be aware that this handle is not thread safe so it can't be shared across pipelines - * */ public class TimeoutHandler extends IdleStateHandler { --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
