Repository: mina Updated Branches: refs/heads/2.0 c24642913 -> 09b337521
Fixed some missing javadoc Project: http://git-wip-us.apache.org/repos/asf/mina/repo Commit: http://git-wip-us.apache.org/repos/asf/mina/commit/4eb0a0ca Tree: http://git-wip-us.apache.org/repos/asf/mina/tree/4eb0a0ca Diff: http://git-wip-us.apache.org/repos/asf/mina/diff/4eb0a0ca Branch: refs/heads/2.0 Commit: 4eb0a0ca7ba32d1e3a38b7d1fc6bfed9b413591a Parents: c246429 Author: Emmanuel Lécharny <elecha...@symas.com> Authored: Mon Dec 5 22:01:00 2016 +0100 Committer: Emmanuel Lécharny <elecha...@symas.com> Committed: Mon Dec 5 22:01:00 2016 +0100 ---------------------------------------------------------------------- .../apache/mina/core/polling/AbstractPollingIoAcceptor.java | 2 +- .../src/main/java/org/apache/mina/core/service/IoService.java | 1 + .../org/apache/mina/core/session/ExpiringSessionRecycler.java | 2 +- .../org/apache/mina/filter/buffer/BufferedWriteFilter.java | 2 +- .../apache/mina/filter/codec/demux/MessageDecoderResult.java | 4 ++++ .../codec/serialization/ObjectSerializationInputStream.java | 2 +- .../mina/filter/codec/statemachine/DecodingStateMachine.java | 6 +++--- .../apache/mina/filter/codec/statemachine/SkippingState.java | 2 +- .../org/apache/mina/filter/stream/FileRegionWriteFilter.java | 1 + .../mina/handler/multiton/SingleSessionIoHandlerAdapter.java | 2 +- .../java/org/apache/mina/handler/stream/StreamIoHandler.java | 2 +- .../java/org/apache/mina/proxy/session/ProxyIoSession.java | 2 +- .../apache/mina/transport/socket/nio/NioSocketConnector.java | 1 - .../org/apache/mina/transport/socket/nio/NioSocketSession.java | 2 +- 14 files changed, 18 insertions(+), 13 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mina/blob/4eb0a0ca/mina-core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoAcceptor.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoAcceptor.java b/mina-core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoAcceptor.java index 7a80f1e..86cc31f 100644 --- a/mina-core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoAcceptor.java +++ b/mina-core/src/main/java/org/apache/mina/core/polling/AbstractPollingIoAcceptor.java @@ -199,7 +199,7 @@ public abstract class AbstractPollingIoAcceptor<S extends AbstractIoSession, H> * events. If a null {@link Executor} is provided, a default one will be * created using {@link Executors#newCachedThreadPool()}. * - * @see AbstractIoService(IoSessionConfig, Executor) + * @see #AbstractIoService(IoSessionConfig, Executor) * * @param sessionConfig * the default configuration for the managed {@link IoSession} http://git-wip-us.apache.org/repos/asf/mina/blob/4eb0a0ca/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 31be6f7..2b20014 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 @@ -19,6 +19,7 @@ */ package org.apache.mina.core.service; +import java.util.Collection; import java.util.Map; import java.util.Set; http://git-wip-us.apache.org/repos/asf/mina/blob/4eb0a0ca/mina-core/src/main/java/org/apache/mina/core/session/ExpiringSessionRecycler.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/core/session/ExpiringSessionRecycler.java b/mina-core/src/main/java/org/apache/mina/core/session/ExpiringSessionRecycler.java index 430d3c3..8c9edc8 100644 --- a/mina-core/src/main/java/org/apache/mina/core/session/ExpiringSessionRecycler.java +++ b/mina-core/src/main/java/org/apache/mina/core/session/ExpiringSessionRecycler.java @@ -57,7 +57,7 @@ public class ExpiringSessionRecycler implements IoSessionRecycler { * Create a new ExpiringSessionRecycler instance * * @param timeToLive The delay after which the session is going to be recycled - * @param expirationInterval + * @param expirationInterval The delay after which the expiration occurs */ public ExpiringSessionRecycler(int timeToLive, int expirationInterval) { sessionMap = new ExpiringMap<>(timeToLive, expirationInterval); http://git-wip-us.apache.org/repos/asf/mina/blob/4eb0a0ca/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 deb596f..b390260 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 @@ -150,7 +150,7 @@ public final class BufferedWriteFilter extends IoFilterAdapter { /** * Writes <code>data</code> {@link IoBuffer} to the <code>buf</code> * {@link IoBuffer} which buffers write requests for the - * <code>session</code> {@ link IoSession} until buffer is full + * <code>session</code> {@link IoSession} until buffer is full * or manually flushed. * * @param session the session where buffer will be written http://git-wip-us.apache.org/repos/asf/mina/blob/4eb0a0ca/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageDecoderResult.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageDecoderResult.java b/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageDecoderResult.java index 1d14b4a..d57c22c 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageDecoderResult.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/demux/MessageDecoderResult.java @@ -19,6 +19,10 @@ */ package org.apache.mina.filter.codec.demux; +import org.apache.mina.core.buffer.IoBuffer; +import org.apache.mina.core.session.IoSession; +import org.apache.mina.filter.codec.ProtocolDecoderOutput; + /** * Represents results from {@link MessageDecoder}. * http://git-wip-us.apache.org/repos/asf/mina/blob/4eb0a0ca/mina-core/src/main/java/org/apache/mina/filter/codec/serialization/ObjectSerializationInputStream.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/serialization/ObjectSerializationInputStream.java b/mina-core/src/main/java/org/apache/mina/filter/codec/serialization/ObjectSerializationInputStream.java index d9fa1c4..d96ea8f 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/serialization/ObjectSerializationInputStream.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/serialization/ObjectSerializationInputStream.java @@ -188,7 +188,7 @@ public class ObjectSerializationInputStream extends InputStream implements Objec /** * @see DataInput#readLine() - * @deprecated + * @deprecated Bytes are not properly converted to chars */ @Deprecated public String readLine() throws IOException { http://git-wip-us.apache.org/repos/asf/mina/blob/4eb0a0ca/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/DecodingStateMachine.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/DecodingStateMachine.java b/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/DecodingStateMachine.java index 54bdb6f..2acec27 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/DecodingStateMachine.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/DecodingStateMachine.java @@ -31,15 +31,15 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Abstract base class for decoder state machines. Calls {@link #init()} to + * Abstract base class for decoder state machines. Calls init() to * get the start {@link DecodingState} of the state machine. Calls - * {@link #destroy()} when the state machine has reached its end state or when + * destroy() when the state machine has reached its end state or when * the session is closed. * <p> * NOTE: The {@link ProtocolDecoderOutput} used by this class when calling * {@link DecodingState#decode(IoBuffer, ProtocolDecoderOutput)} buffers decoded * messages in a {@link List}. Once the state machine has reached its end state - * this class will call {@link #finishDecode(List, ProtocolDecoderOutput)}. The + * this class will call finishDecode(List, ProtocolDecoderOutput). The * implementation will have to take care of writing the decoded messages to the * real {@link ProtocolDecoderOutput} used by the configured * {@link ProtocolCodecFilter}. http://git-wip-us.apache.org/repos/asf/mina/blob/4eb0a0ca/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/SkippingState.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/SkippingState.java b/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/SkippingState.java index ca14766..59956d4 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/SkippingState.java +++ b/mina-core/src/main/java/org/apache/mina/filter/codec/statemachine/SkippingState.java @@ -23,7 +23,7 @@ import org.apache.mina.core.buffer.IoBuffer; import org.apache.mina.filter.codec.ProtocolDecoderOutput; /** - * {@link DecodingState} which skips data until {@link #canSkip(byte)} returns + * {@link DecodingState} which skips data until canSkip(byte) returns * <tt>false</tt>. * * @author <a href="http://mina.apache.org";>Apache MINA Project</a> http://git-wip-us.apache.org/repos/asf/mina/blob/4eb0a0ca/mina-core/src/main/java/org/apache/mina/filter/stream/FileRegionWriteFilter.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/filter/stream/FileRegionWriteFilter.java b/mina-core/src/main/java/org/apache/mina/filter/stream/FileRegionWriteFilter.java index 7d1c5ea..8bf0c96 100644 --- a/mina-core/src/main/java/org/apache/mina/filter/stream/FileRegionWriteFilter.java +++ b/mina-core/src/main/java/org/apache/mina/filter/stream/FileRegionWriteFilter.java @@ -23,6 +23,7 @@ import java.io.IOException; import org.apache.mina.core.buffer.IoBuffer; import org.apache.mina.core.file.FileRegion; +import org.apache.mina.core.session.IoSession; /** * Filter implementation that converts a {@link FileRegion} to {@link IoBuffer} http://git-wip-us.apache.org/repos/asf/mina/blob/4eb0a0ca/mina-core/src/main/java/org/apache/mina/handler/multiton/SingleSessionIoHandlerAdapter.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/handler/multiton/SingleSessionIoHandlerAdapter.java b/mina-core/src/main/java/org/apache/mina/handler/multiton/SingleSessionIoHandlerAdapter.java index a7ce9e2..d54ebc7 100644 --- a/mina-core/src/main/java/org/apache/mina/handler/multiton/SingleSessionIoHandlerAdapter.java +++ b/mina-core/src/main/java/org/apache/mina/handler/multiton/SingleSessionIoHandlerAdapter.java @@ -25,7 +25,7 @@ import org.apache.mina.core.session.IoSession; /** * Adapter class for implementors of the {@link SingleSessionIoHandler} * interface. The session to which the handler is assigned is accessible - * through the {@link #getSession()} method. + * through the getSession() method. * * @author <a href="http://mina.apache.org";>Apache MINA Project</a> */ http://git-wip-us.apache.org/repos/asf/mina/blob/4eb0a0ca/mina-core/src/main/java/org/apache/mina/handler/stream/StreamIoHandler.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/handler/stream/StreamIoHandler.java b/mina-core/src/main/java/org/apache/mina/handler/stream/StreamIoHandler.java index 3a18f6d..7249524 100644 --- a/mina-core/src/main/java/org/apache/mina/handler/stream/StreamIoHandler.java +++ b/mina-core/src/main/java/org/apache/mina/handler/stream/StreamIoHandler.java @@ -37,7 +37,7 @@ import org.slf4j.LoggerFactory; * A {@link IoHandler} that adapts asynchronous MINA events to stream I/O. * <p> * Please extend this class and implement - * {@link #processStreamIo(IoSession, InputStream, OutputStream)} to + * processStreamIo(IoSession, InputStream, OutputStream) to * execute your stream I/O logic; <b>please note that you must forward * the process request to other thread or thread pool.</b> * http://git-wip-us.apache.org/repos/asf/mina/blob/4eb0a0ca/mina-core/src/main/java/org/apache/mina/proxy/session/ProxyIoSession.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/proxy/session/ProxyIoSession.java b/mina-core/src/main/java/org/apache/mina/proxy/session/ProxyIoSession.java index dad537f..c589a86 100644 --- a/mina-core/src/main/java/org/apache/mina/proxy/session/ProxyIoSession.java +++ b/mina-core/src/main/java/org/apache/mina/proxy/session/ProxyIoSession.java @@ -281,7 +281,7 @@ public class ProxyIoSession { } /** - * @return the used charset name or {@link #DEFAULT_ENCODING} if null. + * @return the used charset name or DEFAULT_ENCODING if null. */ public String getCharsetName() { if (charsetName == null) { http://git-wip-us.apache.org/repos/asf/mina/blob/4eb0a0ca/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioSocketConnector.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioSocketConnector.java b/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioSocketConnector.java index 889b046..bd1cf00 100644 --- a/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioSocketConnector.java +++ b/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioSocketConnector.java @@ -115,7 +115,6 @@ SocketConnector { * * @param processorClass the processor class. * @see SimpleIoProcessorPool#SimpleIoProcessorPool(Class, Executor, int, java.nio.channels.spi.SelectorProvider) - * @see org.apache.mina.core.service.SimpleIoProcessorPool#DEFAULT_SIZE * @since 2.0.0-M4 */ public NioSocketConnector(Class<? extends IoProcessor<NioSession>> processorClass) { http://git-wip-us.apache.org/repos/asf/mina/blob/4eb0a0ca/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioSocketSession.java ---------------------------------------------------------------------- diff --git a/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioSocketSession.java b/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioSocketSession.java index 2892658..8948c55 100644 --- a/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioSocketSession.java +++ b/mina-core/src/main/java/org/apache/mina/transport/socket/nio/NioSocketSession.java @@ -56,7 +56,7 @@ class NioSocketSession extends NioSession { * * @param service the associated IoService * @param processor the associated IoProcessor - * @param ch the used channel + * @param channel the used channel */ public NioSocketSession(IoService service, IoProcessor<NioSession> processor, SocketChannel channel) { super(processor, service, channel);
