You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by bt...@apache.org on 2019/11/08 03:12:12 UTC
[james-project] 25/36: [REFACTORING] Clean protocols-api javadoc
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 bad42893a6ec3e001fa1dda68835e97c4ead0a2a
Author: Benoit Tellier <bt...@linagora.com>
AuthorDate: Thu Nov 7 11:12:15 2019 +0700
[REFACTORING] Clean protocols-api javadoc
- Solve IntellijJ warnings related to javaDoc
- Remove verbose, meaningless entries
---
.../protocols/api/AbstractProtocolTransport.java | 2 --
.../james/protocols/api/AbstractResponse.java | 4 ----
.../apache/james/protocols/api/BaseRequest.java | 1 -
.../james/protocols/api/CombinedInputStream.java | 2 --
.../org/apache/james/protocols/api/Encryption.java | 9 ++------
.../org/apache/james/protocols/api/Protocol.java | 9 ++------
.../james/protocols/api/ProtocolConfiguration.java | 4 ----
.../protocols/api/ProtocolConfigurationImpl.java | 2 --
.../apache/james/protocols/api/ProtocolImpl.java | 3 +--
.../apache/james/protocols/api/ProtocolServer.java | 8 +-------
.../james/protocols/api/ProtocolSession.java | 17 +--------------
.../james/protocols/api/ProtocolSessionImpl.java | 2 --
.../james/protocols/api/ProtocolTransport.java | 24 +---------------------
.../org/apache/james/protocols/api/Request.java | 6 ------
.../org/apache/james/protocols/api/Response.java | 2 --
.../james/protocols/api/StartTlsResponse.java | 1 -
.../apache/james/protocols/api/StreamResponse.java | 4 ----
.../api/handler/AbstractProtocolHandlerChain.java | 2 --
.../protocols/api/handler/CommandDispatcher.java | 5 -----
.../api/handler/CommandHandlerResultLogger.java | 2 --
.../protocols/api/handler/ConnectHandler.java | 3 ---
.../protocols/api/handler/DisconnectHandler.java | 2 --
.../protocols/api/handler/ExtensibleHandler.java | 3 +--
.../james/protocols/api/handler/LineHandler.java | 2 +-
.../protocols/api/handler/MultiLineHandler.java | 8 +-------
.../protocols/api/handler/ProtocolHandler.java | 4 ----
.../api/handler/ProtocolHandlerChain.java | 2 --
.../api/handler/ProtocolHandlerChainImpl.java | 2 --
.../api/handler/ProtocolHandlerResultHandler.java | 8 +-------
.../api/handler/UnknownCommandHandler.java | 3 ---
.../protocols/api/handler/WiringException.java | 13 ------------
31 files changed, 12 insertions(+), 147 deletions(-)
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/AbstractProtocolTransport.java b/protocols/api/src/main/java/org/apache/james/protocols/api/AbstractProtocolTransport.java
index b578d51..d3f814b 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/AbstractProtocolTransport.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/AbstractProtocolTransport.java
@@ -64,8 +64,6 @@ public abstract class AbstractProtocolTransport implements ProtocolTransport {
/**
* Take the {@link Response} and encode it to a <code>byte</code> array
- *
- * @param response
* @return bytes
*/
protected static byte[] toBytes(Response response) {
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/AbstractResponse.java b/protocols/api/src/main/java/org/apache/james/protocols/api/AbstractResponse.java
index 9135d20..921100a 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/AbstractResponse.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/AbstractResponse.java
@@ -24,8 +24,6 @@ import java.util.List;
/**
* Abstract base implementation of {@link Response}
- *
- *
*/
public abstract class AbstractResponse implements Response {
@@ -94,8 +92,6 @@ public abstract class AbstractResponse implements Response {
/**
* Set to true to end the session
- *
- * @param endSession
*/
public void setEndSession(boolean endSession) {
this.endSession = endSession;
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/BaseRequest.java b/protocols/api/src/main/java/org/apache/james/protocols/api/BaseRequest.java
index 8b1ed75..8f405d6 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/BaseRequest.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/BaseRequest.java
@@ -21,7 +21,6 @@ package org.apache.james.protocols.api;
/**
* Basic Request which contains a command and argument
- *
*/
public class BaseRequest implements Request {
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/CombinedInputStream.java b/protocols/api/src/main/java/org/apache/james/protocols/api/CombinedInputStream.java
index a01f291..d0f4924 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/CombinedInputStream.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/CombinedInputStream.java
@@ -28,8 +28,6 @@ import java.util.NoSuchElementException;
* {@link SequenceInputStream} sub-class which allows direct access to the pair of {@link InputStream}'s.
*
* When ever you need to "combine" two {@link InputStream}'s you should use this class as it may allow the Transport to optimize the transfer of it!
- *
- *
*/
public class CombinedInputStream extends SequenceInputStream implements Iterable<InputStream> {
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/Encryption.java b/protocols/api/src/main/java/org/apache/james/protocols/api/Encryption.java
index 0955670..8b0ed11 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/Encryption.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/Encryption.java
@@ -23,7 +23,6 @@ import javax.net.ssl.SSLContext;
/**
* This class should be used to setup encrypted protocol handling
- *
*/
public final class Encryption {
@@ -44,11 +43,9 @@ public final class Encryption {
/**
* Create a new {@link Encryption} which is TLS based and only allows the
* given Ciphersuites
- *
- * @param context
+ *
* @param enabledCipherSuites
* or <code>null</code> if all Ciphersuites should be allowed
- * @return enc
*/
public static Encryption createTls(SSLContext context, String[] enabledCipherSuites) {
return new Encryption(context, false, enabledCipherSuites);
@@ -61,11 +58,9 @@ public final class Encryption {
/**
* Create a new {@link Encryption} which uses STARTTLS and only allows the
* given Ciphersuites
- *
- * @param context
+ *
* @param enabledCipherSuites
* or <code>null</code> if all Ciphersuites should be allowed
- * @return enc
*/
public static Encryption createStartTls(SSLContext context, String[] enabledCipherSuites) {
return new Encryption(context, true, enabledCipherSuites);
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/Protocol.java b/protocols/api/src/main/java/org/apache/james/protocols/api/Protocol.java
index f4b74f3..e791284 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/Protocol.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/Protocol.java
@@ -34,18 +34,13 @@ public interface Protocol {
ProtocolHandlerChain getProtocolChain();
/**
- * Return the {@link ProtocolConfiguration}
- *
- * @return config
+ * Return the {@link ProtocolConfiguration}
*/
ProtocolConfiguration getConfiguration();
/**
- * Create a new {@link ProtocolSession} for the given {@link ProtocolTransport}
- *
- * @param transport
- * @return session
+ * Create a new {@link ProtocolSession} for the given {@link ProtocolTransport}
*/
ProtocolSession newSession(ProtocolTransport transport);
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolConfiguration.java b/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolConfiguration.java
index 42217b9..e982ee8 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolConfiguration.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolConfiguration.java
@@ -21,12 +21,8 @@ package org.apache.james.protocols.api;
/**
* Configuration which is used in scope of a Protocol
- *
- *
*/
public interface ProtocolConfiguration {
-
-
/**
* Return the Greeting which should used.
*
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolConfigurationImpl.java b/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolConfigurationImpl.java
index 9cbf4cb..5482920 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolConfigurationImpl.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolConfigurationImpl.java
@@ -27,8 +27,6 @@ import java.net.UnknownHostException;
* Default implementation of a {@link ProtocolConfiguration} which allows to easily set the different configurations.
*
* Be aware that set and get operations are not thread-safe
- *
- *
*/
public class ProtocolConfigurationImpl implements ProtocolConfiguration {
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolImpl.java b/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolImpl.java
index 962019e..e7a743a 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolImpl.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolImpl.java
@@ -22,8 +22,7 @@ package org.apache.james.protocols.api;
import org.apache.james.protocols.api.handler.ProtocolHandlerChain;
/**
- * Basic {@link Protocol} implementation
- *
+ * Basic {@link Protocol} implementation
*/
public abstract class ProtocolImpl implements Protocol {
private final ProtocolHandlerChain chain;
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolServer.java b/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolServer.java
index edf47ef..f48c51a 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolServer.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolServer.java
@@ -23,15 +23,11 @@ import java.util.List;
/**
* A {@link ProtocolServer} accept inbound traffic and handle it. Basically the protocols API can be used to handle every "line based" protocol in an easy fashion
- *
*/
public interface ProtocolServer {
/**
* Start the server
- *
- * @throws Exception
- *
*/
void bind() throws Exception;
@@ -41,9 +37,7 @@ public interface ProtocolServer {
void unbind();
/**
- * return true if the server is bound
- *
- * @return bound
+ * return true if the server is bound
*/
boolean isBound();
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolSession.java b/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolSession.java
index bc48249..fbcb830 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolSession.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolSession.java
@@ -27,8 +27,6 @@ import org.apache.james.protocols.api.handler.LineHandler;
/**
* Session for a protocol. Every new connection generates a new session
- *
- *
*/
public interface ProtocolSession {
@@ -85,22 +83,16 @@ public interface ProtocolSession {
/**
* Return the {@link InetSocketAddress} of the remote peer
- *
- * @return address
*/
InetSocketAddress getRemoteAddress();
/**
* Return the {@link InetSocketAddress} of the local bound address
- *
- * @return local
*/
InetSocketAddress getLocalAddress();
/**
* Return the ID for the session
- *
- * @return id
*/
String getSessionID();
@@ -142,22 +134,16 @@ public interface ProtocolSession {
/**
* Return true if the starttls was started
- *
- * @return true
*/
boolean isTLSStarted();
/**
- * Return the {@link ProtocolConfiguration}
- *
- * @return config
+ * Return the {@link ProtocolConfiguration}
*/
ProtocolConfiguration getConfiguration();
/**
* Return the {@link Charset} which is used by the {@link ProtocolSession}
- *
- * @return charset
*/
Charset getCharset();
@@ -170,7 +156,6 @@ public interface ProtocolSession {
/**
* Put a new line handler in the chain
- * @param overrideCommandHandler
*/
<T extends ProtocolSession> void pushLineHandler(LineHandler<T> overrideCommandHandler);
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolSessionImpl.java b/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolSessionImpl.java
index 5aec3ee..8f32966 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolSessionImpl.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolSessionImpl.java
@@ -69,8 +69,6 @@ public class ProtocolSessionImpl implements ProtocolSession {
/**
* Return the wrapped {@link ProtocolTransport} which is used for this {@link ProtocolSession}
- *
- * @return transport
*/
public ProtocolTransport getProtocolTransport() {
return transport;
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolTransport.java b/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolTransport.java
index d65ccb2..add23e8 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolTransport.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/ProtocolTransport.java
@@ -33,15 +33,11 @@ public interface ProtocolTransport {
/**
* Return the {@link InetSocketAddress} of the remote peer
- *
- * @return address
*/
InetSocketAddress getRemoteAddress();
/**
* Return the {@link InetSocketAddress} of the local bound address
- *
- * @return local
*/
InetSocketAddress getLocalAddress();
@@ -49,31 +45,22 @@ public interface ProtocolTransport {
/**
* Return the unique id. The id MUST NOT be 100 % unique for ever. It just should just not have the same
* id when having concurrent connections
- *
- * @return id
*/
String getId();
/**
* Return <code>true</code> if <code>TLS</code> encryption is active
- *
- * @return tlsStarted
*/
boolean isTLSStarted();
/**
* Return <code>true</code> if <code>STARTTLS</code> is supported by this {@link ProtocolTransport}
- *
- * @return tlsSupprted
*/
boolean isStartTLSSupported();
/**
* Write the {@link Response} to the {@link ProtocolTransport} which will forward it to the connected
* peer
- *
- * @param response
- * @param session
*/
void writeResponse(Response response, ProtocolSession session);
@@ -84,31 +71,22 @@ public interface ProtocolTransport {
/**
* Push a {@link LineHandler} in.
- *
- * @param overrideCommandHandler
- * @param session
*/
void pushLineHandler(LineHandler<? extends ProtocolSession> overrideCommandHandler, ProtocolSession session);
/**
* Return the count of pushed {@link LineHandler}'s
- *
- * @return lineCount
*/
int getPushedLineHandlerCount();
/**
- * Set the {@link ProtocolTransport} readable or not. If its not readable then no new lines should get processed
- *
- * @param readable
+ * Set the {@link ProtocolTransport} readable or not. If its not readable then no new lines should get processed
*/
void setReadable(boolean readable);
/**
* Return <code>true</code> if the channel is readable
- *
- * @return
*/
boolean isReadable();
}
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/Request.java b/protocols/api/src/main/java/org/apache/james/protocols/api/Request.java
index 81747fe..01573b6 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/Request.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/Request.java
@@ -21,23 +21,17 @@ package org.apache.james.protocols.api;
/**
* Request received from the client
- *
- *
*/
public interface Request {
/**
* Return the current argument. If there is no argument null is returned
- *
- * @return argument
*/
String getArgument();
/**
* Return the current command
- *
- * @return command
*/
String getCommand();
}
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/Response.java b/protocols/api/src/main/java/org/apache/james/protocols/api/Response.java
index d5f5586..7c25bef 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/Response.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/Response.java
@@ -24,8 +24,6 @@ import java.util.List;
/**
* Protocol response to send to the client
- *
- *
*/
public interface Response {
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/StartTlsResponse.java b/protocols/api/src/main/java/org/apache/james/protocols/api/StartTlsResponse.java
index f36fda6..eca0f00 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/StartTlsResponse.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/StartTlsResponse.java
@@ -23,7 +23,6 @@ package org.apache.james.protocols.api;
* An special sub-type of {@link Response} which makes it possible to detect a response to a STARTTLS request.
*
* After writing this response its a MUST to enable STARTTLS before further processing
- *
*/
public interface StartTlsResponse extends Response {
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/StreamResponse.java b/protocols/api/src/main/java/org/apache/james/protocols/api/StreamResponse.java
index 2b621c0..de94944 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/StreamResponse.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/StreamResponse.java
@@ -23,16 +23,12 @@ import java.io.InputStream;
/**
* Special {@link Response} sub-type which allows to write an {@link InputStream} to the remote peer
- *
- *
*/
public interface StreamResponse extends Response {
/**
* Return the stream which needs to get written to the remote peer. This method should only be called one time (when the data is written to the client) as it returns
* the same {@link InputStream} on every call. So once it is consumed there is no way to re-process it.
- *
- * @return stream
*/
InputStream getStream();
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/AbstractProtocolHandlerChain.java b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/AbstractProtocolHandlerChain.java
index 0b1803f..3abc754 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/AbstractProtocolHandlerChain.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/AbstractProtocolHandlerChain.java
@@ -50,8 +50,6 @@ public abstract class AbstractProtocolHandlerChain implements ProtocolHandlerCha
/**
* ExtensibleHandler wiring. This should get called after the class was constructed
* and every stuff was set
- *
- * @throws WiringException
*/
public void wireExtensibleHandlers() throws WiringException {
List<ProtocolHandler> handlers = getHandlers();
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/CommandDispatcher.java b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/CommandDispatcher.java
index 90bd4a0..bd03ee4 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/CommandDispatcher.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/CommandDispatcher.java
@@ -150,9 +150,6 @@ public class CommandDispatcher<SessionT extends ProtocolSession> implements Exte
/**
* Dispatch the {@link CommandHandler}'s for the given {@link Request} and return a {@link Response} or <code>null</code> if non should get written
* back to the client
- *
- * @param session
- * @param request
* @return response
*/
protected Response dispatchCommandHandlers(SessionT session, Request request) {
@@ -191,8 +188,6 @@ public class CommandDispatcher<SessionT extends ProtocolSession> implements Exte
/**
* Parse the line into a {@link Request}
- *
- * @throws Exception
*/
protected Request parseRequest(SessionT session, ByteBuffer buffer) throws Exception {
String curCommandName;
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/CommandHandlerResultLogger.java b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/CommandHandlerResultLogger.java
index 06cdac4..dd33bc9 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/CommandHandlerResultLogger.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/CommandHandlerResultLogger.java
@@ -24,9 +24,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- *
* {@link ProtocolHandlerResultHandler} which logs the {@link Response} of {@link CommandHandler}'s.
- *
*/
public class CommandHandlerResultLogger implements ProtocolHandlerResultHandler<Response, ProtocolSession> {
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ConnectHandler.java b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ConnectHandler.java
index e310d71..0ee6767 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ConnectHandler.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ConnectHandler.java
@@ -33,10 +33,7 @@ import org.apache.james.protocols.api.Response;
public interface ConnectHandler<SessionT extends ProtocolSession> extends ProtocolHandler {
/**
* Handle connection and disconnect if true is returned
- *
- * @param session
* @return response or null
- *
**/
Response onConnect(SessionT session);
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/DisconnectHandler.java b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/DisconnectHandler.java
index 4690b81..2efd235 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/DisconnectHandler.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/DisconnectHandler.java
@@ -33,8 +33,6 @@ public interface DisconnectHandler<S extends ProtocolSession> extends ProtocolHa
/**
* Get called on disconnect
- *
- * @param session
**/
void onDisconnect(S session);
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ExtensibleHandler.java b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ExtensibleHandler.java
index 238f75b..866254e 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ExtensibleHandler.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ExtensibleHandler.java
@@ -39,8 +39,7 @@ public interface ExtensibleHandler {
/**
* Method called during initialization after all the handlers have been declared
* in the ProtocolHandlerChain.
- *
- * @param interfaceName
+ *
* @param extension a list of objects implementing the marker interface
*/
void wireExtensions(Class<?> interfaceName, List<?> extension) throws WiringException;
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/LineHandler.java b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/LineHandler.java
index 5449271..f140f2b 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/LineHandler.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/LineHandler.java
@@ -35,7 +35,7 @@ public interface LineHandler<SessionT extends ProtocolSession> extends ProtocolH
* Processing the give line. The line includes the {@link ProtocolSession#getLineDelimiter()} delimiter.
*
* @param session not null
- * @param line not null
+ * @param buffer not null
* @return response or null
*/
Response onLine(SessionT session, ByteBuffer buffer);
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/MultiLineHandler.java b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/MultiLineHandler.java
index 6266878..5590df3 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/MultiLineHandler.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/MultiLineHandler.java
@@ -55,18 +55,12 @@ public abstract class MultiLineHandler<S extends ProtocolSession> implements Lin
/**
* Return <code>true</code> if the buffered lines are ready to get pushed to the {@link #onLines(ProtocolSession, Collection)} method
- *
- * @param session
- * @param line
- * @return ready
*/
protected abstract boolean isReady(S session, ByteBuffer line);
/**
* Handle the buffered lines
- *
- * @param session
- * @param lines
+ *
* @return response
*/
protected abstract Response onLines(S session, Collection<ByteBuffer> lines);
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandler.java b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandler.java
index 02e85cd..8914329 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandler.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandler.java
@@ -26,15 +26,11 @@ import org.apache.commons.configuration2.ex.ConfigurationException;
* Just the base interface for all kind of "protocol" handlers.
*
* Every of them should implement this interface
- *
*/
public interface ProtocolHandler {
/**
* Init with the given {@link Configuration}
- *
- * @param config
- * @throws ConfigurationException
*/
default void init(Configuration config) throws ConfigurationException {
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandlerChain.java b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandlerChain.java
index 5e23bd7..1edbeee 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandlerChain.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandlerChain.java
@@ -25,13 +25,11 @@ import java.util.LinkedList;
/**
* Chain which can be used to get all Handlers for a given Class.
- *
*/
public interface ProtocolHandlerChain {
/**
* Returns a list of handler of the requested type.
- * @param <T>
*
* @param type the type of handler we're interested in
* @return a List of handlers
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandlerChainImpl.java b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandlerChainImpl.java
index 6fe802a..3303ed2 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandlerChainImpl.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandlerChainImpl.java
@@ -32,8 +32,6 @@ import com.google.common.collect.ImmutableList;
* {@link #wireExtensibleHandlers()} is called. After that all operations which
* try to modify the instance will throw and
* {@link UnsupportedOperationException}
- *
- *
*/
public class ProtocolHandlerChainImpl extends AbstractProtocolHandlerChain implements List<ProtocolHandler> {
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandlerResultHandler.java b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandlerResultHandler.java
index 4b46de9..d60f44f 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandlerResultHandler.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/ProtocolHandlerResultHandler.java
@@ -26,18 +26,12 @@ import org.apache.james.protocols.api.Response;
* An special {@link ProtocolHandler} which allows to <strong>intercept</code> returned {@link Response}'s and act on them.
*
* This could be to gather statistics or even replace them.
- *
- * @param <R>
- * @param <S>
*/
public interface ProtocolHandlerResultHandler<R extends Response, S extends ProtocolSession> extends ProtocolHandler {
/**
* Get called when a {@link Response} was returned from the {@link ProtocolHandler}
- *
- * @param session
- * @param response
- * @param handler
+ *
* @return response
*/
Response onResponse(ProtocolSession session, R response, long executionTime, ProtocolHandler handler);
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/UnknownCommandHandler.java b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/UnknownCommandHandler.java
index 4923d54..c719527 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/UnknownCommandHandler.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/UnknownCommandHandler.java
@@ -27,9 +27,6 @@ import com.google.common.collect.ImmutableSet;
/**
* A special {@link CommandHandler} implementation which should be extended by {@link CommandHandler}'s which should get called for unknown command. So this is some kind
* of a <strong>fallback</strong> {@link CommandHandler} which will get executed if no other matching {@link CommandHandler} could be found for a given command.
- *
- *
- * @param <S>
*/
public abstract class UnknownCommandHandler<S extends ProtocolSession> implements CommandHandler<S> {
diff --git a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/WiringException.java b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/WiringException.java
index 7dd4d20..9e54ceb 100644
--- a/protocols/api/src/main/java/org/apache/james/protocols/api/handler/WiringException.java
+++ b/protocols/api/src/main/java/org/apache/james/protocols/api/handler/WiringException.java
@@ -25,31 +25,18 @@ public class WiringException extends Exception {
private static final long serialVersionUID = 8824880646965171467L;
- /**
- * Empty constructor
- */
public WiringException() {
super();
}
- /**
- * @param message
- * @param t
- */
public WiringException(String message, Throwable t) {
super(message, t);
}
- /**
- * @param message
- */
public WiringException(String message) {
super(message);
}
- /**
- * @param t
- */
public WiringException(Throwable t) {
super(t);
}
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org