Fixed all the mina-core javadoc errors... Project: http://git-wip-us.apache.org/repos/asf/mina/repo Commit: http://git-wip-us.apache.org/repos/asf/mina/commit/6f0509f7 Tree: http://git-wip-us.apache.org/repos/asf/mina/tree/6f0509f7 Diff: http://git-wip-us.apache.org/repos/asf/mina/diff/6f0509f7
Branch: refs/heads/2.0 Commit: 6f0509f70e5d4643ff9e9e7ef5c6313c34160848 Parents: 300782f Author: Emmanuel Lécharny <[email protected]> Authored: Fri Jan 22 16:02:52 2016 +0100 Committer: Emmanuel Lécharny <[email protected]> Committed: Fri Jan 22 16:02:52 2016 +0100 ---------------------------------------------------------------------- .../mina/core/filterchain/IoFilterChain.java | 4 +- .../mina/core/future/DefaultIoFuture.java | 4 +- .../org/apache/mina/core/future/IoFuture.java | 2 - .../mina/core/service/AbstractIoConnector.java | 4 +- .../org/apache/mina/core/service/IoHandler.java | 28 ++++++++ .../mina/core/service/IoHandlerAdapter.java | 24 +++++++ .../org/apache/mina/core/service/IoService.java | 36 +++------- .../mina/core/service/IoServiceListener.java | 3 + .../core/service/SimpleIoProcessorPool.java | 2 +- .../mina/core/service/TransportMetadata.java | 2 +- .../core/session/AbstractIoSessionConfig.java | 2 + .../apache/mina/core/session/DummySession.java | 44 ++++++++++++ .../apache/mina/core/session/IdleStatus.java | 2 +- .../core/session/IoSessionAttributeMap.java | 41 +++++++++-- .../mina/core/session/IoSessionConfig.java | 61 +++++++++++----- .../session/IoSessionDataStructureFactory.java | 10 ++- .../mina/core/write/DefaultWriteRequest.java | 5 ++ .../apache/mina/core/write/WriteException.java | 44 +++++++++--- .../apache/mina/core/write/WriteRequest.java | 6 +- .../mina/core/write/WriteRequestQueue.java | 3 +- .../mina/core/write/WriteRequestWrapper.java | 22 +++++- .../mina/filter/buffer/BufferedWriteFilter.java | 2 +- .../filter/codec/CumulativeProtocolDecoder.java | 8 +-- .../filter/codec/ProtocolCodecException.java | 7 ++ .../mina/filter/codec/ProtocolCodecFactory.java | 8 +++ .../mina/filter/codec/ProtocolCodecSession.java | 8 +-- .../mina/filter/codec/ProtocolDecoder.java | 6 ++ .../filter/codec/ProtocolDecoderException.java | 14 +++- .../filter/codec/ProtocolDecoderOutput.java | 3 + .../mina/filter/codec/ProtocolEncoder.java | 4 ++ .../filter/codec/ProtocolEncoderException.java | 7 ++ .../codec/SynchronizedProtocolDecoder.java | 11 ++- .../codec/SynchronizedProtocolEncoder.java | 9 ++- .../codec/demux/DemuxingProtocolDecoder.java | 51 ++++++++----- .../mina/filter/codec/demux/MessageDecoder.java | 8 ++- .../codec/demux/MessageDecoderFactory.java | 3 + .../mina/filter/codec/demux/MessageEncoder.java | 5 ++ .../codec/demux/MessageEncoderFactory.java | 5 ++ .../PrefixedStringCodecFactory.java | 4 +- .../ObjectSerializationCodecFactory.java | 16 ++++- .../ObjectSerializationDecoder.java | 9 ++- .../ObjectSerializationEncoder.java | 7 +- .../ObjectSerializationInputStream.java | 62 +++++++++++++++- .../ObjectSerializationOutputStream.java | 60 +++++++++++++++- .../statemachine/DecodingStateMachine.java | 4 ++ .../filter/codec/textline/LineDelimiter.java | 4 +- .../codec/textline/TextLineCodecFactory.java | 17 +++-- .../filter/codec/textline/TextLineDecoder.java | 22 +++++- .../filter/codec/textline/TextLineEncoder.java | 28 ++++++-- .../errorgenerating/ErrorGeneratingFilter.java | 13 ++-- .../mina/filter/executor/ExecutorFilter.java | 4 +- .../filter/executor/IoEventQueueHandler.java | 11 ++- .../filter/executor/WriteRequestFilter.java | 4 +- .../mina/filter/firewall/BlacklistFilter.java | 8 +++ .../mina/filter/keepalive/KeepAliveFilter.java | 76 +++++++++++++++++++- .../keepalive/KeepAliveMessageFactory.java | 21 ++++-- .../KeepAliveRequestTimeoutException.java | 19 +++++ .../KeepAliveRequestTimeoutHandler.java | 4 ++ .../apache/mina/filter/ssl/KeyStoreFactory.java | 9 +++ .../org/apache/mina/filter/ssl/SslFilter.java | 40 +++++++---- .../org/apache/mina/filter/ssl/SslHandler.java | 3 +- .../filter/statistic/ProfilerTimerFilter.java | 8 --- .../stream/AbstractStreamWriteFilter.java | 5 +- .../SessionAttributeInitializingFilter.java | 9 ++- .../mina/handler/chain/ChainedIoHandler.java | 2 +- .../mina/handler/chain/IoHandlerChain.java | 6 +- .../mina/handler/chain/IoHandlerCommand.java | 4 ++ .../mina/handler/demux/DemuxingIoHandler.java | 33 +++++++-- .../mina/handler/demux/ExceptionHandler.java | 4 ++ .../multiton/SingleSessionIoHandler.java | 13 +++- .../SingleSessionIoHandlerDelegate.java | 21 +++++- .../multiton/SingleSessionIoHandlerFactory.java | 3 +- .../mina/handler/stream/StreamIoHandler.java | 11 ++- .../mina/proxy/AbstractProxyIoHandler.java | 1 + .../mina/proxy/AbstractProxyLogicHandler.java | 11 +-- .../apache/mina/proxy/ProxyAuthException.java | 5 ++ .../org/apache/mina/proxy/ProxyConnector.java | 8 ++- .../apache/mina/proxy/ProxyLogicHandler.java | 4 +- .../apache/mina/proxy/event/IoSessionEvent.java | 14 +--- .../mina/proxy/event/IoSessionEventQueue.java | 2 + .../mina/proxy/event/IoSessionEventType.java | 2 - .../mina/proxy/handlers/ProxyRequest.java | 2 - .../handlers/http/AbstractAuthLogicHandler.java | 8 +-- .../handlers/http/AbstractHttpLogicHandler.java | 3 + .../http/HttpAuthenticationMethods.java | 5 +- .../proxy/handlers/http/HttpProxyRequest.java | 21 ++++-- .../proxy/handlers/http/HttpProxyResponse.java | 12 ++-- .../http/basic/HttpBasicAuthLogicHandler.java | 3 + .../http/basic/HttpNoAuthLogicHandler.java | 3 + .../handlers/http/digest/DigestUtilities.java | 11 ++- .../http/ntlm/HttpNTLMAuthLogicHandler.java | 5 +- .../proxy/handlers/http/ntlm/NTLMResponses.java | 7 ++ .../proxy/handlers/http/ntlm/NTLMUtilities.java | 4 ++ .../handlers/socks/Socks4LogicHandler.java | 2 + .../handlers/socks/Socks5LogicHandler.java | 5 +- .../proxy/handlers/socks/SocksProxyRequest.java | 4 +- .../mina/proxy/session/ProxyIoSession.java | 24 +++---- .../apache/mina/proxy/utils/ByteUtilities.java | 10 ++- .../mina/proxy/utils/IoBufferDecoder.java | 1 + .../mina/proxy/utils/StringUtilities.java | 3 +- .../socket/AbstractDatagramSessionConfig.java | 10 +-- .../socket/AbstractSocketSessionConfig.java | 16 ++--- .../mina/transport/socket/DatagramAcceptor.java | 10 +-- .../transport/socket/DatagramConnector.java | 6 +- .../transport/socket/DatagramSessionConfig.java | 25 +++++++ .../mina/transport/socket/SocketAcceptor.java | 16 +++-- .../mina/transport/socket/SocketConnector.java | 6 +- .../transport/socket/SocketSessionConfig.java | 31 ++++++++ .../socket/nio/NioDatagramAcceptor.java | 2 + .../socket/nio/NioDatagramConnector.java | 4 ++ .../mina/transport/socket/nio/NioProcessor.java | 5 +- .../mina/transport/socket/nio/NioSession.java | 4 +- .../mina/transport/vmpipe/VmPipeAcceptor.java | 26 ++++++- .../mina/transport/vmpipe/VmPipeAddress.java | 20 ++++-- .../mina/transport/vmpipe/VmPipeConnector.java | 11 +++ .../apache/mina/util/AvailablePortFinder.java | 11 +-- .../org/apache/mina/util/CircularQueue.java | 2 +- .../org/apache/mina/util/CopyOnWriteMap.java | 10 +-- .../org/apache/mina/util/ExceptionMonitor.java | 2 +- .../java/org/apache/mina/util/ExpiringMap.java | 5 +- .../mina/util/LazyInitializedCacheMap.java | 2 + .../org/apache/mina/util/LazyInitializer.java | 3 +- .../org/apache/mina/util/Log4jXmlFormatter.java | 4 +- .../java/org/apache/mina/util/Transform.java | 4 +- .../apache/mina/util/byteaccess/ByteArray.java | 18 +++-- .../mina/util/byteaccess/ByteArrayList.java | 22 ++---- .../util/byteaccess/CompositeByteArray.java | 32 ++++++--- .../CompositeByteArrayRelativeBase.java | 6 +- .../CompositeByteArrayRelativeReader.java | 2 +- .../CompositeByteArrayRelativeWriter.java | 2 + .../mina/util/byteaccess/IoAbsoluteReader.java | 38 ++++++---- .../mina/util/byteaccess/IoAbsoluteWriter.java | 30 +++++++- .../mina/util/byteaccess/IoRelativeReader.java | 27 ++++--- .../mina/util/byteaccess/IoRelativeWriter.java | 24 ++++++- 134 files changed, 1311 insertions(+), 377 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/core/filterchain/IoFilterChain.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/filterchain/IoFilterChain.java b/mina-core/src/main/java/org/apache/mina/core/filterchain/IoFilterChain.java index 4814025..ef5c979 100644 --- a/mina-core/src/main/java/org/apache/mina/core/filterchain/IoFilterChain.java +++ b/mina-core/src/main/java/org/apache/mina/core/filterchain/IoFilterChain.java @@ -36,9 +36,7 @@ import org.apache.mina.core.write.WriteRequest; */ public interface IoFilterChain { /** - * Returns the parent {@link IoSession} of this chain. - * - * @return {@link IoSession} + * @return the parent {@link IoSession} of this chain. */ IoSession getSession(); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/core/future/DefaultIoFuture.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/future/DefaultIoFuture.java b/mina-core/src/main/java/org/apache/mina/core/future/DefaultIoFuture.java index acd267e..e71edb1 100644 --- a/mina-core/src/main/java/org/apache/mina/core/future/DefaultIoFuture.java +++ b/mina-core/src/main/java/org/apache/mina/core/future/DefaultIoFuture.java @@ -320,9 +320,7 @@ public class DefaultIoFuture implements IoFuture { } /** - * Returns the result of the asynchronous operation. - * - * @return The stored value + * @return the result of the asynchronous operation. */ protected Object getValue() { synchronized (lock) { http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/core/future/IoFuture.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/future/IoFuture.java b/mina-core/src/main/java/org/apache/mina/core/future/IoFuture.java index 48697ac..76e5346 100644 --- a/mina-core/src/main/java/org/apache/mina/core/future/IoFuture.java +++ b/mina-core/src/main/java/org/apache/mina/core/future/IoFuture.java @@ -109,8 +109,6 @@ public interface IoFuture { boolean join(long timeoutMillis); /** - * Returns if the asynchronous operation is completed. - * * @return <tt>true</tt> if the operation is completed. */ boolean isDone(); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/core/service/AbstractIoConnector.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/service/AbstractIoConnector.java b/mina-core/src/main/java/org/apache/mina/core/service/AbstractIoConnector.java index a291932..fa17dbb 100644 --- a/mina-core/src/main/java/org/apache/mina/core/service/AbstractIoConnector.java +++ b/mina-core/src/main/java/org/apache/mina/core/service/AbstractIoConnector.java @@ -69,9 +69,7 @@ public abstract class AbstractIoConnector extends AbstractIoService implements I } /** - * Returns the minimum connection timeout value for this connector - * - * @return + * @return * The minimum time that this connector can have for a connection * timeout in milliseconds. */ http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/core/service/IoHandler.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/service/IoHandler.java b/mina-core/src/main/java/org/apache/mina/core/service/IoHandler.java index 4840a9e..e7db2fe 100644 --- a/mina-core/src/main/java/org/apache/mina/core/service/IoHandler.java +++ b/mina-core/src/main/java/org/apache/mina/core/service/IoHandler.java @@ -38,6 +38,9 @@ public interface IoHandler { * handles I/O of multiple sessions, please implement this method to perform * tasks that consumes minimal amount of time such as socket parameter * and user-defined session attribute initialization. + * + * @param session The session being created + * @throws Exception If we get an exception while processing the create event */ void sessionCreated(IoSession session) throws Exception; @@ -46,11 +49,17 @@ public interface IoHandler { * {@link #sessionCreated(IoSession)}. The biggest difference from * {@link #sessionCreated(IoSession)} is that it's invoked from other thread * than an I/O processor thread once thread model is configured properly. + * + * @param session The session being opened + * @throws Exception If we get an exception while processing the open event */ void sessionOpened(IoSession session) throws Exception; /** * Invoked when a connection is closed. + * + * @param session The session being closed + * @throws Exception If we get an exception while processing the close event */ void sessionClosed(IoSession session) throws Exception; @@ -58,6 +67,10 @@ public interface IoHandler { * Invoked with the related {@link IdleStatus} when a connection becomes idle. * This method is not invoked if the transport type is UDP; it's a known bug, * and will be fixed in 2.0. + * + * @param session The idling session + * @param status The session's status + * @throws Exception If we get an exception while processing the idle event */ void sessionIdle(IoSession session, IdleStatus status) throws Exception; @@ -65,22 +78,37 @@ public interface IoHandler { * Invoked when any exception is thrown by user {@link IoHandler} * implementation or by MINA. If <code>cause</code> is an instance of * {@link IOException}, MINA will close the connection automatically. + * + * @param session The session for which we have got an exception + * @param cause The exception that has been caught + * @throws Exception If we get an exception while processing the caught exception */ void exceptionCaught(IoSession session, Throwable cause) throws Exception; /** * Invoked when a message is received. + * + * @param session The session that is receiving a message + * @param message The received message + * @throws Exception If we get an exception while processing the received message */ void messageReceived(IoSession session, Object message) throws Exception; /** * Invoked when a message written by {@link IoSession#write(Object)} is * sent out. + * + * @param session The session that has sent a full message + * @param message The sent message + * @throws Exception If we get an exception while processing the sent message */ void messageSent(IoSession session, Object message) throws Exception; /** * Handle the closure of an half-duplex TCP channel + * + * @param session The session which input is being closed + * @throws Exception If we get an exception while closing the input */ void inputClosed(IoSession session) throws Exception; } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/core/service/IoHandlerAdapter.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/service/IoHandlerAdapter.java b/mina-core/src/main/java/org/apache/mina/core/service/IoHandlerAdapter.java index af92c33..2d1b451 100644 --- a/mina-core/src/main/java/org/apache/mina/core/service/IoHandlerAdapter.java +++ b/mina-core/src/main/java/org/apache/mina/core/service/IoHandlerAdapter.java @@ -34,22 +34,37 @@ import org.slf4j.LoggerFactory; public class IoHandlerAdapter implements IoHandler { private static final Logger LOGGER = LoggerFactory.getLogger(IoHandlerAdapter.class); + /** + * {@inheritDoc} + */ public void sessionCreated(IoSession session) throws Exception { // Empty handler } + /** + * {@inheritDoc} + */ public void sessionOpened(IoSession session) throws Exception { // Empty handler } + /** + * {@inheritDoc} + */ public void sessionClosed(IoSession session) throws Exception { // Empty handler } + /** + * {@inheritDoc} + */ public void sessionIdle(IoSession session, IdleStatus status) throws Exception { // Empty handler } + /** + * {@inheritDoc} + */ public void exceptionCaught(IoSession session, Throwable cause) throws Exception { if (LOGGER.isWarnEnabled()) { LOGGER.warn("EXCEPTION, please implement " + getClass().getName() @@ -57,14 +72,23 @@ public class IoHandlerAdapter implements IoHandler { } } + /** + * {@inheritDoc} + */ public void messageReceived(IoSession session, Object message) throws Exception { // Empty handler } + /** + * {@inheritDoc} + */ public void messageSent(IoSession session, Object message) throws Exception { // Empty handler } + /** + * {@inheritDoc} + */ public void inputClosed(IoSession session) throws Exception { session.close(true); } http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/core/service/IoService.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/service/IoService.java b/mina-core/src/main/java/org/apache/mina/core/service/IoService.java index c14f20d..31be6f7 100644 --- a/mina-core/src/main/java/org/apache/mina/core/service/IoService.java +++ b/mina-core/src/main/java/org/apache/mina/core/service/IoService.java @@ -103,37 +103,29 @@ public interface IoService { void setHandler(IoHandler handler); /** - * Returns the map of all sessions which are currently managed by this + * @return the map of all sessions which are currently managed by this * service. The key of map is the {@link IoSession#getId() ID} of the - * session. - * - * @return the sessions. An empty collection if there's no session. + * session. An empty collection if there's no session. */ Map<Long, IoSession> getManagedSessions(); /** - * Returns the number of all sessions which are currently managed by this + * @return the number of all sessions which are currently managed by this * service. - * - * @return The number of managed sessions */ int getManagedSessionCount(); /** - * Returns the default configuration of the new {@link IoSession}s + * @return the default configuration of the new {@link IoSession}s * created by this service. - * - * @return The session config */ IoSessionConfig getSessionConfig(); /** - * Returns the {@link IoFilterChainBuilder} which will build the + * @return the {@link IoFilterChainBuilder} which will build the * {@link IoFilterChain} of all {@link IoSession}s which is created * by this service. * The default value is an empty {@link DefaultIoFilterChainBuilder}. - * - * @return The filter chain builder in use */ IoFilterChainBuilder getFilterChainBuilder(); @@ -162,17 +154,13 @@ public interface IoService { DefaultIoFilterChainBuilder getFilterChain(); /** - * Returns a value of whether or not this service is active - * - * @return whether of not the service is active. + * @return a value of whether or not this service is active */ boolean isActive(); /** - * Returns the time when this service was activated. It returns the last + * @return the time when this service was activated. It returns the last * time when this service was activated if the service is not active now. - * - * @return The time by using {@link System#currentTimeMillis()} */ long getActivationTime(); @@ -187,10 +175,8 @@ public interface IoService { Set<WriteFuture> broadcast(Object message); /** - * Returns the {@link IoSessionDataStructureFactory} that provides + * @return the {@link IoSessionDataStructureFactory} that provides * related data structures for a new session created by this service. - * - * @return The used session factory */ IoSessionDataStructureFactory getSessionDataStructureFactory(); @@ -203,22 +189,16 @@ public interface IoService { void setSessionDataStructureFactory(IoSessionDataStructureFactory sessionDataStructureFactory); /** - * Returns the number of bytes scheduled to be written - * * @return The number of bytes scheduled to be written */ int getScheduledWriteBytes(); /** - * Returns the number of messages scheduled to be written - * * @return The number of messages scheduled to be written */ int getScheduledWriteMessages(); /** - * Returns the IoServiceStatistics object for this service. - * * @return The statistics object for this service. */ IoServiceStatistics getStatistics(); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/core/service/IoServiceListener.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/service/IoServiceListener.java b/mina-core/src/main/java/org/apache/mina/core/service/IoServiceListener.java index 9d7d028..6c80201 100644 --- a/mina-core/src/main/java/org/apache/mina/core/service/IoServiceListener.java +++ b/mina-core/src/main/java/org/apache/mina/core/service/IoServiceListener.java @@ -40,6 +40,9 @@ public interface IoServiceListener extends EventListener { /** * Invoked when a service is idle. + * + * @param service the {@link IoService} + * @param idleStatus The idle status * @throws Exception if an error occurred while the service is being idled */ void serviceIdle(IoService service, IdleStatus idleStatus) throws Exception; http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/core/service/SimpleIoProcessorPool.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/service/SimpleIoProcessorPool.java b/mina-core/src/main/java/org/apache/mina/core/service/SimpleIoProcessorPool.java index c769c6f..44c626b 100644 --- a/mina-core/src/main/java/org/apache/mina/core/service/SimpleIoProcessorPool.java +++ b/mina-core/src/main/java/org/apache/mina/core/service/SimpleIoProcessorPool.java @@ -154,7 +154,7 @@ public class SimpleIoProcessorPool<S extends AbstractIoSession> implements IoPro * @param processorType The type of IoProcessor to use * @param executor The {@link Executor} * @param size The number of IoProcessor in the pool - * @param The SelectorProvider to used + * @param selectorProvider The SelectorProvider to used */ @SuppressWarnings("unchecked") public SimpleIoProcessorPool(Class<? extends IoProcessor<S>> processorType, Executor executor, int size, http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/core/service/TransportMetadata.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/service/TransportMetadata.java b/mina-core/src/main/java/org/apache/mina/core/service/TransportMetadata.java index b7c7111..58e958c 100644 --- a/mina-core/src/main/java/org/apache/mina/core/service/TransportMetadata.java +++ b/mina-core/src/main/java/org/apache/mina/core/service/TransportMetadata.java @@ -38,7 +38,7 @@ public interface TransportMetadata { String getProviderName(); /** - * Returns the name of the service. + * @return the name of the service. */ String getName(); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/core/session/AbstractIoSessionConfig.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/session/AbstractIoSessionConfig.java b/mina-core/src/main/java/org/apache/mina/core/session/AbstractIoSessionConfig.java index fcfe419..85ef6e0 100644 --- a/mina-core/src/main/java/org/apache/mina/core/session/AbstractIoSessionConfig.java +++ b/mina-core/src/main/java/org/apache/mina/core/session/AbstractIoSessionConfig.java @@ -72,6 +72,8 @@ public abstract class AbstractIoSessionConfig implements IoSessionConfig { /** * Implement this method to set all transport-specific configuration * properties retrieved from the specified <tt>config</tt>. + * + * @param config the {@link IoSessionConfig} to set */ protected abstract void doSetAll(IoSessionConfig config); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/core/session/DummySession.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/session/DummySession.java b/mina-core/src/main/java/org/apache/mina/core/session/DummySession.java index 9dd478c..0b2d409 100644 --- a/mina-core/src/main/java/org/apache/mina/core/session/DummySession.java +++ b/mina-core/src/main/java/org/apache/mina/core/session/DummySession.java @@ -209,12 +209,17 @@ public class DummySession extends AbstractIoSession { } } + /** + * {@inheritDoc} + */ public IoSessionConfig getConfig() { return config; } /** * Sets the configuration of this session. + * + * @param config the {@link IoSessionConfig} to set */ public void setConfig(IoSessionConfig config) { if (config == null) { @@ -224,16 +229,24 @@ public class DummySession extends AbstractIoSession { this.config = config; } + /** + * {@inheritDoc} + */ public IoFilterChain getFilterChain() { return filterChain; } + /** + * {@inheritDoc} + */ public IoHandler getHandler() { return handler; } /** * Sets the {@link IoHandler} which handles this session. + * + * @param handler the {@link IoHandler} to set */ public void setHandler(IoHandler handler) { if (handler == null) { @@ -243,10 +256,16 @@ public class DummySession extends AbstractIoSession { this.handler = handler; } + /** + * {@inheritDoc} + */ public SocketAddress getLocalAddress() { return localAddress; } + /** + * {@inheritDoc} + */ public SocketAddress getRemoteAddress() { return remoteAddress; } @@ -254,6 +273,8 @@ public class DummySession extends AbstractIoSession { /** * Sets the socket address of local machine which is associated with * this session. + * + * @param localAddress The socket address to set */ public void setLocalAddress(SocketAddress localAddress) { if (localAddress == null) { @@ -265,6 +286,8 @@ public class DummySession extends AbstractIoSession { /** * Sets the socket address of remote peer. + * + * @param remoteAddress The socket address to set */ public void setRemoteAddress(SocketAddress remoteAddress) { if (remoteAddress == null) { @@ -274,12 +297,17 @@ public class DummySession extends AbstractIoSession { this.remoteAddress = remoteAddress; } + /** + * {@inheritDoc} + */ public IoService getService() { return service; } /** * Sets the {@link IoService} which provides I/O service to this session. + * + * @param service The {@link IoService} to set */ public void setService(IoService service) { if (service == null) { @@ -289,17 +317,25 @@ public class DummySession extends AbstractIoSession { this.service = service; } + /** + * {@inheritDoc} + */ @Override public final IoProcessor<IoSession> getProcessor() { return processor; } + /** + * {@inheritDoc} + */ public TransportMetadata getTransportMetadata() { return transportMetadata; } /** * Sets the {@link TransportMetadata} that this session runs on. + * + * @param transportMetadata The {@link TransportMetadata} to set */ public void setTransportMetadata(TransportMetadata transportMetadata) { if (transportMetadata == null) { @@ -309,11 +345,17 @@ public class DummySession extends AbstractIoSession { this.transportMetadata = transportMetadata; } + /** + * {@inheritDoc} + */ @Override public void setScheduledWriteBytes(int byteCount) { super.setScheduledWriteBytes(byteCount); } + /** + * {@inheritDoc} + */ @Override public void setScheduledWriteMessages(int messages) { super.setScheduledWriteMessages(messages); @@ -326,6 +368,8 @@ public class DummySession extends AbstractIoSession { * {@link IoSessionConfig#getThroughputCalculationInterval() calculation interval}. * If, however, <tt>force</tt> is specified as <tt>true</tt>, this method * updates the throughput properties immediately. + * + * @param force the flag that forces the update of properties immediately if <tt>true</tt> */ public void updateThroughput(boolean force) { super.updateThroughput(System.currentTimeMillis(), force); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/core/session/IdleStatus.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/session/IdleStatus.java b/mina-core/src/main/java/org/apache/mina/core/session/IdleStatus.java index 74d7099..cba39d6 100644 --- a/mina-core/src/main/java/org/apache/mina/core/session/IdleStatus.java +++ b/mina-core/src/main/java/org/apache/mina/core/session/IdleStatus.java @@ -60,7 +60,7 @@ public class IdleStatus { } /** - * Returns the string representation of this status. + * @return the string representation of this status. * <ul> * <li>{@link #READER_IDLE} - <tt>"reader idle"</tt></li> * <li>{@link #WRITER_IDLE} - <tt>"writer idle"</tt></li> http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/core/session/IoSessionAttributeMap.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/session/IoSessionAttributeMap.java b/mina-core/src/main/java/org/apache/mina/core/session/IoSessionAttributeMap.java index 15d965f..8b8d6c1 100644 --- a/mina-core/src/main/java/org/apache/mina/core/session/IoSessionAttributeMap.java +++ b/mina-core/src/main/java/org/apache/mina/core/session/IoSessionAttributeMap.java @@ -31,7 +31,7 @@ import java.util.Set; public interface IoSessionAttributeMap { /** - * Returns the value of user defined attribute associated with the + * @return the value of user defined attribute associated with the * specified key. If there's no such attribute, the specified default * value is associated with the specified key, and the default value is * returned. This method is same with the following code except that the @@ -44,13 +44,18 @@ public interface IoSessionAttributeMap { * return defaultValue; * } * </pre> + * + * @param session the session for which we want to get an attribute + * @param key The key we are looking for + * @param defaultValue The default returned value if the attribute is not found */ Object getAttribute(IoSession session, Object key, Object defaultValue); /** * Sets a user-defined attribute. * - * @param key the key of the attribute + * @param session the session for which we want to set an attribute + * @param key the key of the attribute * @param value the value of the attribute * @return The old value of the attribute. <tt>null</tt> if it is new. */ @@ -67,6 +72,11 @@ public interface IoSessionAttributeMap { * return setAttribute(key, value); * } * </pre> + * + * @param session the session for which we want to set an attribute + * @param key The key we are looking for + * @param value The value to inject + * @return The previous attribute */ Object setAttributeIfAbsent(IoSession session, Object key, Object value); @@ -74,6 +84,8 @@ public interface IoSessionAttributeMap { * Removes a user-defined attribute with the specified key. * * @return The old value of the attribute. <tt>null</tt> if not found. + * @param session the session for which we want to remove an attribute + * @param key The key we are looking for */ Object removeAttribute(IoSession session, Object key); @@ -90,6 +102,12 @@ public interface IoSessionAttributeMap { * return false; * } * </pre> + * + * @param session the session for which we want to remove a value + * @param key The key we are looking for + * @param value The value to remove + * @return <tt>true</tt> if the value has been removed, <tt>false</tt> if the key was + * not found of the value not removed */ boolean removeAttribute(IoSession session, Object key, Object value); @@ -106,23 +124,38 @@ public interface IoSessionAttributeMap { * return false; * } * </pre> + * + * @param session the session for which we want to replace an attribute + * @param key The key we are looking for + * @param oldValue The old value to replace + * @param newValue The new value to set + * @return <tt>true</tt> if the value has been replaced, <tt>false</tt> if the key was + * not found of the value not replaced */ boolean replaceAttribute(IoSession session, Object key, Object oldValue, Object newValue); /** - * Returns <tt>true</tt> if this session contains the attribute with + * @return <tt>true</tt> if this session contains the attribute with * the specified <tt>key</tt>. + * + * @param session the session for which wa want to check if an attribute is present + * @param key The key we are looking for */ boolean containsAttribute(IoSession session, Object key); /** - * Returns the set of keys of all user-defined attributes. + * @return the set of keys of all user-defined attributes. + * + * @param session the session for which we want the set of attributes */ Set<Object> getAttributeKeys(IoSession session); /** * Disposes any releases associated with the specified session. * This method is invoked on disconnection. + * + * @param session the session to be disposed + * @throws Exception If the session can't be disposed */ void dispose(IoSession session) throws Exception; } http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/core/session/IoSessionConfig.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/session/IoSessionConfig.java b/mina-core/src/main/java/org/apache/mina/core/session/IoSessionConfig.java index 31d9e81..cc951b9 100644 --- a/mina-core/src/main/java/org/apache/mina/core/session/IoSessionConfig.java +++ b/mina-core/src/main/java/org/apache/mina/core/session/IoSessionConfig.java @@ -29,7 +29,7 @@ import java.util.concurrent.BlockingQueue; public interface IoSessionConfig { /** - * Returns the size of the read buffer that I/O processor allocates + * @return the size of the read buffer that I/O processor allocates * per each read. It's unusual to adjust this property because * it's often adjusted automatically by the I/O processor. */ @@ -39,11 +39,13 @@ public interface IoSessionConfig { * Sets the size of the read buffer that I/O processor allocates * per each read. It's unusual to adjust this property because * it's often adjusted automatically by the I/O processor. + * + * @param readBufferSize The size of the read buffer */ void setReadBufferSize(int readBufferSize); /** - * Returns the minimum size of the read buffer that I/O processor + * @return the minimum size of the read buffer that I/O processor * allocates per each read. I/O processor will not decrease the * read buffer size to the smaller value than this property value. */ @@ -53,11 +55,13 @@ public interface IoSessionConfig { * Sets the minimum size of the read buffer that I/O processor * allocates per each read. I/O processor will not decrease the * read buffer size to the smaller value than this property value. + * + * @param minReadBufferSize The minimum size of the read buffer */ void setMinReadBufferSize(int minReadBufferSize); /** - * Returns the maximum size of the read buffer that I/O processor + * @return the maximum size of the read buffer that I/O processor * allocates per each read. I/O processor will not increase the * read buffer size to the greater value than this property value. */ @@ -67,17 +71,19 @@ public interface IoSessionConfig { * Sets the maximum size of the read buffer that I/O processor * allocates per each read. I/O processor will not increase the * read buffer size to the greater value than this property value. + * + * @param maxReadBufferSize The maximum size of the read buffer */ void setMaxReadBufferSize(int maxReadBufferSize); /** - * Returns the interval (seconds) between each throughput calculation. + * @return the interval (seconds) between each throughput calculation. * The default value is <tt>3</tt> seconds. */ int getThroughputCalculationInterval(); /** - * Returns the interval (milliseconds) between each throughput calculation. + * @return the interval (milliseconds) between each throughput calculation. * The default value is <tt>3</tt> seconds. */ long getThroughputCalculationIntervalInMillis(); @@ -85,86 +91,105 @@ public interface IoSessionConfig { /** * Sets the interval (seconds) between each throughput calculation. The * default value is <tt>3</tt> seconds. + * + * @param throughputCalculationInterval The interval */ void setThroughputCalculationInterval(int throughputCalculationInterval); /** - * Returns idle time for the specified type of idleness in seconds. + * @return idle time for the specified type of idleness in seconds. + * + * @param status The status for which we want the idle time (One of READER_IDLE, + * WRITER_IDLE or BOTH_IDLE) */ int getIdleTime(IdleStatus status); /** - * Returns idle time for the specified type of idleness in milliseconds. + * @return idle time for the specified type of idleness in milliseconds. + * + * @param status The status for which we want the idle time (One of READER_IDLE, + * WRITER_IDLE or BOTH_IDLE) */ long getIdleTimeInMillis(IdleStatus status); /** * Sets idle time for the specified type of idleness in seconds. + * @param status The status for which we want to set the idle time (One of READER_IDLE, + * WRITER_IDLE or BOTH_IDLE) + * @param idleTime The time in second to set */ void setIdleTime(IdleStatus status, int idleTime); /** - * Returns idle time for {@link IdleStatus#READER_IDLE} in seconds. + * @return idle time for {@link IdleStatus#READER_IDLE} in seconds. */ int getReaderIdleTime(); /** - * Returns idle time for {@link IdleStatus#READER_IDLE} in milliseconds. + * @return idle time for {@link IdleStatus#READER_IDLE} in milliseconds. */ long getReaderIdleTimeInMillis(); /** * Sets idle time for {@link IdleStatus#READER_IDLE} in seconds. + * + * @param idleTime The time to set */ void setReaderIdleTime(int idleTime); /** - * Returns idle time for {@link IdleStatus#WRITER_IDLE} in seconds. + * @return idle time for {@link IdleStatus#WRITER_IDLE} in seconds. */ int getWriterIdleTime(); /** - * Returns idle time for {@link IdleStatus#WRITER_IDLE} in milliseconds. + * @return idle time for {@link IdleStatus#WRITER_IDLE} in milliseconds. */ long getWriterIdleTimeInMillis(); /** * Sets idle time for {@link IdleStatus#WRITER_IDLE} in seconds. + * + * @param idleTime The time to set */ void setWriterIdleTime(int idleTime); /** - * Returns idle time for {@link IdleStatus#BOTH_IDLE} in seconds. + * @return idle time for {@link IdleStatus#BOTH_IDLE} in seconds. */ int getBothIdleTime(); /** - * Returns idle time for {@link IdleStatus#BOTH_IDLE} in milliseconds. + * @return idle time for {@link IdleStatus#BOTH_IDLE} in milliseconds. */ long getBothIdleTimeInMillis(); /** * Sets idle time for {@link IdleStatus#WRITER_IDLE} in seconds. + * + * @param idleTime The time to set */ void setBothIdleTime(int idleTime); /** - * Returns write timeout in seconds. + * @return write timeout in seconds. */ int getWriteTimeout(); /** - * Returns write timeout in milliseconds. + * @return write timeout in milliseconds. */ long getWriteTimeoutInMillis(); /** * Sets write timeout in seconds. + * + * @param writeTimeout The timeout to set */ void setWriteTimeout(int writeTimeout); /** - * Returns <tt>true</tt> if and only if {@link IoSession#read()} operation + * @return <tt>true</tt> if and only if {@link IoSession#read()} operation * is enabled. If enabled, all received messages are stored in an internal * {@link BlockingQueue} so you can read received messages in more * convenient way for client applications. Enabling this option is not @@ -180,12 +205,16 @@ public interface IoSessionConfig { * applications. Enabling this option is not useful to server applications * and can cause unintended memory leak, and therefore it's disabled by * default. + * + * @param useReadOperation <tt>true</tt> if the read operation is enabled, <tt>false</tt> otherwise */ void setUseReadOperation(boolean useReadOperation); /** * Sets all configuration properties retrieved from the specified * <tt>config</tt>. + * + * @param config The configuration to use */ void setAll(IoSessionConfig config); } http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/core/session/IoSessionDataStructureFactory.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/session/IoSessionDataStructureFactory.java b/mina-core/src/main/java/org/apache/mina/core/session/IoSessionDataStructureFactory.java index 5effcf3..79c477f 100644 --- a/mina-core/src/main/java/org/apache/mina/core/session/IoSessionDataStructureFactory.java +++ b/mina-core/src/main/java/org/apache/mina/core/session/IoSessionDataStructureFactory.java @@ -31,19 +31,25 @@ import org.apache.mina.core.write.WriteRequestQueue; */ public interface IoSessionDataStructureFactory { /** - * Returns an {@link IoSessionAttributeMap} which is going to be associated + * @return an {@link IoSessionAttributeMap} which is going to be associated * with the specified <tt>session</tt>. Please note that the returned * implementation must be thread-safe. + * + * @param session The session for which we want the Attribute Map + * @throws Exception If an error occured while retrieving the map */ IoSessionAttributeMap getAttributeMap(IoSession session) throws Exception; /** - * Returns an {@link WriteRequest} which is going to be associated with + * @return an {@link WriteRequest} which is going to be associated with * the specified <tt>session</tt>. Please note that the returned * implementation must be thread-safe and robust enough to deal * with various messages types (even what you didn't expect at all), * especially when you are going to implement a priority queue which * involves {@link Comparator}. + * + * @param session The session for which we want the WriteRequest queue + * @throws Exception If an error occured while retrieving the queue */ WriteRequestQueue getWriteRequestQueue(IoSession session) throws Exception; } http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/core/write/DefaultWriteRequest.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/write/DefaultWriteRequest.java b/mina-core/src/main/java/org/apache/mina/core/write/DefaultWriteRequest.java index d3a9e74..f03bbd7 100644 --- a/mina-core/src/main/java/org/apache/mina/core/write/DefaultWriteRequest.java +++ b/mina-core/src/main/java/org/apache/mina/core/write/DefaultWriteRequest.java @@ -112,6 +112,8 @@ public class DefaultWriteRequest implements WriteRequest { * Creates a new instance without {@link WriteFuture}. You'll get * an instance of {@link WriteFuture} even if you called this constructor * because {@link #getFuture()} will return a bogus future. + * + * @param message The message that will be written */ public DefaultWriteRequest(Object message) { this(message, null, null); @@ -119,6 +121,9 @@ public class DefaultWriteRequest implements WriteRequest { /** * Creates a new instance with {@link WriteFuture}. + * + * @param message The message that will be written + * @param future The associated {@link WriteFuture} */ public DefaultWriteRequest(Object message, WriteFuture future) { this(message, future, null); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/core/write/WriteException.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/write/WriteException.java b/mina-core/src/main/java/org/apache/mina/core/write/WriteException.java index c57f338..193432b 100644 --- a/mina-core/src/main/java/org/apache/mina/core/write/WriteException.java +++ b/mina-core/src/main/java/org/apache/mina/core/write/WriteException.java @@ -30,18 +30,21 @@ import java.util.Set; import org.apache.mina.util.MapBackedSet; /** - * An exception which is thrown when one or more write operations were failed. + * An exception which is thrown when one or more write operations failed. * * @author <a href="http://mina.apache.org";>Apache MINA Project</a> */ public class WriteException extends IOException { - + /** The mandatory serialVersionUUID */ private static final long serialVersionUID = -4174407422754524197L; + /** The list of WriteRequest stored in this exception */ private final List<WriteRequest> requests; /** * Creates a new exception. + * + * @param request The associated {@link WriteRequest} */ public WriteException(WriteRequest request) { super(); @@ -50,14 +53,21 @@ public class WriteException extends IOException { /** * Creates a new exception. + * + * @param request The associated {@link WriteRequest} + * @param message The detail message */ - public WriteException(WriteRequest request, String s) { - super(s); + public WriteException(WriteRequest request, String message) { + super(message); this.requests = asRequestList(request); } /** * Creates a new exception. + * + * @param request The associated {@link WriteRequest} + * @param message The detail message + * @param cause The Exception's cause */ public WriteException(WriteRequest request, String message, Throwable cause) { super(message); @@ -67,6 +77,9 @@ public class WriteException extends IOException { /** * Creates a new exception. + * + * @param request The associated {@link WriteRequest} + * @param cause The Exception's cause */ public WriteException(WriteRequest request, Throwable cause) { initCause(cause); @@ -75,6 +88,8 @@ public class WriteException extends IOException { /** * Creates a new exception. + * + * @param requests The collection of {@link WriteRequest}s */ public WriteException(Collection<WriteRequest> requests) { super(); @@ -83,14 +98,21 @@ public class WriteException extends IOException { /** * Creates a new exception. + * + * @param requests The collection of {@link WriteRequest}s + * @param message The detail message */ - public WriteException(Collection<WriteRequest> requests, String s) { - super(s); + public WriteException(Collection<WriteRequest> requests, String message) { + super(message); this.requests = asRequestList(requests); } /** * Creates a new exception. + * + * @param requests The collection of {@link WriteRequest}s + * @param message The detail message + * @param cause The Exception's cause */ public WriteException(Collection<WriteRequest> requests, String message, Throwable cause) { super(message); @@ -100,6 +122,9 @@ public class WriteException extends IOException { /** * Creates a new exception. + * + * @param requests The collection of {@link WriteRequest}s + * @param cause The Exception's cause */ public WriteException(Collection<WriteRequest> requests, Throwable cause) { initCause(cause); @@ -107,14 +132,14 @@ public class WriteException extends IOException { } /** - * Returns the list of the failed {@link WriteRequest}, in the order of occurrance. + * @return the list of the failed {@link WriteRequest}, in the order of occurrence. */ public List<WriteRequest> getRequests() { return requests; } /** - * Returns the firstly failed {@link WriteRequest}. + * @return the firstly failed {@link WriteRequest}. */ public WriteRequest getRequest() { return requests.get(0); @@ -124,12 +149,14 @@ public class WriteException extends IOException { if (requests == null) { throw new IllegalArgumentException("requests"); } + if (requests.isEmpty()) { throw new IllegalArgumentException("requests is empty."); } // Create a list of requests removing duplicates. Set<WriteRequest> newRequests = new MapBackedSet<WriteRequest>(new LinkedHashMap<WriteRequest, Boolean>()); + for (WriteRequest r : requests) { newRequests.add(r.getOriginalRequest()); } @@ -144,6 +171,7 @@ public class WriteException extends IOException { List<WriteRequest> requests = new ArrayList<WriteRequest>(1); requests.add(request.getOriginalRequest()); + return Collections.unmodifiableList(requests); } } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/core/write/WriteRequest.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/write/WriteRequest.java b/mina-core/src/main/java/org/apache/mina/core/write/WriteRequest.java index 5c421e2..9ee5c55 100644 --- a/mina-core/src/main/java/org/apache/mina/core/write/WriteRequest.java +++ b/mina-core/src/main/java/org/apache/mina/core/write/WriteRequest.java @@ -32,18 +32,18 @@ import org.apache.mina.core.session.IoSession; */ public interface WriteRequest { /** - * Returns the {@link WriteRequest} which was requested originally, + * @return the {@link WriteRequest} which was requested originally, * which is not transformed by any {@link IoFilter}. */ WriteRequest getOriginalRequest(); /** - * Returns {@link WriteFuture} that is associated with this write request. + * @return {@link WriteFuture} that is associated with this write request. */ WriteFuture getFuture(); /** - * Returns a message object to be written. + * @return a message object to be written. */ Object getMessage(); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/core/write/WriteRequestQueue.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/write/WriteRequestQueue.java b/mina-core/src/main/java/org/apache/mina/core/write/WriteRequestQueue.java index 1e64234..13ef972 100644 --- a/mina-core/src/main/java/org/apache/mina/core/write/WriteRequestQueue.java +++ b/mina-core/src/main/java/org/apache/mina/core/write/WriteRequestQueue.java @@ -63,8 +63,7 @@ public interface WriteRequestQueue { void dispose(IoSession session); /** - * Returns the number of objects currently stored in the queue. - * @return the size of the queue + * @return the number of objects currently stored in the queue. */ int size(); } http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/core/write/WriteRequestWrapper.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/write/WriteRequestWrapper.java b/mina-core/src/main/java/org/apache/mina/core/write/WriteRequestWrapper.java index a7454c5..0941d43 100644 --- a/mina-core/src/main/java/org/apache/mina/core/write/WriteRequestWrapper.java +++ b/mina-core/src/main/java/org/apache/mina/core/write/WriteRequestWrapper.java @@ -34,6 +34,8 @@ public class WriteRequestWrapper implements WriteRequest { /** * Creates a new instance that wraps the specified request. + * + * @param parentRequest The parent's request */ public WriteRequestWrapper(WriteRequest parentRequest) { if (parentRequest == null) { @@ -42,34 +44,52 @@ public class WriteRequestWrapper implements WriteRequest { this.parentRequest = parentRequest; } + /** + * {@inheritDoc} + */ public SocketAddress getDestination() { return parentRequest.getDestination(); } + /** + * {@inheritDoc} + */ public WriteFuture getFuture() { return parentRequest.getFuture(); } + /** + * {@inheritDoc} + */ public Object getMessage() { return parentRequest.getMessage(); } + /** + * {@inheritDoc} + */ public WriteRequest getOriginalRequest() { return parentRequest.getOriginalRequest(); } /** - * Returns the wrapped request object. + * @return the wrapped request object. */ public WriteRequest getParentRequest() { return parentRequest; } + /** + * {@inheritDoc} + */ @Override public String toString() { return "WR Wrapper" + parentRequest.toString(); } + /** + * {@inheritDoc} + */ public boolean isEncoded() { return false; } http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/filter/buffer/BufferedWriteFilter.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/buffer/BufferedWriteFilter.java b/mina-core/src/main/java/org/apache/mina/filter/buffer/BufferedWriteFilter.java index da7e35d..deb596f 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/buffer/BufferedWriteFilter.java +++ b/mina-core/src/main/java/org/apache/mina/filter/buffer/BufferedWriteFilter.java @@ -102,7 +102,7 @@ public final class BufferedWriteFilter extends IoFilterAdapter { } /** - * Returns buffer size. + * @return The buffer size. */ public int getBufferSize() { return bufferSize; http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/filter/codec/CumulativeProtocolDecoder.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/CumulativeProtocolDecoder.java b/mina-core/src/main/java/org/apache/mina/filter/codec/CumulativeProtocolDecoder.java index 867b40a..227fbfd 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/CumulativeProtocolDecoder.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/CumulativeProtocolDecoder.java @@ -207,15 +207,15 @@ public abstract class CumulativeProtocolDecoder extends ProtocolDecoderAdapter { * Implement this method to consume the specified cumulative buffer and * decode its content into message(s). * - * @param in - * the cumulative buffer + * @param session The current Session + * @param in the cumulative buffer + * @param out The {@link ProtocolDecoderOutput} that will receive the decoded message * @return <tt>true</tt> if and only if there's more to decode in the buffer * and you want to have <tt>doDecode</tt> method invoked again. * Return <tt>false</tt> if remaining data is not enough to decode, * then this method will be invoked again when more data is * cumulated. - * @throws Exception - * if cannot decode <tt>in</tt>. + * @throws Exception if cannot decode <tt>in</tt>. */ protected abstract boolean doDecode(IoSession session, IoBuffer in, ProtocolDecoderOutput out) throws Exception; http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolCodecException.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolCodecException.java b/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolCodecException.java index 43bd9d0..2da9354 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolCodecException.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolCodecException.java @@ -38,6 +38,8 @@ public class ProtocolCodecException extends Exception { /** * Constructs a new instance with the specified message. + * + * @param message The detail message */ public ProtocolCodecException(String message) { super(message); @@ -45,6 +47,8 @@ public class ProtocolCodecException extends Exception { /** * Constructs a new instance with the specified cause. + * + * @param cause The Exception's cause */ public ProtocolCodecException(Throwable cause) { super(cause); @@ -53,6 +57,9 @@ public class ProtocolCodecException extends Exception { /** * Constructs a new instance with the specified message and the specified * cause. + * + * @param message The detail message + * @param cause The Exception's cause */ public ProtocolCodecException(String message, Throwable cause) { super(message, cause); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolCodecFactory.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolCodecFactory.java b/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolCodecFactory.java index 17a94f3..73e1f43 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolCodecFactory.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolCodecFactory.java @@ -35,12 +35,20 @@ public interface ProtocolCodecFactory { /** * Returns a new (or reusable) instance of {@link ProtocolEncoder} which * encodes message objects into binary or protocol-specific data. + * + * @param session The current session + * @return The encoder instance + * @throws Exception If an error occurred while retrieving the encoder */ ProtocolEncoder getEncoder(IoSession session) throws Exception; /** * Returns a new (or reusable) instance of {@link ProtocolDecoder} which * decodes binary or protocol-specific data into message objects. + * + * @param session The current session + * @return The decoder instance + * @throws Exception If an error occurred while retrieving the decoder */ ProtocolDecoder getDecoder(IoSession session) throws Exception; } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolCodecSession.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolCodecSession.java b/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolCodecSession.java index de28695..4ef234a 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolCodecSession.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolCodecSession.java @@ -82,7 +82,7 @@ public class ProtocolCodecSession extends DummySession { } /** - * Returns the {@link ProtocolEncoderOutput} that buffers + * @return the {@link ProtocolEncoderOutput} that buffers * {@link IoBuffer}s generated by {@link ProtocolEncoder}. */ public ProtocolEncoderOutput getEncoderOutput() { @@ -90,14 +90,14 @@ public class ProtocolCodecSession extends DummySession { } /** - * Returns the {@link Queue} of the buffered encoder output. + * @return the {@link Queue} of the buffered encoder output. */ public Queue<Object> getEncoderOutputQueue() { return encoderOutput.getMessageQueue(); } /** - * Returns the {@link ProtocolEncoderOutput} that buffers + * @return the {@link ProtocolEncoderOutput} that buffers * messages generated by {@link ProtocolDecoder}. */ public ProtocolDecoderOutput getDecoderOutput() { @@ -105,7 +105,7 @@ public class ProtocolCodecSession extends DummySession { } /** - * Returns the {@link Queue} of the buffered decoder output. + * @return the {@link Queue} of the buffered decoder output. */ public Queue<Object> getDecoderOutputQueue() { return decoderOutput.getMessageQueue(); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolDecoder.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolDecoder.java b/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolDecoder.java index 16be8a1..b59a601 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolDecoder.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolDecoder.java @@ -44,6 +44,9 @@ public interface ProtocolDecoder { * method with read data, and then the decoder implementation puts decoded * messages into {@link ProtocolDecoderOutput}. * + * @param session The current Session + * @param in the buffer to decode + * @param out The {@link ProtocolDecoderOutput} that will receive the decoded message * @throws Exception if the read data violated protocol specification */ void decode(IoSession session, IoBuffer in, ProtocolDecoderOutput out) throws Exception; @@ -55,6 +58,8 @@ public interface ProtocolDecoder { * method to process the remaining data that {@link #decode(IoSession, IoBuffer, ProtocolDecoderOutput)} * method didn't process completely. * + * @param session The current Session + * @param out The {@link ProtocolDecoderOutput} that contains the decoded message * @throws Exception if the read data violated protocol specification */ void finishDecode(IoSession session, ProtocolDecoderOutput out) throws Exception; @@ -62,6 +67,7 @@ public interface ProtocolDecoder { /** * Releases all resources related with this decoder. * + * @param session The current Session * @throws Exception if failed to dispose all resources */ void dispose(IoSession session) throws Exception; http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolDecoderException.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolDecoderException.java b/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolDecoderException.java index 5ce5481..d1d36d1 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolDecoderException.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolDecoderException.java @@ -42,6 +42,8 @@ public class ProtocolDecoderException extends ProtocolCodecException { /** * Constructs a new instance with the specified message. + * + * @param message The detail message */ public ProtocolDecoderException(String message) { super(message); @@ -49,6 +51,8 @@ public class ProtocolDecoderException extends ProtocolCodecException { /** * Constructs a new instance with the specified cause. + * + * @param cause The Exception's cause */ public ProtocolDecoderException(Throwable cause) { super(cause); @@ -57,13 +61,16 @@ public class ProtocolDecoderException extends ProtocolCodecException { /** * Constructs a new instance with the specified message and the specified * cause. + * + * @param message The detail message + * @param cause The Exception's cause */ public ProtocolDecoderException(String message, Throwable cause) { super(message, cause); } /** - * Returns the message and the hexdump of the unknown part. + * @return the message and the hexdump of the unknown part. */ @Override public String getMessage() { @@ -81,7 +88,7 @@ public class ProtocolDecoderException extends ProtocolCodecException { } /** - * Returns the hexdump of the unknown message part. + * @return the hexdump of the unknown message part. */ public String getHexdump() { return hexdump; @@ -89,11 +96,14 @@ public class ProtocolDecoderException extends ProtocolCodecException { /** * Sets the hexdump of the unknown message part. + * + * @param hexdump The hexadecimal String representation of the message */ public void setHexdump(String hexdump) { if (this.hexdump != null) { throw new IllegalStateException("Hexdump cannot be set more than once."); } + this.hexdump = hexdump; } } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolDecoderOutput.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolDecoderOutput.java b/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolDecoderOutput.java index 8c75375..eecd1e5 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolDecoderOutput.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolDecoderOutput.java @@ -42,6 +42,9 @@ public interface ProtocolDecoderOutput { /** * Flushes all messages you wrote via {@link #write(Object)} to * the next filter. + * + * @param nextFilter the next Filter + * @param session The current Session */ void flush(NextFilter nextFilter, IoSession session); } http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolEncoder.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolEncoder.java b/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolEncoder.java index 58928df..8703b98 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolEncoder.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolEncoder.java @@ -46,6 +46,9 @@ public interface ProtocolEncoder { * the encoder implementation puts encoded messages (typically {@link IoBuffer}s) * into {@link ProtocolEncoderOutput}. * + * @param session The current Session + * @param message the message to encode + * @param out The {@link ProtocolEncoderOutput} that will receive the encoded message * @throws Exception if the message violated protocol specification */ void encode(IoSession session, Object message, ProtocolEncoderOutput out) throws Exception; @@ -53,6 +56,7 @@ public interface ProtocolEncoder { /** * Releases all resources related with this encoder. * + * @param session The current Session * @throws Exception if failed to dispose all resources */ void dispose(IoSession session) throws Exception; http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolEncoderException.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolEncoderException.java b/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolEncoderException.java index f5eb978..d999565 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolEncoderException.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/ProtocolEncoderException.java @@ -37,6 +37,8 @@ public class ProtocolEncoderException extends ProtocolCodecException { /** * Constructs a new instance with the specified message. + * + * @param message The detail message */ public ProtocolEncoderException(String message) { super(message); @@ -44,6 +46,8 @@ public class ProtocolEncoderException extends ProtocolCodecException { /** * Constructs a new instance with the specified cause. + * + * @param cause The Exception's cause */ public ProtocolEncoderException(Throwable cause) { super(cause); @@ -52,6 +56,9 @@ public class ProtocolEncoderException extends ProtocolCodecException { /** * Constructs a new instance with the specified message and the specified * cause. + * + * @param message The detail message + * @param cause The Exception's cause */ public ProtocolEncoderException(String message, Throwable cause) { super(message, cause); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/filter/codec/SynchronizedProtocolDecoder.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/SynchronizedProtocolDecoder.java b/mina-core/src/main/java/org/apache/mina/filter/codec/SynchronizedProtocolDecoder.java index 8990ab9..6cb1d69 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/SynchronizedProtocolDecoder.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/SynchronizedProtocolDecoder.java @@ -38,16 +38,19 @@ public class SynchronizedProtocolDecoder implements ProtocolDecoder { /** * Creates a new instance which decorates the specified <tt>decoder</tt>. + * + * @param decoder The decorated decoder */ public SynchronizedProtocolDecoder(ProtocolDecoder decoder) { if (decoder == null) { throw new IllegalArgumentException("decoder"); } + this.decoder = decoder; } /** - * Returns the decoder this decoder is decorating. + * @return the decoder this decoder is decorating. */ public ProtocolDecoder getDecoder() { return decoder; @@ -59,12 +62,18 @@ public class SynchronizedProtocolDecoder implements ProtocolDecoder { } } + /** + * {@inheritDoc} + */ public void finishDecode(IoSession session, ProtocolDecoderOutput out) throws Exception { synchronized (decoder) { decoder.finishDecode(session, out); } } + /** + * {@inheritDoc} + */ public void dispose(IoSession session) throws Exception { synchronized (decoder) { decoder.dispose(session); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/filter/codec/SynchronizedProtocolEncoder.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/SynchronizedProtocolEncoder.java b/mina-core/src/main/java/org/apache/mina/filter/codec/SynchronizedProtocolEncoder.java index 1ec2924..49c7c66 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/SynchronizedProtocolEncoder.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/SynchronizedProtocolEncoder.java @@ -36,6 +36,7 @@ public class SynchronizedProtocolEncoder implements ProtocolEncoder { /** * Creates a new instance which decorates the specified <tt>encoder</tt>. + * @param encoder The decorated encoder */ public SynchronizedProtocolEncoder(ProtocolEncoder encoder) { if (encoder == null) { @@ -45,18 +46,24 @@ public class SynchronizedProtocolEncoder implements ProtocolEncoder { } /** - * Returns the encoder this encoder is decorating. + * @return the encoder this encoder is decorating. */ public ProtocolEncoder getEncoder() { return encoder; } + /** + * {@inheritDoc} + */ public void encode(IoSession session, Object message, ProtocolEncoderOutput out) throws Exception { synchronized (encoder) { encoder.encode(session, message, out); } } + /** + * {@inheritDoc} + */ public void dispose(IoSession session) throws Exception { synchronized (encoder) { encoder.dispose(session); http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.java b/mina-core/src/main/java/org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.java index 361a431..4cf6853 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.java @@ -32,20 +32,29 @@ import org.apache.mina.filter.codec.ProtocolDecoderOutput; * decoding requests into an appropriate {@link MessageDecoder}. * * <h2>Internal mechanism of {@link MessageDecoder} selection</h2> - * <p> * <ol> - * <li>{@link DemuxingProtocolDecoder} iterates the list of candidate - * {@link MessageDecoder}s and calls {@link MessageDecoder#decodable(IoSession, IoBuffer)}. - * Initially, all registered {@link MessageDecoder}s are candidates.</li> - * <li>If {@link MessageDecoderResult#NOT_OK} is returned, it is removed from the candidate - * list.</li> - * <li>If {@link MessageDecoderResult#NEED_DATA} is returned, it is retained in the candidate + * <li> + * {@link DemuxingProtocolDecoder} iterates the list of candidate + * {@link MessageDecoder}s and calls {@link MessageDecoder#decodable(IoSession, IoBuffer)}. + * Initially, all registered {@link MessageDecoder}s are candidates. + * </li> + * <li> + * If {@link MessageDecoderResult#NOT_OK} is returned, it is removed from the candidate + * list. + * </li> + * <li> + * If {@link MessageDecoderResult#NEED_DATA} is returned, it is retained in the candidate * list, and its {@link MessageDecoder#decodable(IoSession, IoBuffer)} will be invoked - * again when more data is received.</li> - * <li>If {@link MessageDecoderResult#OK} is returned, {@link DemuxingProtocolDecoder} - * found the right {@link MessageDecoder}.</li> - * <li>If there's no candidate left, an exception is raised. Otherwise, + * again when more data is received. + * </li> + * <li> + * If {@link MessageDecoderResult#OK} is returned, {@link DemuxingProtocolDecoder} + * found the right {@link MessageDecoder}. + * </li> + * <li> + * If there's no candidate left, an exception is raised. Otherwise, * {@link DemuxingProtocolDecoder} will keep iterating the candidate list. + * </li> * </ol> * * Please note that any change of position and limit of the specified {@link IoBuffer} @@ -56,13 +65,19 @@ import org.apache.mina.filter.codec.ProtocolDecoderOutput; * {@link MessageDecoder#decode(IoSession, IoBuffer, ProtocolDecoderOutput)} continuously * reading its return value: * <ul> - * <li>{@link MessageDecoderResult#NOT_OK} - protocol violation; {@link ProtocolDecoderException} - * is raised automatically.</li> - * <li>{@link MessageDecoderResult#NEED_DATA} - needs more data to read the whole message; - * {@link MessageDecoder#decode(IoSession, IoBuffer, ProtocolDecoderOutput)} - * will be invoked again when more data is received.</li> - * <li>{@link MessageDecoderResult#OK} - successfully decoded a message; the candidate list will - * be reset and the selection process will start over.</li> + * <li> + * {@link MessageDecoderResult#NOT_OK} - protocol violation; {@link ProtocolDecoderException} + * is raised automatically. + * </li> + * <li> + * {@link MessageDecoderResult#NEED_DATA} - needs more data to read the whole message; + * {@link MessageDecoder#decode(IoSession, IoBuffer, ProtocolDecoderOutput)} + * will be invoked again when more data is received. + * </li> + * <li> + * {@link MessageDecoderResult#OK} - successfully decoded a message; the candidate list will + * be reset and the selection process will start over. + * </li> * </ul> * * @author <a href="http://mina.apache.org";>Apache MINA Project</a> http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageDecoder.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageDecoder.java b/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageDecoder.java index 0f2ad70..66b3605 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageDecoder.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageDecoder.java @@ -60,6 +60,8 @@ public interface MessageDecoder { /** * Checks the specified buffer is decodable by this decoder. * + * @param session The current session + * @param in The buffer containing the data to decode * @return {@link #OK} if this decoder can decode the specified buffer. * {@link #NOT_OK} if this decoder cannot decode the specified buffer. * {@link #NEED_DATA} if more data is required to determine if the @@ -74,10 +76,12 @@ public interface MessageDecoder { * method with read data, and then the decoder implementation puts decoded * messages into {@link ProtocolDecoderOutput}. * + * @param session The current session + * @param in The buffer containing the data to decode + * @param out The instance of {@link ProtocolDecoderOutput} that will receive the decoded messages * @return {@link #OK} if you finished decoding messages successfully. * {@link #NEED_DATA} if you need more data to finish decoding current message. * {@link #NOT_OK} if you cannot decode current message due to protocol specification violation. - * * @throws Exception if the read data violated protocol specification */ MessageDecoderResult decode(IoSession session, IoBuffer in, ProtocolDecoderOutput out) throws Exception; @@ -90,6 +94,8 @@ public interface MessageDecoder { * {@link #decode(IoSession, IoBuffer, ProtocolDecoderOutput)} method didn't process * completely. * + * @param session The current session + * @param out The instance of {@link ProtocolDecoderOutput} that contains the decoded messages * @throws Exception if the read data violated protocol specification */ void finishDecode(IoSession session, ProtocolDecoderOutput out) throws Exception; http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageDecoderFactory.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageDecoderFactory.java b/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageDecoderFactory.java index a6e4ecc..6ad6cdc 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageDecoderFactory.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageDecoderFactory.java @@ -29,6 +29,9 @@ package org.apache.mina.filter.codec.demux; public interface MessageDecoderFactory { /** * Creates a new message decoder. + * + * @return The created decoder + * @throws Exception If we weren't able to create the decoder */ MessageDecoder getDecoder() throws Exception; } http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageEncoder.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageEncoder.java b/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageEncoder.java index fd9155b..31ceb70 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageEncoder.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageEncoder.java @@ -34,6 +34,8 @@ import org.apache.mina.filter.codec.ProtocolEncoderOutput; * * @see DemuxingProtocolEncoder * @see MessageEncoderFactory + * + * @param T The message type */ public interface MessageEncoder<T> { /** @@ -43,6 +45,9 @@ public interface MessageEncoder<T> { * the encoder implementation puts encoded {@link IoBuffer}s into * {@link ProtocolEncoderOutput}. * + * @param session The current session + * @param message The message to encode + * @param out The instance of {@link ProtocolEncoderOutput} that will receive the encoded message * @throws Exception if the message violated protocol specification */ void encode(IoSession session, T message, ProtocolEncoderOutput out) throws Exception; http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageEncoderFactory.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageEncoderFactory.java b/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageEncoderFactory.java index f7ce5a3..cc4e213 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageEncoderFactory.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageEncoderFactory.java @@ -25,10 +25,15 @@ package org.apache.mina.filter.codec.demux; * @author <a href="http://mina.apache.org";>Apache MINA Project</a> * * @see DemuxingProtocolEncoder + * + * @param T the message type */ public interface MessageEncoderFactory<T> { /** * Creates a new message encoder. + * + * @return The created encoder + * @throws Exception If we weren't able to create an encoder */ MessageEncoder<T> getEncoder() throws Exception; } http://git-wip-us.apache.org/repos/asf/mina/blob/6f0509f7/mina-core/src/main/java/org/apache/mina/filter/codec/prefixedstring/PrefixedStringCodecFactory.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/prefixedstring/PrefixedStringCodecFactory.java b/mina-core/src/main/java/org/apache/mina/filter/codec/prefixedstring/PrefixedStringCodecFactory.java index 6d7193a..4f8cdbf 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/prefixedstring/PrefixedStringCodecFactory.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/prefixedstring/PrefixedStringCodecFactory.java @@ -77,11 +77,9 @@ public class PrefixedStringCodecFactory implements ProtocolCodecFactory { } /** - * Returns the allowed maximum size of a decoded string. + * @return the allowed maximum size of a decoded string. * <p> * This method does the same job as {@link PrefixedStringEncoder#setMaxDataLength(int)}. - * - * @return the allowed maximum size of an encoded string. * @see #setDecoderMaxDataLength(int) */ public int getDecoderMaxDataLength() {
