You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by el...@apache.org on 2015/12/17 18:50:06 UTC
[1/2] mina git commit: Many fixes in Javadoc
Repository: mina
Updated Branches:
refs/heads/2.0 6c10270cd -> b0958bd5b
http://git-wip-us.apache.org/repos/asf/mina/blob/b0958bd5/mina-core/src/main/java/org/apache/mina/handler/demux/DemuxingIoHandler.java
----------------------------------------------------------------------
diff --git a/mina-core/src/main/java/org/apache/mina/handler/demux/DemuxingIoHandler.java b/mina-core/src/main/java/org/apache/mina/handler/demux/DemuxingIoHandler.java
index 9911d04..5243932 100644
--- a/mina-core/src/main/java/org/apache/mina/handler/demux/DemuxingIoHandler.java
+++ b/mina-core/src/main/java/org/apache/mina/handler/demux/DemuxingIoHandler.java
@@ -37,7 +37,6 @@ import org.apache.mina.util.IdentityHashSet;
* You can freely register and deregister {@link MessageHandler}s using
* {@link #addReceivedMessageHandler(Class, MessageHandler)} and
* {@link #removeReceivedMessageHandler(Class)}.
- * </p>
* <p>
* When <code>message</code> is received through a call to
* {@link #messageReceived(IoSession, Object)} the class of the
@@ -48,7 +47,6 @@ import org.apache.mina.util.IdentityHashSet;
* order. If no match can be found for any of the interfaces the search will be
* repeated recursively for the superclass of the immediate class
* (i.e. <code>message.getClass().getSuperclass()</code>).
- * </p>
* <p>
* Consider the following type hierarchy (<code>Cx</code> are classes while
* <code>Ix</code> are interfaces):
@@ -67,12 +65,10 @@ import org.apache.mina.util.IdentityHashSet;
* When <code>message</code> is of type <code>C3</code> this hierarchy will be
* searched in the following order:
* <code>C3, I7, I8, I9, I3, I4, C2, I5, I6, C1, I1, I2, I3, I4, Object</code>.
- * </p>
* <p>
* For efficiency searches will be cached. Calls to
* {@link #addReceivedMessageHandler(Class, MessageHandler)} and
* {@link #removeReceivedMessageHandler(Class)} clear this cache.
- * </p>
*
* @author <a href="http://mina.apache.org">Apache MINA Project</a>
*/
http://git-wip-us.apache.org/repos/asf/mina/blob/b0958bd5/mina-core/src/main/java/org/apache/mina/proxy/ProxyConnector.java
----------------------------------------------------------------------
diff --git a/mina-core/src/main/java/org/apache/mina/proxy/ProxyConnector.java b/mina-core/src/main/java/org/apache/mina/proxy/ProxyConnector.java
index 257b15b..a1ab0b8 100644
--- a/mina-core/src/main/java/org/apache/mina/proxy/ProxyConnector.java
+++ b/mina-core/src/main/java/org/apache/mina/proxy/ProxyConnector.java
@@ -104,7 +104,6 @@ public class ProxyConnector extends AbstractIoConnector {
/**
* Creates a new proxy connector.
- * @see AbstractIoConnector#AbstractIoConnector(IoSessionConfig, Executor).
*/
public ProxyConnector(final SocketConnector connector, IoSessionConfig config, Executor executor) {
super(config, executor);
http://git-wip-us.apache.org/repos/asf/mina/blob/b0958bd5/mina-core/src/main/java/org/apache/mina/proxy/handlers/socks/Socks4LogicHandler.java
----------------------------------------------------------------------
diff --git a/mina-core/src/main/java/org/apache/mina/proxy/handlers/socks/Socks4LogicHandler.java b/mina-core/src/main/java/org/apache/mina/proxy/handlers/socks/Socks4LogicHandler.java
index 6b55eb1..9903316 100644
--- a/mina-core/src/main/java/org/apache/mina/proxy/handlers/socks/Socks4LogicHandler.java
+++ b/mina-core/src/main/java/org/apache/mina/proxy/handlers/socks/Socks4LogicHandler.java
@@ -126,7 +126,7 @@ public class Socks4LogicHandler extends AbstractSocksLogicHandler {
* if access is granted.
*
* @param buf the buffer holding the server response data.
- * @throws exception if server response is malformed or if request is rejected
+ * @throws Exception if server response is malformed or if request is rejected
* by the proxy server.
*/
protected void handleResponse(final IoBuffer buf) throws Exception {
http://git-wip-us.apache.org/repos/asf/mina/blob/b0958bd5/mina-example/src/main/java/org/apache/mina/example/proxy/Main.java
----------------------------------------------------------------------
diff --git a/mina-example/src/main/java/org/apache/mina/example/proxy/Main.java b/mina-example/src/main/java/org/apache/mina/example/proxy/Main.java
index 35c4718..aea4621 100644
--- a/mina-example/src/main/java/org/apache/mina/example/proxy/Main.java
+++ b/mina-example/src/main/java/org/apache/mina/example/proxy/Main.java
@@ -19,32 +19,36 @@
*/
package org.apache.mina.example.proxy;
+
import java.net.InetSocketAddress;
import org.apache.mina.core.service.IoConnector;
import org.apache.mina.transport.socket.nio.NioSocketAcceptor;
import org.apache.mina.transport.socket.nio.NioSocketConnector;
+
/**
* (<b>Entry point</b>) Demonstrates how to write a very simple tunneling proxy
* using MINA. The proxy only logs all data passing through it. This is only
* suitable for text based protocols since received data will be converted into
* strings before being logged.
* <p>
- * Start a proxy like this:<br/>
- * <code>org.apache.mina.example.proxy.Main 12345 www.google.com 80</code><br/>
+ * Start a proxy like this:<br>
+ * <code>org.apache.mina.example.proxy.Main 12345 www.google.com 80</code><br>
* and open <a href="http://localhost:12345">http://localhost:12345</a> in a
* browser window.
- * </p>
*
* @author <a href="http://mina.apache.org">Apache MINA Project</a>
*/
-public class Main {
+public class Main
+{
- public static void main(String[] args) throws Exception {
- if (args.length != 3) {
- System.out.println(Main.class.getName()
- + " <proxy-port> <server-hostname> <server-port>");
+ public static void main( String[] args ) throws Exception
+ {
+ if ( args.length != 3 )
+ {
+ System.out.println( Main.class.getName()
+ + " <proxy-port> <server-hostname> <server-port>" );
return;
}
@@ -55,16 +59,16 @@ public class Main {
IoConnector connector = new NioSocketConnector();
// Set connect timeout.
- connector.setConnectTimeoutMillis(30*1000L);
+ connector.setConnectTimeoutMillis( 30 * 1000L );
- ClientToProxyIoHandler handler = new ClientToProxyIoHandler(connector,
- new InetSocketAddress(args[1], Integer.parseInt(args[2])));
+ ClientToProxyIoHandler handler = new ClientToProxyIoHandler( connector,
+ new InetSocketAddress( args[1], Integer.parseInt( args[2] ) ) );
// Start proxy.
- acceptor.setHandler(handler);
- acceptor.bind(new InetSocketAddress(Integer.parseInt(args[0])));
+ acceptor.setHandler( handler );
+ acceptor.bind( new InetSocketAddress( Integer.parseInt( args[0] ) ) );
- System.out.println("Listening on port " + Integer.parseInt(args[0]));
+ System.out.println( "Listening on port " + Integer.parseInt( args[0] ) );
}
}
http://git-wip-us.apache.org/repos/asf/mina/blob/b0958bd5/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/MethodSelfTransition.java
----------------------------------------------------------------------
diff --git a/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/MethodSelfTransition.java b/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/MethodSelfTransition.java
index 3e39c2e..3d1c464 100644
--- a/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/MethodSelfTransition.java
+++ b/mina-statemachine/src/main/java/org/apache/mina/statemachine/transition/MethodSelfTransition.java
@@ -36,7 +36,7 @@ import org.slf4j.LoggerFactory;
* Normally you wouldn't create instances of this class directly but rather use
* the {@link SelfTransition} annotation to define the methods which should be
* used as transitions in your state machine and then let
- * {@link org.apache.mina.statemachine#StateMachineFactory} create a
+ * {@link org.apache.mina.statemachine.StateMachineFactory} create a
* {@link StateMachine} for you.
* </p>
*
[2/2] mina git commit: Many fixes in Javadoc
Posted by el...@apache.org.
Many fixes in Javadoc
Project: http://git-wip-us.apache.org/repos/asf/mina/repo
Commit: http://git-wip-us.apache.org/repos/asf/mina/commit/b0958bd5
Tree: http://git-wip-us.apache.org/repos/asf/mina/tree/b0958bd5
Diff: http://git-wip-us.apache.org/repos/asf/mina/diff/b0958bd5
Branch: refs/heads/2.0
Commit: b0958bd5b73e32f373fa54b8a06f1bc95fbc32be
Parents: 6c10270
Author: Emmanuel Lécharny <el...@symas.com>
Authored: Thu Dec 17 18:49:10 2015 +0100
Committer: Emmanuel Lécharny <el...@symas.com>
Committed: Thu Dec 17 18:49:10 2015 +0100
----------------------------------------------------------------------
.../org/apache/mina/core/buffer/IoBuffer.java | 709 +++++++++++++------
.../org/apache/mina/core/future/IoFuture.java | 4 +-
.../core/session/IoSessionAttributeMap.java | 4 +-
.../filter/codec/CumulativeProtocolDecoder.java | 59 +-
.../PrefixedStringCodecFactory.java | 8 +-
.../mina/filter/keepalive/KeepAliveFilter.java | 132 ++--
.../mina/filter/logging/MdcInjectionFilter.java | 2 +-
.../mina/filter/ssl/SslContextFactory.java | 12 -
.../mina/filter/stream/StreamWriteFilter.java | 6 +-
.../mina/handler/demux/DemuxingIoHandler.java | 4 -
.../org/apache/mina/proxy/ProxyConnector.java | 1 -
.../handlers/socks/Socks4LogicHandler.java | 2 +-
.../org/apache/mina/example/proxy/Main.java | 32 +-
.../transition/MethodSelfTransition.java | 2 +-
14 files changed, 612 insertions(+), 365 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mina/blob/b0958bd5/mina-core/src/main/java/org/apache/mina/core/buffer/IoBuffer.java
----------------------------------------------------------------------
diff --git a/mina-core/src/main/java/org/apache/mina/core/buffer/IoBuffer.java b/mina-core/src/main/java/org/apache/mina/core/buffer/IoBuffer.java
index 9c90ab0..8d78d56 100644
--- a/mina-core/src/main/java/org/apache/mina/core/buffer/IoBuffer.java
+++ b/mina-core/src/main/java/org/apache/mina/core/buffer/IoBuffer.java
@@ -43,15 +43,14 @@ import org.apache.mina.core.session.IoSession;
/**
* A byte buffer used by MINA applications.
* <p>
- * This is a replacement for {@link ByteBuffer}. Please refer to
- * {@link ByteBuffer} documentation for preliminary usage. MINA does not use NIO
- * {@link ByteBuffer} directly for two reasons:
- * <ul>
- * <li>It doesn't provide useful getters and putters such as <code>fill</code>,
- * <code>get/putString</code>, and <code>get/putAsciiInt()</code> enough.</li>
- * <li>It is difficult to write variable-length data due to its fixed capacity</li>
- * </ul>
- * </p>
+ * This is a replacement for {@link ByteBuffer}. Please refer to
+ * {@link ByteBuffer} documentation for preliminary usage. MINA does not use NIO
+ * {@link ByteBuffer} directly for two reasons:
+ * <ul>
+ * <li>It doesn't provide useful getters and putters such as <code>fill</code>,
+ * <code>get/putString</code>, and <code>get/putAsciiInt()</code> enough.</li>
+ * <li>It is difficult to write variable-length data due to its fixed capacity</li>
+ * </ul>
*
* <h2>Allocation</h2>
* <p>
@@ -77,13 +76,10 @@ import org.apache.mina.core.session.IoSession;
* IoBuffer buf = IoBuffer.allocate(1024);
* </pre>
*
- * </p>
- *
* <h2>Wrapping existing NIO buffers and arrays</h2>
* <p>
* This class provides a few <tt>wrap(...)</tt> methods that wraps any NIO
* buffers and byte arrays.
- * </p>
*
* <h2>AutoExpand</h2>
* <p>
@@ -106,7 +102,6 @@ import org.apache.mina.core.session.IoSession;
* the scene if the encoded data is larger than 16 bytes in the example above.
* Its capacity will double, and its limit will increase to the last position
* the string is written.
- * </p>
*
* <h2>AutoShrink</h2>
* <p>
@@ -116,11 +111,9 @@ import org.apache.mina.core.session.IoSession;
* <tt>autoShrink</tt> is turned on, {@link IoBuffer} halves the capacity of the
* buffer when {@link #compact()} is invoked and only 1/4 or less of the current
* capacity is being used.
- * </p>
* <p>
* You can also call the {@link #shrink()} method manually to shrink the capacity of the
* buffer.
- * </p>
* <p>
* The underlying {@link ByteBuffer} is reallocated by the {@link IoBuffer} behind
* the scene, and therefore {@link #buf()} will return a different
@@ -128,7 +121,6 @@ import org.apache.mina.core.session.IoSession;
* that the {@link #compact()} method or the {@link #shrink()} method
* will not decrease the capacity if the new capacity is less than the
* {@link #minimumCapacity()} of the buffer.
- * </p>
*
* <h2>Derived Buffers</h2>
* <p>
@@ -139,7 +131,6 @@ import org.apache.mina.core.session.IoSession;
* auto-expandable nor auto-shrinkable. Trying to call
* {@link #setAutoExpand(boolean)} or {@link #setAutoShrink(boolean)} with
* <tt>true</tt> parameter will raise an {@link IllegalStateException}.
- * </p>
*
* <h2>Changing Buffer Allocation Policy</h2>
* <p>
@@ -151,7 +142,6 @@ import org.apache.mina.core.session.IoSession;
* </ul>
* You can implement your own allocator and use it by calling
* {@link #setAllocator(IoBufferAllocator)}.
- * </p>
*
* @author <a href="http://mina.apache.org">Apache MINA Project</a>
*/
@@ -316,6 +306,8 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
/**
* @see ByteBuffer#isDirect()
+ *
+ * @return <tt>True</tt> if this is a direct buffer
*/
public abstract boolean isDirect();
@@ -328,6 +320,8 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
/**
* @see ByteBuffer#isReadOnly()
+ *
+ * @return <tt>true</tt> if the buffer is readOnly
*/
public abstract boolean isReadOnly();
@@ -352,6 +346,8 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
/**
* @see ByteBuffer#capacity()
+ *
+ * @return the buffer capacity
*/
public abstract int capacity();
@@ -402,7 +398,7 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
*
* </pre>
*
- * @param capacity the wanted capacity
+ * @param newCapacity the wanted capacity
* @return the underlying NIO {@link ByteBuffer} instance.
*/
public abstract IoBuffer capacity(int newCapacity);
@@ -465,7 +461,7 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
*
* You can still put ( L - pos ) bytes in the buffer
*
- * ( pos + V ) > L & ( pos + V ) <= C :
+ * ( pos + V ) > L & ( pos + V ) <= C :
*
* 0 L C
* +------------+------+
@@ -534,7 +530,7 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
*
* You can still put ( L - pos ) bytes in the buffer
*
- * ( pos + V ) > L & ( pos + V ) <= C :
+ * ( pos + V ) > L & ( pos + V ) <= C :
*
* P L C
* +------------+------+
@@ -622,42 +618,63 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
/**
* @see java.nio.Buffer#position()
+ * @return The current position in the buffer
*/
public abstract int position();
/**
* @see java.nio.Buffer#position(int)
+ *
+ * @param newPosition Sets the new position in the buffer
+ * @return the modified IoBuffer
+
*/
public abstract IoBuffer position(int newPosition);
/**
* @see java.nio.Buffer#limit()
+ *
+ * @return the modified IoBuffer
+'s limit
*/
public abstract int limit();
/**
* @see java.nio.Buffer#limit(int)
+ *
+ * @param newLimit The new buffer's limit
+ * @return the modified IoBuffer
+
*/
public abstract IoBuffer limit(int newLimit);
/**
* @see java.nio.Buffer#mark()
+ *
+ * @return the modified IoBuffer
+
*/
public abstract IoBuffer mark();
/**
- * Returns the position of the current mark. This method returns <tt>-1</tt>
+ * @return the position of the current mark. This method returns <tt>-1</tt>
* if no mark is set.
*/
public abstract int markValue();
/**
* @see java.nio.Buffer#reset()
+ *
+ * @return the modified IoBuffer
+
*/
public abstract IoBuffer reset();
/**
* @see java.nio.Buffer#clear()
+ *
+ * @return the modified IoBuffer
+
*/
public abstract IoBuffer clear();
@@ -665,6 +682,9 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Clears this buffer and fills its content with <tt>NUL</tt>. The position
* is set to zero, the limit is set to the capacity, and the mark is
* discarded.
+ *
+ * @return the modified IoBuffer
+
*/
public abstract IoBuffer sweep();
@@ -672,157 +692,246 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* double Clears this buffer and fills its content with <tt>value</tt>. The
* position is set to zero, the limit is set to the capacity, and the mark
* is discarded.
+ *
+ * @param value The value to put in the buffer
+ * @return the modified IoBuffer
+
*/
public abstract IoBuffer sweep(byte value);
/**
* @see java.nio.Buffer#flip()
+ *
+ * @return the modified IoBuffer
+
*/
public abstract IoBuffer flip();
/**
* @see java.nio.Buffer#rewind()
+ *
+ * @return the modified IoBuffer
+
*/
public abstract IoBuffer rewind();
/**
* @see java.nio.Buffer#remaining()
+ *
+ * @return The remaining bytes in the buffer
*/
public abstract int remaining();
/**
* @see java.nio.Buffer#hasRemaining()
+ *
+ * @return <tt>true</tt> if there are some reamining bytes in the buffer
*/
public abstract boolean hasRemaining();
/**
* @see ByteBuffer#duplicate()
+ *
+ * @return the modified IoBuffer
+
*/
public abstract IoBuffer duplicate();
/**
* @see ByteBuffer#slice()
+ *
+ * @return the modified IoBuffer
+
*/
public abstract IoBuffer slice();
/**
* @see ByteBuffer#asReadOnlyBuffer()
+ *
+ * @return the modified IoBuffer
+
*/
public abstract IoBuffer asReadOnlyBuffer();
/**
* @see ByteBuffer#hasArray()
+ *
+ * @return <tt>true</tt> if the {@link #array()} method will return a byte[]
*/
public abstract boolean hasArray();
/**
* @see ByteBuffer#array()
+ *
+ * @return A byte[] if this IoBuffer supports it
*/
public abstract byte[] array();
/**
* @see ByteBuffer#arrayOffset()
+ *
+ * @return The offset in the returned byte[] when the {@link #array()} method is called
*/
public abstract int arrayOffset();
/**
* @see ByteBuffer#get()
+ *
+ * @return The byte at the current position
*/
public abstract byte get();
/**
* Reads one unsigned byte as a short integer.
+ *
+ * @return the unsigned short at the current position
*/
public abstract short getUnsigned();
/**
* @see ByteBuffer#put(byte)
+ *
+ * @param b The byte to put in the buffer
+ * @return the modified IoBuffer
+
*/
public abstract IoBuffer put(byte b);
/**
* @see ByteBuffer#get(int)
+ *
+ * @param index The position for which we want to read a byte
+ * @return the byte at the given position
*/
public abstract byte get(int index);
/**
* Reads one byte as an unsigned short integer.
+ *
+ * @param index The position for which we want to read an unsigned byte
+ * @return the unsigned byte at the given position
*/
public abstract short getUnsigned(int index);
/**
* @see ByteBuffer#put(int, byte)
+ *
+ * @param index The position where the byte will be put
+ * @param b The byte to put
+ * @return the modified IoBuffer
+
*/
public abstract IoBuffer put(int index, byte b);
/**
* @see ByteBuffer#get(byte[], int, int)
+ *
+ * @param dst The destination buffer
+ * @param offset The position in the original buffer
+ * @param length The number of bytes to copy
+ * @return the modified IoBuffer
*/
public abstract IoBuffer get(byte[] dst, int offset, int length);
/**
* @see ByteBuffer#get(byte[])
+ *
+ * @return the IoBuffer
*/
public abstract IoBuffer get(byte[] dst);
/**
- * TODO document me.
+ * Get a new IoBuffer containing a slice of the current buffer
+ *
+ * @param index The position in the buffer
+ * @param length The number of bytes to copy
+ * @return the new IoBuffer
*/
public abstract IoBuffer getSlice(int index, int length);
/**
- * TODO document me.
+ * Get a new IoBuffer containing a slice of the current buffer
+ *
+ * @param length The number of bytes to copy
+ * @return the new IoBuffer
*/
public abstract IoBuffer getSlice(int length);
/**
* Writes the content of the specified <tt>src</tt> into this buffer.
+ *
+ * @param src The source ByteBuffer
+ * @return the modified IoBuffer
*/
public abstract IoBuffer put(ByteBuffer src);
/**
* Writes the content of the specified <tt>src</tt> into this buffer.
+ *
+ * @param src The source IoBuffer
+ * @return the modified IoBuffer
*/
public abstract IoBuffer put(IoBuffer src);
/**
* @see ByteBuffer#put(byte[], int, int)
+ *
+ * @param src The byte[] to put
+ * @param offset The position in the source
+ * @param length The number of bytes to copy
+ * @return the modified IoBuffer
*/
public abstract IoBuffer put(byte[] src, int offset, int length);
/**
* @see ByteBuffer#put(byte[])
+ *
+ * @param src The byte[] to put
+ * @return the modified IoBuffer
*/
public abstract IoBuffer put(byte[] src);
/**
* @see ByteBuffer#compact()
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer compact();
/**
* @see ByteBuffer#order()
+ *
+ * @return the IoBuffer ByteOrder
*/
public abstract ByteOrder order();
/**
* @see ByteBuffer#order(ByteOrder)
+ *
+ * @param bo The new ByteBuffer to use for this IoBuffer
+ * @return the modified IoBuffer
*/
public abstract IoBuffer order(ByteOrder bo);
/**
* @see ByteBuffer#getChar()
+ *
+ * @return The char at the current position
*/
public abstract char getChar();
/**
* @see ByteBuffer#putChar(char)
+ *
+ * @param value The char to put at the current position
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putChar(char value);
/**
* @see ByteBuffer#getChar(int)
*
+ * @param index The index in the IoBuffer where we will read a char from
* @return the char at 'index' position
*/
public abstract char getChar(int index);
@@ -830,6 +939,8 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
/**
* @see ByteBuffer#putChar(int, char)
*
+ * @param index The index in the IoBuffer where we will put a char in
+ * @param value The char to put at the current position
* @return the modified IoBuffer
*/
public abstract IoBuffer putChar(int index, char value);
@@ -843,46 +954,69 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
/**
* @see ByteBuffer#getShort()
+ *
+ * @return The read short
*/
public abstract short getShort();
/**
* Reads two bytes unsigned integer.
+ *
+ * @return The read unsigned short
*/
public abstract int getUnsignedShort();
/**
* @see ByteBuffer#putShort(short)
+ *
+ * @param value The short to put at the current position
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putShort(short value);
/**
* @see ByteBuffer#getShort()
+ *
+ * @param index The index in the IoBuffer where we will read a short from
+ * @return The read short
*/
public abstract short getShort(int index);
/**
* Reads two bytes unsigned integer.
+ *
+ * @param index The index in the IoBuffer where we will read an unsigned short from
+ * @return the unsigned short at the given position
*/
public abstract int getUnsignedShort(int index);
/**
* @see ByteBuffer#putShort(int, short)
+ *
+ * @param index The position at which the short should be written
+ * @param value The short to put at the current position
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putShort(int index, short value);
/**
* @see ByteBuffer#asShortBuffer()
+ *
+ * @return A ShortBuffer from this IoBuffer
*/
public abstract ShortBuffer asShortBuffer();
/**
* @see ByteBuffer#getInt()
+ *
+ * @return The int read
*/
public abstract int getInt();
/**
* Reads four bytes unsigned integer.
+ *
+ * @return The unsigned int read
*/
public abstract long getUnsignedInt();
@@ -893,7 +1027,6 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Reads the next three bytes at this buffer's current position, composing
* them into an int value according to the current byte order, and then
* increments the position by three.
- * </p>
*
* @return The medium int value at the buffer's current position
*/
@@ -906,7 +1039,6 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Reads the next three bytes at this buffer's current position, composing
* them into an int value according to the current byte order, and then
* increments the position by three.
- * </p>
*
* @return The unsigned medium int value at the buffer's current position
*/
@@ -918,10 +1050,8 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* <p>
* Reads the next three bytes at this buffer's current position, composing
* them into an int value according to the current byte order.
- * </p>
*
- * @param index
- * The index from which the medium int will be read
+ * @param index The index from which the medium int will be read
* @return The medium int value at the given index
*
* @throws IndexOutOfBoundsException
@@ -936,10 +1066,8 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* <p>
* Reads the next three bytes at this buffer's current position, composing
* them into an int value according to the current byte order.
- * </p>
*
- * @param index
- * The index from which the unsigned medium int will be read
+ * @param index The index from which the unsigned medium int will be read
* @return The unsigned medium int value at the given index
*
* @throws IndexOutOfBoundsException
@@ -955,18 +1083,13 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Writes three bytes containing the given int value, in the current byte
* order, into this buffer at the current position, and then increments the
* position by three.
- * </p>
*
- * @param value
- * The medium int value to be written
+ * @param value The medium int value to be written
*
- * @return This buffer
- *
- * @throws BufferOverflowException
- * If there are fewer than three bytes remaining in this buffer
+ * @return the modified IoBuffer
*
- * @throws ReadOnlyBufferException
- * If this buffer is read-only
+ * @throws BufferOverflowException If there are fewer than three bytes remaining in this buffer
+ * @throws ReadOnlyBufferException If this buffer is read-only
*/
public abstract IoBuffer putMediumInt(int value);
@@ -976,291 +1099,416 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* <p>
* Writes three bytes containing the given int value, in the current byte
* order, into this buffer at the given index.
- * </p>
*
- * @param index
- * The index at which the bytes will be written
+ * @param index The index at which the bytes will be written
*
- * @param value
- * The medium int value to be written
+ * @param value The medium int value to be written
*
- * @return This buffer
+ * @return the modified IoBuffer
*
* @throws IndexOutOfBoundsException
* If <tt>index</tt> is negative or not smaller than the
* buffer's limit, minus three
*
- * @throws ReadOnlyBufferException
- * If this buffer is read-only
+ * @throws ReadOnlyBufferException If this buffer is read-only
*/
public abstract IoBuffer putMediumInt(int index, int value);
/**
* @see ByteBuffer#putInt(int)
+ *
+ * @param value The int to put at the current position
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putInt(int value);
/**
* Writes an unsigned byte into the ByteBuffer
+ *
* @param value the byte to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsigned(byte value);
/**
* Writes an unsigned byte into the ByteBuffer at a specified position
+ *
* @param index the position in the buffer to write the value
* @param value the byte to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsigned(int index, byte value);
/**
* Writes an unsigned byte into the ByteBuffer
+ *
* @param value the short to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsigned(short value);
/**
* Writes an unsigned byte into the ByteBuffer at a specified position
+ *
* @param index the position in the buffer to write the value
* @param value the short to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsigned(int index, short value);
/**
* Writes an unsigned byte into the ByteBuffer
+ *
* @param value the int to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsigned(int value);
/**
* Writes an unsigned byte into the ByteBuffer at a specified position
+ *
* @param index the position in the buffer to write the value
* @param value the int to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsigned(int index, int value);
/**
* Writes an unsigned byte into the ByteBuffer
+ *
* @param value the long to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsigned(long value);
/**
* Writes an unsigned byte into the ByteBuffer at a specified position
+ *
* @param index the position in the buffer to write the value
* @param value the long to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsigned(int index, long value);
/**
* Writes an unsigned int into the ByteBuffer
* @param value the byte to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsignedInt(byte value);
/**
* Writes an unsigned int into the ByteBuffer at a specified position
+ *
* @param index the position in the buffer to write the value
* @param value the byte to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsignedInt(int index, byte value);
/**
* Writes an unsigned int into the ByteBuffer
+ *
* @param value the short to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsignedInt(short value);
/**
* Writes an unsigned int into the ByteBuffer at a specified position
+ *
* @param index the position in the buffer to write the value
* @param value the short to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsignedInt(int index, short value);
/**
* Writes an unsigned int into the ByteBuffer
+ *
* @param value the int to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsignedInt(int value);
/**
* Writes an unsigned int into the ByteBuffer at a specified position
+ *
* @param index the position in the buffer to write the value
* @param value the int to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsignedInt(int index, int value);
/**
* Writes an unsigned int into the ByteBuffer
+ *
* @param value the long to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsignedInt(long value);
/**
* Writes an unsigned int into the ByteBuffer at a specified position
+ *
* @param index the position in the buffer to write the value
* @param value the long to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsignedInt(int index, long value);
/**
* Writes an unsigned short into the ByteBuffer
+ *
* @param value the byte to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsignedShort(byte value);
/**
* Writes an unsigned Short into the ByteBuffer at a specified position
+ *
* @param index the position in the buffer to write the value
* @param value the byte to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsignedShort(int index, byte value);
/**
* Writes an unsigned Short into the ByteBuffer
+ *
* @param value the short to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsignedShort(short value);
/**
* Writes an unsigned Short into the ByteBuffer at a specified position
- * @param index the position in the buffer to write the value
- * @param value the short to write
+ *
+ * @param index the position in the buffer to write the unsigned short
+ * @param value the unsigned short to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsignedShort(int index, short value);
/**
* Writes an unsigned Short into the ByteBuffer
+ *
* @param value the int to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsignedShort(int value);
/**
* Writes an unsigned Short into the ByteBuffer at a specified position
+ *
* @param index the position in the buffer to write the value
* @param value the int to write
+ *
+ * @param index The position where to put the unsigned short
+ * @param value The unsigned short to put in the IoBuffer
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsignedShort(int index, int value);
/**
* Writes an unsigned Short into the ByteBuffer
+ *
* @param value the long to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsignedShort(long value);
/**
* Writes an unsigned Short into the ByteBuffer at a specified position
- * @param index the position in the buffer to write the value
+ *
+ * @param index the position in the buffer to write the short
* @param value the long to write
+ *
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putUnsignedShort(int index, long value);
/**
* @see ByteBuffer#getInt(int)
+ * @param index The index in the IoBuffer where we will read an int from
+ * @return the int at the given position
*/
public abstract int getInt(int index);
/**
* Reads four bytes unsigned integer.
- * @param index the position in the buffer to write the value
+ * @param index The index in the IoBuffer where we will read an unsigned int from
+ * @return The long at the given position
*/
public abstract long getUnsignedInt(int index);
/**
* @see ByteBuffer#putInt(int, int)
+ *
+ * @param index The position where to put the int
+ * @param value The int to put in the IoBuffer
+ * @return the modified IoBuffer
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putInt(int index, int value);
/**
* @see ByteBuffer#asIntBuffer()
+ *
+ * @return the modified IoBuffer
*/
public abstract IntBuffer asIntBuffer();
/**
* @see ByteBuffer#getLong()
+ *
+ * @return The long at the current position
*/
public abstract long getLong();
/**
* @see ByteBuffer#putLong(int, long)
+ *
+ * @param value The log to put in the IoBuffer
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putLong(long value);
/**
* @see ByteBuffer#getLong(int)
+ *
+ * @param index The index in the IoBuffer where we will read a long from
+ * @return the long at the given position
*/
public abstract long getLong(int index);
/**
* @see ByteBuffer#putLong(int, long)
+ *
+ * @param index The position where to put the long
+ * @param value The long to put in the IoBuffer
+ * @return the modified IoBuffer
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putLong(int index, long value);
/**
* @see ByteBuffer#asLongBuffer()
+ *
+ * @return a LongBuffer from this IoBffer
*/
public abstract LongBuffer asLongBuffer();
/**
* @see ByteBuffer#getFloat()
+ *
+ * @return the float at the current position
*/
public abstract float getFloat();
/**
* @see ByteBuffer#putFloat(float)
+ *
+ * @param value The float to put in the IoBuffer
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putFloat(float value);
/**
* @see ByteBuffer#getFloat(int)
+ *
+ * @param index The index in the IoBuffer where we will read a float from
+ * @return The float at the given position
*/
public abstract float getFloat(int index);
/**
* @see ByteBuffer#putFloat(int, float)
+ *
+ * @param index The position where to put the float
+ * @param value The float to put in the IoBuffer
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putFloat(int index, float value);
/**
* @see ByteBuffer#asFloatBuffer()
+ *
+ * @return A FloatBuffer from this IoBuffer
*/
public abstract FloatBuffer asFloatBuffer();
/**
* @see ByteBuffer#getDouble()
+ *
+ * @return the double at the current position
*/
public abstract double getDouble();
/**
* @see ByteBuffer#putDouble(double)
+ *
+ * @param value The double to put at the IoBuffer current position
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putDouble(double value);
/**
* @see ByteBuffer#getDouble(int)
+ *
+ * @param index The position where to get the double from
+ * @return The double at the given position
*/
public abstract double getDouble(int index);
/**
* @see ByteBuffer#putDouble(int, double)
+ *
+ * @param index The position where to put the double
+ * @param value The double to put in the IoBuffer
+ * @return the modified IoBuffer
*/
public abstract IoBuffer putDouble(int index, double value);
/**
* @see ByteBuffer#asDoubleBuffer()
+ *
+ * @return A buffer containing Double
*/
public abstract DoubleBuffer asDoubleBuffer();
/**
- * Returns an {@link InputStream} that reads the data from this buffer.
+ * @return an {@link InputStream} that reads the data from this buffer.
* {@link InputStream#read()} returns <tt>-1</tt> if the buffer position
* reaches to the limit.
*/
public abstract InputStream asInputStream();
/**
- * Returns an {@link OutputStream} that appends the data into this buffer.
+ * @return an {@link OutputStream} that appends the data into this buffer.
* Please note that the {@link OutputStream#write(int)} will throw a
* {@link BufferOverflowException} instead of an {@link IOException} in case
* of buffer overflow. Please set <tt>autoExpand</tt> property by calling
@@ -1295,6 +1543,10 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Reads a <code>NUL</code>-terminated string from this buffer using the
* specified <code>decoder</code> and returns it. This method reads until
* the limit of this buffer if no <tt>NUL</tt> is found.
+ *
+ * @param decoder The {@link CharsetDecoder} to use
+ * @return the read String
+ * @exception CharacterCodingException Thrown when an error occurred while decoding the buffer
*/
public abstract String getString(CharsetDecoder decoder) throws CharacterCodingException;
@@ -1302,8 +1554,10 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Reads a <code>NUL</code>-terminated string from this buffer using the
* specified <code>decoder</code> and returns it.
*
- * @param fieldSize
- * the maximum number of bytes to read
+ * @param fieldSize the maximum number of bytes to read
+ * @param decoder The {@link CharsetDecoder} to use
+ * @return the read String
+ * @exception CharacterCodingException Thrown when an error occurred while decoding the buffer
*/
public abstract String getString(int fieldSize, CharsetDecoder decoder) throws CharacterCodingException;
@@ -1312,8 +1566,10 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* specified <code>encoder</code>. This method doesn't terminate string with
* <tt>NUL</tt>. You have to do it by yourself.
*
- * @throws BufferOverflowException
- * if the specified string doesn't fit
+ * @param val The CharSequence to put in the IoBuffer
+ * @param encoder The CharsetEncoder to use
+ * @return The modified IoBuffer
+ * @throws CharacterCodingException When we have an error while decoding the String
*/
public abstract IoBuffer putString(CharSequence val, CharsetEncoder encoder) throws CharacterCodingException;
@@ -1329,8 +1585,11 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Please note that this method doesn't terminate with <code>NUL</code> if
* the input string is longer than <tt>fieldSize</tt>.
*
- * @param fieldSize
- * the maximum number of bytes to write
+ * @param val The CharSequence to put in the IoBuffer
+ * @param fieldSize the maximum number of bytes to write
+ * @param encoder The CharsetEncoder to use
+ * @return The modified IoBuffer
+ * @throws CharacterCodingException When we have an error while decoding the String
*/
public abstract IoBuffer putString(CharSequence val, int fieldSize, CharsetEncoder encoder)
throws CharacterCodingException;
@@ -1339,6 +1598,11 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Reads a string which has a 16-bit length field before the actual encoded
* string, using the specified <code>decoder</code> and returns it. This
* method is a shortcut for <tt>getPrefixedString(2, decoder)</tt>.
+ *
+ * @param decoder The CharsetDecoder to use
+ * @return The read String
+ *
+ * @throws CharacterCodingException When we have an error while decoding the String
*/
public abstract String getPrefixedString(CharsetDecoder decoder) throws CharacterCodingException;
@@ -1346,8 +1610,11 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Reads a string which has a length field before the actual encoded string,
* using the specified <code>decoder</code> and returns it.
*
- * @param prefixLength
- * the length of the length field (1, 2, or 4)
+ * @param prefixLength the length of the length field (1, 2, or 4)
+ * @param decoder The CharsetDecoder to use
+ * @return The read String
+ *
+ * @throws CharacterCodingException When we have an error while decoding the String
*/
public abstract String getPrefixedString(int prefixLength, CharsetDecoder decoder) throws CharacterCodingException;
@@ -1357,8 +1624,11 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* specified <code>encoder</code>. This method is a shortcut for
* <tt>putPrefixedString(in, 2, 0, encoder)</tt>.
*
- * @throws BufferOverflowException
- * if the specified string doesn't fit
+ * @param in The CharSequence to put in the IoBuffer
+ * @param encoder The CharsetEncoder to use
+ * @return The modified IoBuffer
+ *
+ * @throws CharacterCodingException When we have an error while decoding the CharSequence
*/
public abstract IoBuffer putPrefixedString(CharSequence in, CharsetEncoder encoder) throws CharacterCodingException;
@@ -1368,11 +1638,12 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* specified <code>encoder</code>. This method is a shortcut for
* <tt>putPrefixedString(in, prefixLength, 0, encoder)</tt>.
*
- * @param prefixLength
- * the length of the length field (1, 2, or 4)
+ * @param in The CharSequence to put in the IoBuffer
+ * @param prefixLength the length of the length field (1, 2, or 4)
+ * @param encoder The CharsetEncoder to use
+ * @return The modified IoBuffer
*
- * @throws BufferOverflowException
- * if the specified string doesn't fit
+ * @throws CharacterCodingException When we have an error while decoding the CharSequence
*/
public abstract IoBuffer putPrefixedString(CharSequence in, int prefixLength, CharsetEncoder encoder)
throws CharacterCodingException;
@@ -1382,33 +1653,30 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* has a 16-bit length field before the actual encoded string, using the
* specified <code>encoder</code>. This method is a shortcut for
* <tt>putPrefixedString(in, prefixLength, padding, ( byte ) 0, encoder)</tt>
- * .
*
- * @param prefixLength
- * the length of the length field (1, 2, or 4)
- * @param padding
- * the number of padded <tt>NUL</tt>s (1 (or 0), 2, or 4)
+ * @param in The CharSequence to put in the IoBuffer
+ * @param prefixLength the length of the length field (1, 2, or 4)
+ * @param padding the number of padded <tt>NUL</tt>s (1 (or 0), 2, or 4)
+ * @param encoder The CharsetEncoder to use
+ * @return The modified IoBuffer
*
- * @throws BufferOverflowException
- * if the specified string doesn't fit
+ * @throws CharacterCodingException When we have an error while decoding the CharSequence
*/
public abstract IoBuffer putPrefixedString(CharSequence in, int prefixLength, int padding, CharsetEncoder encoder)
throws CharacterCodingException;
/**
- * Writes the content of <code>in</code> into this buffer as a string which
+ * Writes the content of <code>val</code> into this buffer as a string which
* has a 16-bit length field before the actual encoded string, using the
* specified <code>encoder</code>.
*
- * @param prefixLength
- * the length of the length field (1, 2, or 4)
- * @param padding
- * the number of padded bytes (1 (or 0), 2, or 4)
- * @param padValue
- * the value of padded bytes
- *
- * @throws BufferOverflowException
- * if the specified string doesn't fit
+ * @param val The CharSequence to put in teh IoBuffer
+ * @param prefixLength the length of the length field (1, 2, or 4)
+ * @param padding the number of padded bytes (1 (or 0), 2, or 4)
+ * @param padValue the value of padded bytes
+ * @param encoder The CharsetEncoder to use
+ * @return The modified IoBuffer
+ * @throws CharacterCodingException When we have an error while decoding the CharSequence
*/
public abstract IoBuffer putPrefixedString(CharSequence val, int prefixLength, int padding, byte padValue,
CharsetEncoder encoder) throws CharacterCodingException;
@@ -1416,49 +1684,51 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
/**
* Reads a Java object from the buffer using the context {@link ClassLoader}
* of the current thread.
+ *
+ * @return The read Object
+ * @throws ClassNotFoundException thrown when we can't find the Class to use
*/
public abstract Object getObject() throws ClassNotFoundException;
/**
* Reads a Java object from the buffer using the specified
* <tt>classLoader</tt>.
+ *
+ * @param classLoader The classLoader to use to read an Object from the IoBuffer
+ * @return The read Object
+ * @throws ClassNotFoundException thrown when we can't find the Class to use
*/
public abstract Object getObject(final ClassLoader classLoader) throws ClassNotFoundException;
/**
* Writes the specified Java object to the buffer.
+ *
+ * @param o The Object to write in the IoBuffer
+ * @return The modified IoBuffer
*/
public abstract IoBuffer putObject(Object o);
/**
- * Returns <tt>true</tt> if this buffer contains a data which has a data
+ *
+ * @param prefixLength the length of the prefix field (1, 2, or 4)
+ * @return <tt>true</tt> if this buffer contains a data which has a data
* length as a prefix and the buffer has remaining data as enough as
* specified in the data length field. This method is identical with
* <tt>prefixedDataAvailable( prefixLength, Integer.MAX_VALUE )</tt>. Please
* not that using this method can allow DoS (Denial of Service) attack in
* case the remote peer sends too big data length value. It is recommended
* to use {@link #prefixedDataAvailable(int, int)} instead.
- *
- * @param prefixLength
- * the length of the prefix field (1, 2, or 4)
- *
- * @throws IllegalArgumentException
- * if prefixLength is wrong
- * @throws BufferDataException
- * if data length is negative
+ * @throws IllegalArgumentException if prefixLength is wrong
+ * @throws BufferDataException if data length is negative
*/
public abstract boolean prefixedDataAvailable(int prefixLength);
/**
- * Returns <tt>true</tt> if this buffer contains a data which has a data
+ * @param prefixLength the length of the prefix field (1, 2, or 4)
+ * @param maxDataLength the allowed maximum of the read data length
+ * @return <tt>true</tt> if this buffer contains a data which has a data
* length as a prefix and the buffer has remaining data as enough as
* specified in the data length field.
- *
- * @param prefixLength
- * the length of the prefix field (1, 2, or 4)
- * @param maxDataLength
- * the allowed maximum of the read data length
- *
* @throws IllegalArgumentException
* if prefixLength is wrong
* @throws BufferDataException
@@ -1472,9 +1742,10 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
// ///////////////////
/**
- * Returns the first occurence position of the specified byte from the
+ * Returns the first occurrence position of the specified byte from the
* current position to the current limit.
- *
+ *
+ * @param b The byte we are looking for
* @return <tt>-1</tt> if the specified byte is not found
*/
public abstract int indexOf(byte b);
@@ -1486,30 +1757,47 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
/**
* Forwards the position of this buffer as the specified <code>size</code>
* bytes.
+ *
+ * @param size The added size
+ * @return The modified IoBuffer
*/
public abstract IoBuffer skip(int size);
/**
* Fills this buffer with the specified value. This method moves buffer
* position forward.
+ *
+ * @param value The value to fill the IoBuffer with
+ * @param size The added size
+ * @return The modified IoBuffer
*/
public abstract IoBuffer fill(byte value, int size);
/**
* Fills this buffer with the specified value. This method does not change
* buffer position.
+ *
+ * @param value The value to fill the IoBuffer with
+ * @param size The added size
+ * @return The modified IoBuffer
*/
public abstract IoBuffer fillAndReset(byte value, int size);
/**
* Fills this buffer with <code>NUL (0x00)</code>. This method moves buffer
* position forward.
+ *
+ * @param size The added size
+ * @return The modified IoBuffer
*/
public abstract IoBuffer fill(int size);
/**
* Fills this buffer with <code>NUL (0x00)</code>. This method does not
* change buffer position.
+ *
+ * @param size The added size
+ * @return The modified IoBuffer
*/
public abstract IoBuffer fillAndReset(int size);
@@ -1521,10 +1809,9 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Reads a byte from the buffer and returns the correlating enum constant
* defined by the specified enum type.
*
- * @param <E>
- * The enum type to return
- * @param enumClass
- * The enum's class object
+ * @param <E> The enum type to return
+ * @param enumClass The enum's class object
+ * @return The correlated enum constant
*/
public abstract <E extends Enum<E>> E getEnum(Class<E> enumClass);
@@ -1532,12 +1819,10 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Reads a byte from the buffer and returns the correlating enum constant
* defined by the specified enum type.
*
- * @param <E>
- * The enum type to return
- * @param index
- * the index from which the byte will be read
- * @param enumClass
- * The enum's class object
+ * @param <E> The enum type to return
+ * @param index the index from which the byte will be read
+ * @param enumClass The enum's class object
+ * @return The correlated enum constant
*/
public abstract <E extends Enum<E>> E getEnum(int index, Class<E> enumClass);
@@ -1545,10 +1830,9 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Reads a short from the buffer and returns the correlating enum constant
* defined by the specified enum type.
*
- * @param <E>
- * The enum type to return
- * @param enumClass
- * The enum's class object
+ * @param <E> The enum type to return
+ * @param enumClass The enum's class object
+ * @return The correlated enum constant
*/
public abstract <E extends Enum<E>> E getEnumShort(Class<E> enumClass);
@@ -1556,12 +1840,10 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Reads a short from the buffer and returns the correlating enum constant
* defined by the specified enum type.
*
- * @param <E>
- * The enum type to return
- * @param index
- * the index from which the bytes will be read
- * @param enumClass
- * The enum's class object
+ * @param <E> The enum type to return
+ * @param index the index from which the bytes will be read
+ * @param enumClass The enum's class object
+ * @return The correlated enum constant
*/
public abstract <E extends Enum<E>> E getEnumShort(int index, Class<E> enumClass);
@@ -1569,10 +1851,9 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Reads an int from the buffer and returns the correlating enum constant
* defined by the specified enum type.
*
- * @param <E>
- * The enum type to return
- * @param enumClass
- * The enum's class object
+ * @param <E> The enum type to return
+ * @param enumClass The enum's class object
+ * @return The correlated enum constant
*/
public abstract <E extends Enum<E>> E getEnumInt(Class<E> enumClass);
@@ -1580,66 +1861,61 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Reads an int from the buffer and returns the correlating enum constant
* defined by the specified enum type.
*
- * @param <E>
- * The enum type to return
- * @param index
- * the index from which the bytes will be read
- * @param enumClass
- * The enum's class object
+ * @param <E> The enum type to return
+ * @param index the index from which the bytes will be read
+ * @param enumClass The enum's class object
+ * @return The correlated enum constant
*/
public abstract <E extends Enum<E>> E getEnumInt(int index, Class<E> enumClass);
/**
* Writes an enum's ordinal value to the buffer as a byte.
*
- * @param e
- * The enum to write to the buffer
+ * @param e The enum to write to the buffer
+ * @return The modified IoBuffer
*/
public abstract IoBuffer putEnum(Enum<?> e);
/**
* Writes an enum's ordinal value to the buffer as a byte.
*
- * @param index
- * The index at which the byte will be written
- * @param e
- * The enum to write to the buffer
+ * @param index The index at which the byte will be written
+ * @param e The enum to write to the buffer
+ * @return The modified IoBuffer
*/
public abstract IoBuffer putEnum(int index, Enum<?> e);
/**
* Writes an enum's ordinal value to the buffer as a short.
*
- * @param e
- * The enum to write to the buffer
+ * @param e The enum to write to the buffer
+ * @return The modified IoBuffer
*/
public abstract IoBuffer putEnumShort(Enum<?> e);
/**
* Writes an enum's ordinal value to the buffer as a short.
*
- * @param index
- * The index at which the bytes will be written
- * @param e
- * The enum to write to the buffer
+ * @param index The index at which the bytes will be written
+ * @param e The enum to write to the buffer
+ * @return The modified IoBuffer
*/
public abstract IoBuffer putEnumShort(int index, Enum<?> e);
/**
* Writes an enum's ordinal value to the buffer as an integer.
*
- * @param e
- * The enum to write to the buffer
+ * @param e The enum to write to the buffer
+ * @return The modified IoBuffer
*/
public abstract IoBuffer putEnumInt(Enum<?> e);
/**
* Writes an enum's ordinal value to the buffer as an integer.
*
- * @param index
- * The index at which the bytes will be written
- * @param e
- * The enum to write to the buffer
+ * @param index The index at which the bytes will be written
+ * @param e The enum to write to the buffer
+ * @return The modified IoBuffer
*/
public abstract IoBuffer putEnumInt(int index, Enum<?> e);
@@ -1655,12 +1931,9 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* significant bit maps to the first entry in the specified enum and each
* subsequent bit maps to each subsequent bit as mapped to the subsequent
* enum value.
- * </p>
*
- * @param <E>
- * the enum type
- * @param enumClass
- * the enum class used to create the EnumSet
+ * @param <E> the enum type
+ * @param enumClass the enum class used to create the EnumSet
* @return the EnumSet representation of the bit vector
*/
public abstract <E extends Enum<E>> EnumSet<E> getEnumSet(Class<E> enumClass);
@@ -1669,12 +1942,9 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Reads a byte sized bit vector and converts it to an {@link EnumSet}.
*
* @see #getEnumSet(Class)
- * @param <E>
- * the enum type
- * @param index
- * the index from which the byte will be read
- * @param enumClass
- * the enum class used to create the EnumSet
+ * @param <E> the enum type
+ * @param index the index from which the byte will be read
+ * @param enumClass the enum class used to create the EnumSet
* @return the EnumSet representation of the bit vector
*/
public abstract <E extends Enum<E>> EnumSet<E> getEnumSet(int index, Class<E> enumClass);
@@ -1683,10 +1953,8 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Reads a short sized bit vector and converts it to an {@link EnumSet}.
*
* @see #getEnumSet(Class)
- * @param <E>
- * the enum type
- * @param enumClass
- * the enum class used to create the EnumSet
+ * @param <E> the enum type
+ * @param enumClass the enum class used to create the EnumSet
* @return the EnumSet representation of the bit vector
*/
public abstract <E extends Enum<E>> EnumSet<E> getEnumSetShort(Class<E> enumClass);
@@ -1695,12 +1963,9 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Reads a short sized bit vector and converts it to an {@link EnumSet}.
*
* @see #getEnumSet(Class)
- * @param <E>
- * the enum type
- * @param index
- * the index from which the bytes will be read
- * @param enumClass
- * the enum class used to create the EnumSet
+ * @param <E> the enum type
+ * @param index the index from which the bytes will be read
+ * @param enumClass the enum class used to create the EnumSet
* @return the EnumSet representation of the bit vector
*/
public abstract <E extends Enum<E>> EnumSet<E> getEnumSetShort(int index, Class<E> enumClass);
@@ -1709,10 +1974,8 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Reads an int sized bit vector and converts it to an {@link EnumSet}.
*
* @see #getEnumSet(Class)
- * @param <E>
- * the enum type
- * @param enumClass
- * the enum class used to create the EnumSet
+ * @param <E> the enum type
+ * @param enumClass the enum class used to create the EnumSet
* @return the EnumSet representation of the bit vector
*/
public abstract <E extends Enum<E>> EnumSet<E> getEnumSetInt(Class<E> enumClass);
@@ -1721,12 +1984,9 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Reads an int sized bit vector and converts it to an {@link EnumSet}.
*
* @see #getEnumSet(Class)
- * @param <E>
- * the enum type
- * @param index
- * the index from which the bytes will be read
- * @param enumClass
- * the enum class used to create the EnumSet
+ * @param <E> the enum type
+ * @param index the index from which the bytes will be read
+ * @param enumClass the enum class used to create the EnumSet
* @return the EnumSet representation of the bit vector
*/
public abstract <E extends Enum<E>> EnumSet<E> getEnumSetInt(int index, Class<E> enumClass);
@@ -1735,10 +1995,8 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Reads a long sized bit vector and converts it to an {@link EnumSet}.
*
* @see #getEnumSet(Class)
- * @param <E>
- * the enum type
- * @param enumClass
- * the enum class used to create the EnumSet
+ * @param <E> the enum type
+ * @param enumClass the enum class used to create the EnumSet
* @return the EnumSet representation of the bit vector
*/
public abstract <E extends Enum<E>> EnumSet<E> getEnumSetLong(Class<E> enumClass);
@@ -1747,12 +2005,9 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Reads a long sized bit vector and converts it to an {@link EnumSet}.
*
* @see #getEnumSet(Class)
- * @param <E>
- * the enum type
- * @param index
- * the index from which the bytes will be read
- * @param enumClass
- * the enum class used to create the EnumSet
+ * @param <E> the enum type
+ * @param index the index from which the bytes will be read
+ * @param enumClass the enum class used to create the EnumSet
* @return the EnumSet representation of the bit vector
*/
public abstract <E extends Enum<E>> EnumSet<E> getEnumSetLong(int index, Class<E> enumClass);
@@ -1761,10 +2016,9 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Writes the specified {@link Set} to the buffer as a byte sized bit
* vector.
*
- * @param <E>
- * the enum type of the Set
- * @param set
- * the enum set to write to the buffer
+ * @param <E> the enum type of the Set
+ * @param set the enum set to write to the buffer
+ * @return the modified IoBuffer
*/
public abstract <E extends Enum<E>> IoBuffer putEnumSet(Set<E> set);
@@ -1772,12 +2026,10 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Writes the specified {@link Set} to the buffer as a byte sized bit
* vector.
*
- * @param <E>
- * the enum type of the Set
- * @param index
- * the index at which the byte will be written
- * @param set
- * the enum set to write to the buffer
+ * @param <E> the enum type of the Set
+ * @param index the index at which the byte will be written
+ * @param set the enum set to write to the buffer
+ * @return the modified IoBuffer
*/
public abstract <E extends Enum<E>> IoBuffer putEnumSet(int index, Set<E> set);
@@ -1785,10 +2037,9 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Writes the specified {@link Set} to the buffer as a short sized bit
* vector.
*
- * @param <E>
- * the enum type of the Set
- * @param set
- * the enum set to write to the buffer
+ * @param <E> the enum type of the Set
+ * @param set the enum set to write to the buffer
+ * @return the modified IoBuffer
*/
public abstract <E extends Enum<E>> IoBuffer putEnumSetShort(Set<E> set);
@@ -1796,12 +2047,10 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Writes the specified {@link Set} to the buffer as a short sized bit
* vector.
*
- * @param <E>
- * the enum type of the Set
- * @param index
- * the index at which the bytes will be written
- * @param set
- * the enum set to write to the buffer
+ * @param <E> the enum type of the Set
+ * @param index the index at which the bytes will be written
+ * @param set the enum set to write to the buffer
+ * @return the modified IoBuffer
*/
public abstract <E extends Enum<E>> IoBuffer putEnumSetShort(int index, Set<E> set);
@@ -1809,10 +2058,9 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Writes the specified {@link Set} to the buffer as an int sized bit
* vector.
*
- * @param <E>
- * the enum type of the Set
- * @param set
- * the enum set to write to the buffer
+ * @param <E> the enum type of the Set
+ * @param set the enum set to write to the buffer
+ * @return the modified IoBuffer
*/
public abstract <E extends Enum<E>> IoBuffer putEnumSetInt(Set<E> set);
@@ -1820,12 +2068,10 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Writes the specified {@link Set} to the buffer as an int sized bit
* vector.
*
- * @param <E>
- * the enum type of the Set
- * @param index
- * the index at which the bytes will be written
- * @param set
- * the enum set to write to the buffer
+ * @param <E> the enum type of the Set
+ * @param index the index at which the bytes will be written
+ * @param set the enum set to write to the buffer
+ * @return the modified IoBuffer
*/
public abstract <E extends Enum<E>> IoBuffer putEnumSetInt(int index, Set<E> set);
@@ -1833,10 +2079,9 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Writes the specified {@link Set} to the buffer as a long sized bit
* vector.
*
- * @param <E>
- * the enum type of the Set
- * @param set
- * the enum set to write to the buffer
+ * @param <E> the enum type of the Set
+ * @param set the enum set to write to the buffer
+ * @return the modified IoBuffer
*/
public abstract <E extends Enum<E>> IoBuffer putEnumSetLong(Set<E> set);
@@ -1844,12 +2089,10 @@ public abstract class IoBuffer implements Comparable<IoBuffer> {
* Writes the specified {@link Set} to the buffer as a long sized bit
* vector.
*
- * @param <E>
- * the enum type of the Set
- * @param index
- * the index at which the bytes will be written
- * @param set
- * the enum set to write to the buffer
+ * @param <E> the enum type of the Set
+ * @param index the index at which the bytes will be written
+ * @param set the enum set to write to the buffer
+ * @return the modified IoBuffer
*/
public abstract <E extends Enum<E>> IoBuffer putEnumSetLong(int index, Set<E> set);
}
http://git-wip-us.apache.org/repos/asf/mina/blob/b0958bd5/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 db740b0..67e83be 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
@@ -59,7 +59,7 @@ public interface IoFuture {
/**
* Wait for the asynchronous operation to complete with the specified timeout.
*
- * @param timeout The maximum milliseconds to wait before getting out
+ * @param timeoutMillis The maximum milliseconds to wait before getting out
* @return <tt>true</tt> if the operation is completed.
* @exception InterruptedException If the thread is interrupted while waiting
*/
@@ -88,7 +88,7 @@ public interface IoFuture {
* Wait for the asynchronous operation to complete with the specified timeout
* uninterruptibly.
*
- * @param timeout The maximum milliseconds to wait before getting out
+ * @param timeoutMillis The maximum milliseconds to wait before getting out
* @return <tt>true</tt> if the operation is finished.
*/
boolean awaitUninterruptibly(long timeoutMillis);
http://git-wip-us.apache.org/repos/asf/mina/blob/b0958bd5/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 e11a7ff..15d965f 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
@@ -83,7 +83,7 @@ public interface IoSessionAttributeMap {
* with the following code except that the operation is performed
* atomically.
* <pre>
- * if (containsAttribute(key) && getAttribute(key).equals(value)) {
+ * if (containsAttribute(key) && getAttribute(key).equals(value)) {
* removeAttribute(key);
* return true;
* } else {
@@ -99,7 +99,7 @@ public interface IoSessionAttributeMap {
* This method is same with the following code except that the operation
* is performed atomically.
* <pre>
- * if (containsAttribute(key) && getAttribute(key).equals(oldValue)) {
+ * if (containsAttribute(key) && getAttribute(key).equals(oldValue)) {
* setAttribute(key, newValue);
* return true;
* } else {
http://git-wip-us.apache.org/repos/asf/mina/blob/b0958bd5/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 04b8143..867b40a 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
@@ -25,38 +25,36 @@ import org.apache.mina.core.session.AttributeKey;
import org.apache.mina.core.session.IoSession;
/**
- * A {@link ProtocolDecoder} that cumulates the content of received
- * buffers to a <em>cumulative buffer</em> to help users implement decoders.
+ * A {@link ProtocolDecoder} that cumulates the content of received buffers to a
+ * <em>cumulative buffer</em> to help users implement decoders.
* <p>
- * If the received {@link IoBuffer} is only a part of a message.
- * decoders should cumulate received buffers to make a message complete or
- * to postpone decoding until more buffers arrive.
+ * If the received {@link IoBuffer} is only a part of a message. decoders should
+ * cumulate received buffers to make a message complete or to postpone decoding
+ * until more buffers arrive.
* <p>
* Here is an example decoder that decodes CRLF terminated lines into
* <code>Command</code> objects:
+ *
* <pre>
- * public class CrLfTerminatedCommandLineDecoder
- * extends CumulativeProtocolDecoder {
- *
+ * public class CrLfTerminatedCommandLineDecoder extends CumulativeProtocolDecoder {
+ *
* private Command parseCommand(IoBuffer in) {
* // Convert the bytes in the specified buffer to a
* // Command object.
* ...
* }
- *
- * protected boolean doDecode(
- * IoSession session, IoBuffer in, ProtocolDecoderOutput out)
- * throws Exception {
- *
+ *
+ * protected boolean doDecode(IoSession session, IoBuffer in, ProtocolDecoderOutput out) throws Exception {
+ *
* // Remember the initial position.
* int start = in.position();
- *
+ *
* // Now find the first CRLF in the buffer.
* byte previous = 0;
* while (in.hasRemaining()) {
* byte current = in.get();
- *
- * if (previous == '\r' && current == '\n') {
+ *
+ * if (previous == '\r' && current == '\n') {
* // Remember the current position and limit.
* int position = in.position();
* int limit = in.limit();
@@ -79,14 +77,14 @@ import org.apache.mina.core.session.IoSession;
* // buffer.
* return true;
* }
- *
+ *
* previous = current;
* }
- *
+ *
* // Could not find CRLF in the buffer. Reset the initial
* // position to the one we recorded above.
* in.position(start);
- *
+ *
* return false;
* }
* }
@@ -94,7 +92,7 @@ import org.apache.mina.core.session.IoSession;
* <p>
* Please note that this decoder simply forward the call to
* {@link #doDecode(IoSession, IoBuffer, ProtocolDecoderOutput)} if the
- * underlying transport doesn't have a packet fragmentation. Whether the
+ * underlying transport doesn't have a packet fragmentation. Whether the
* transport has fragmentation or not is determined by querying
* {@link TransportMetadata}.
*
@@ -113,12 +111,14 @@ public abstract class CumulativeProtocolDecoder extends ProtocolDecoderAdapter {
/**
* Cumulates content of <tt>in</tt> into internal buffer and forwards
- * decoding request to {@link #doDecode(IoSession, IoBuffer, ProtocolDecoderOutput)}.
+ * decoding request to
+ * {@link #doDecode(IoSession, IoBuffer, ProtocolDecoderOutput)}.
* <tt>doDecode()</tt> is invoked repeatedly until it returns <tt>false</tt>
* and the cumulative buffer is compacted after decoding ends.
*
- * @throws IllegalStateException if your <tt>doDecode()</tt> returned
- * <tt>true</tt> not consuming the cumulative buffer.
+ * @throws IllegalStateException
+ * if your <tt>doDecode()</tt> returned <tt>true</tt> not
+ * consuming the cumulative buffer.
*/
public void decode(IoSession session, IoBuffer in, ProtocolDecoderOutput out) throws Exception {
if (!session.getTransportMetadata().hasFragmentation()) {
@@ -207,19 +207,22 @@ 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 in
+ * the cumulative buffer
* @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>.
+ * then this method will be invoked again when more data is
+ * cumulated.
+ * @throws Exception
+ * if cannot decode <tt>in</tt>.
*/
protected abstract boolean doDecode(IoSession session, IoBuffer in, ProtocolDecoderOutput out) throws Exception;
/**
* Releases the cumulative buffer used by the specified <tt>session</tt>.
- * Please don't forget to call <tt>super.dispose( session )</tt> when
- * you override this method.
+ * Please don't forget to call <tt>super.dispose( session )</tt> when you
+ * override this method.
*/
@Override
public void dispose(IoSession session) throws Exception {
http://git-wip-us.apache.org/repos/asf/mina/blob/b0958bd5/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 253f0bb..6d7193a 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
@@ -53,7 +53,7 @@ public class PrefixedStringCodecFactory implements ProtocolCodecFactory {
* If the size of the encoded String exceeds this value, the encoder
* will throw a {@link IllegalArgumentException}.
* The default value is {@link PrefixedStringEncoder#DEFAULT_MAX_DATA_LENGTH}.
- * <p/>
+ * <p>
* This method does the same job as {@link PrefixedStringEncoder#setMaxDataLength(int)}.
*
* @return the allowed maximum size of an encoded string.
@@ -67,7 +67,7 @@ public class PrefixedStringCodecFactory implements ProtocolCodecFactory {
* If the size of the encoded String exceeds this value, the encoder
* will throw a {@link IllegalArgumentException}.
* The default value is {@link PrefixedStringEncoder#DEFAULT_MAX_DATA_LENGTH}.
- * <p/>
+ * <p>
* This method does the same job as {@link PrefixedStringEncoder#getMaxDataLength()}.
*
* @param maxDataLength allowed maximum size of an encoded String.
@@ -80,7 +80,6 @@ public class PrefixedStringCodecFactory implements ProtocolCodecFactory {
* Returns the allowed maximum size of a decoded string.
* <p>
* This method does the same job as {@link PrefixedStringEncoder#setMaxDataLength(int)}.
- * </p>
*
* @return the allowed maximum size of an encoded string.
* @see #setDecoderMaxDataLength(int)
@@ -96,9 +95,8 @@ public class PrefixedStringCodecFactory implements ProtocolCodecFactory {
* The decoder will throw a {@link BufferDataException} when data length
* specified in the incoming data is greater than maxDataLength
* The default value is {@link PrefixedStringDecoder#DEFAULT_MAX_DATA_LENGTH}.
- *
+ * <p>
* This method does the same job as {@link PrefixedStringDecoder#setMaxDataLength(int)}.
- * </p>
*
* @param maxDataLength maximum allowed value specified as data length in the incoming data
*/
http://git-wip-us.apache.org/repos/asf/mina/blob/b0958bd5/mina-core/src/main/java/org/apache/mina/filter/keepalive/KeepAliveFilter.java
----------------------------------------------------------------------
diff --git a/mina-core/src/main/java/org/apache/mina/filter/keepalive/KeepAliveFilter.java b/mina-core/src/main/java/org/apache/mina/filter/keepalive/KeepAliveFilter.java
index 96da590..7f2b463 100644
--- a/mina-core/src/main/java/org/apache/mina/filter/keepalive/KeepAliveFilter.java
+++ b/mina-core/src/main/java/org/apache/mina/filter/keepalive/KeepAliveFilter.java
@@ -54,64 +54,82 @@ import org.apache.mina.core.write.WriteRequest;
* message is a keep-alive message or not and creates a new keep-alive
* message:
*
- * <table border="1">
- * <tr>
- * <th>Name</th><th>Description</th><th>Implementation</th>
- * </tr>
- * <tr valign="top">
- * <td>Active</td>
- * <td>You want a keep-alive request is sent when the reader is idle.
- * Once the request is sent, the response for the request should be
- * received within <tt>keepAliveRequestTimeout</tt> seconds. Otherwise,
- * the specified {@link KeepAliveRequestTimeoutHandler} will be invoked.
- * If a keep-alive request is received, its response also should be sent back.
- * </td>
- * <td>Both {@link KeepAliveMessageFactory#getRequest(IoSession)} and
- * {@link KeepAliveMessageFactory#getResponse(IoSession, Object)} must
- * return a non-<tt>null</tt>.</td>
- * </tr>
- * <tr valign="top">
- * <td>Semi-active</td>
- * <td>You want a keep-alive request to be sent when the reader is idle.
- * However, you don't really care if the response is received or not.
- * If a keep-alive request is received, its response should
- * also be sent back.
- * </td>
- * <td>Both {@link KeepAliveMessageFactory#getRequest(IoSession)} and
- * {@link KeepAliveMessageFactory#getResponse(IoSession, Object)} must
- * return a non-<tt>null</tt>, and the <tt>timeoutHandler</tt> property
- * should be set to {@link KeepAliveRequestTimeoutHandler#NOOP},
- * {@link KeepAliveRequestTimeoutHandler#LOG} or the custom {@link KeepAliveRequestTimeoutHandler}
- * implementation that doesn't affect the session state nor throw an exception.
- * </td>
- * </tr>
- * <tr valign="top">
- * <td>Passive</td>
- * <td>You don't want to send a keep-alive request by yourself, but the
- * response should be sent back if a keep-alive request is received.</td>
- * <td>{@link KeepAliveMessageFactory#getRequest(IoSession)} must return
- * <tt>null</tt> and {@link KeepAliveMessageFactory#getResponse(IoSession, Object)}
- * must return a non-<tt>null</tt>.</td>
- * </tr>
- * <tr valign="top">
- * <td>Deaf Speaker</td>
- * <td>You want a keep-alive request to be sent when the reader is idle, but
- * you don't want to send any response back.</td>
- * <td>{@link KeepAliveMessageFactory#getRequest(IoSession)} must return
- * a non-<tt>null</tt>,
- * {@link KeepAliveMessageFactory#getResponse(IoSession, Object)} must
- * return <tt>null</tt> and the <tt>timeoutHandler</tt> must be set to
- * {@link KeepAliveRequestTimeoutHandler#DEAF_SPEAKER}.</td>
- * </tr>
- * <tr valign="top">
- * <td>Silent Listener</td>
- * <td>You don't want to send a keep-alive request by yourself nor send any
- * response back.</td>
- * <td>Both {@link KeepAliveMessageFactory#getRequest(IoSession)} and
- * {@link KeepAliveMessageFactory#getResponse(IoSession, Object)} must
- * return <tt>null</tt>.</td>
- * </tr>
+ * <table border="1" summary="Message">
+ * <tr>
+ * <th>Name</th><th>Description</th><th>Implementation</th>
+ * </tr>
+ * <tr valign="top">
+ * <td>Active</td>
+ * <td>
+ * You want a keep-alive request is sent when the reader is idle.
+ * Once the request is sent, the response for the request should be
+ * received within <tt>keepAliveRequestTimeout</tt> seconds. Otherwise,
+ * the specified {@link KeepAliveRequestTimeoutHandler} will be invoked.
+ * If a keep-alive request is received, its response also should be sent back.
+ * </td>
+ * <td>
+ * Both {@link KeepAliveMessageFactory#getRequest(IoSession)} and
+ * {@link KeepAliveMessageFactory#getResponse(IoSession, Object)} must
+ * return a non-<tt>null</tt>.
+ * </td>
+ * </tr>
+ * <tr valign="top">
+ * <td>Semi-active</td>
+ * <td>
+ * You want a keep-alive request to be sent when the reader is idle.
+ * However, you don't really care if the response is received or not.
+ * If a keep-alive request is received, its response should
+ * also be sent back.
+ * </td>
+ * <td>
+ * Both {@link KeepAliveMessageFactory#getRequest(IoSession)} and
+ * {@link KeepAliveMessageFactory#getResponse(IoSession, Object)} must
+ * return a non-<tt>null</tt>, and the <tt>timeoutHandler</tt> property
+ * should be set to {@link KeepAliveRequestTimeoutHandler#NOOP},
+ * {@link KeepAliveRequestTimeoutHandler#LOG} or the custom {@link KeepAliveRequestTimeoutHandler}
+ * implementation that doesn't affect the session state nor throw an exception.
+ * </td>
+ * </tr>
+ * <tr valign="top">
+ * <td>Passive</td>
+ * <td>
+ * You don't want to send a keep-alive request by yourself, but the
+ * response should be sent back if a keep-alive request is received.
+ * </td>
+ * <td>
+ * {@link KeepAliveMessageFactory#getRequest(IoSession)} must return
+ * <tt>null</tt> and {@link KeepAliveMessageFactory#getResponse(IoSession, Object)}
+ * must return a non-<tt>null</tt>.
+ * </td>
+ * </tr>
+ * <tr valign="top">
+ * <td>Deaf Speaker</td>
+ * <td>
+ * You want a keep-alive request to be sent when the reader is idle, but
+ * you don't want to send any response back.
+ * </td>
+ * <td>
+ * {@link KeepAliveMessageFactory#getRequest(IoSession)} must return
+ * a non-<tt>null</tt>,
+ * {@link KeepAliveMessageFactory#getResponse(IoSession, Object)} must
+ * return <tt>null</tt> and the <tt>timeoutHandler</tt> must be set to
+ * {@link KeepAliveRequestTimeoutHandler#DEAF_SPEAKER}.
+ * </td>
+ * </tr>
+ * <tr valign="top">
+ * <td>Silent Listener</td>
+ * <td>
+ * You don't want to send a keep-alive request by yourself nor send any
+ * response back.
+ * </td>
+ * <td>
+ * Both {@link KeepAliveMessageFactory#getRequest(IoSession)} and
+ * {@link KeepAliveMessageFactory#getResponse(IoSession, Object)} must
+ * return <tt>null</tt>.
+ * </td>
+ * </tr>
* </table>
+ *
* Please note that you must implement
* {@link KeepAliveMessageFactory#isRequest(IoSession, Object)} and
* {@link KeepAliveMessageFactory#isResponse(IoSession, Object)} properly
http://git-wip-us.apache.org/repos/asf/mina/blob/b0958bd5/mina-core/src/main/java/org/apache/mina/filter/logging/MdcInjectionFilter.java
----------------------------------------------------------------------
diff --git a/mina-core/src/main/java/org/apache/mina/filter/logging/MdcInjectionFilter.java b/mina-core/src/main/java/org/apache/mina/filter/logging/MdcInjectionFilter.java
index d2e188f..6378feb 100644
--- a/mina-core/src/main/java/org/apache/mina/filter/logging/MdcInjectionFilter.java
+++ b/mina-core/src/main/java/org/apache/mina/filter/logging/MdcInjectionFilter.java
@@ -35,7 +35,7 @@ import org.slf4j.MDC;
/**
* This filter will inject some key IoSession properties into the Mapped Diagnostic Context (MDC)
- * <p/>
+ * <p>
* These properties will be set in the MDC for all logging events that are generated
* down the call stack, even in code that is not aware of MINA.
*
http://git-wip-us.apache.org/repos/asf/mina/blob/b0958bd5/mina-core/src/main/java/org/apache/mina/filter/ssl/SslContextFactory.java
----------------------------------------------------------------------
diff --git a/mina-core/src/main/java/org/apache/mina/filter/ssl/SslContextFactory.java b/mina-core/src/main/java/org/apache/mina/filter/ssl/SslContextFactory.java
index 9195aa4..fea4d0f 100644
--- a/mina-core/src/main/java/org/apache/mina/filter/ssl/SslContextFactory.java
+++ b/mina-core/src/main/java/org/apache/mina/filter/ssl/SslContextFactory.java
@@ -39,15 +39,12 @@ import javax.net.ssl.TrustManagerFactory;
* SSLContext c = SSLContext.getInstance( "TLS" );
* c.init(null, null, null);
* </pre>
- * </p>
* <p>
* Use the properties prefixed with <code>keyManagerFactory</code> to control
* the creation of the {@link KeyManager} to be used.
- * </p>
* <p>
* Use the properties prefixed with <code>trustManagerFactory</code> to control
* the creation of the {@link TrustManagerFactory} to be used.
- * </p>
*
* @author <a href="http://mina.apache.org">Apache MINA Project</a>
*/
@@ -236,14 +233,12 @@ public class SslContextFactory {
* <p>
* This property will be ignored if a {@link KeyManagerFactory} has been
* set directly using {@link #setKeyManagerFactory(KeyManagerFactory)}.
- * </p>
* <p>
* If this property isn't set while no {@link KeyManagerFactory} has been
* set using {@link #setKeyManagerFactory(KeyManagerFactory)} and
* {@link #setKeyManagerFactoryAlgorithmUseDefault(boolean)} has been set to
* <code>true</code> the value returned
* by {@link KeyManagerFactory#getDefaultAlgorithm()} will be used instead.
- * </p>
*
* @param algorithm the algorithm to use.
*/
@@ -258,13 +253,11 @@ public class SslContextFactory {
* <p>
* This property will be ignored if a {@link KeyManagerFactory} has been
* set directly using {@link #setKeyManagerFactory(KeyManagerFactory)}.
- * </p>
* <p>
* If this property isn't set and no {@link KeyManagerFactory} has been set
* using {@link #setKeyManagerFactory(KeyManagerFactory)}
* {@link KeyManagerFactory#getInstance(java.lang.String)} will be used
* to create the {@link KeyManagerFactory}.
- * </p>
*
* @param provider the name of the provider.
*/
@@ -317,14 +310,12 @@ public class SslContextFactory {
* <p>
* This property will be ignored if a {@link TrustManagerFactory} has been
* set directly using {@link #setTrustManagerFactory(TrustManagerFactory)}.
- * </p>
* <p>
* If this property isn't set while no {@link TrustManagerFactory} has been
* set using {@link #setTrustManagerFactory(TrustManagerFactory)} and
* {@link #setTrustManagerFactoryAlgorithmUseDefault(boolean)} has been set to
* <code>true</code> the value returned
* by {@link TrustManagerFactory#getDefaultAlgorithm()} will be used instead.
- * </p>
*
* @param algorithm the algorithm to use.
*/
@@ -339,7 +330,6 @@ public class SslContextFactory {
* <p>
* This property will be ignored if {@link ManagerFactoryParameters} has been
* set directly using {@link #setTrustManagerFactoryParameters(ManagerFactoryParameters)}.
- * </p>
*
* @param keyStore the key store.
*/
@@ -365,13 +355,11 @@ public class SslContextFactory {
* <p>
* This property will be ignored if a {@link TrustManagerFactory} has been
* set directly using {@link #setTrustManagerFactory(TrustManagerFactory)}.
- * </p>
* <p>
* If this property isn't set and no {@link TrustManagerFactory} has been set
* using {@link #setTrustManagerFactory(TrustManagerFactory)}
* {@link TrustManagerFactory#getInstance(java.lang.String)} will be used
* to create the {@link TrustManagerFactory}.
- * </p>
*
* @param provider the name of the provider.
*/
http://git-wip-us.apache.org/repos/asf/mina/blob/b0958bd5/mina-core/src/main/java/org/apache/mina/filter/stream/StreamWriteFilter.java
----------------------------------------------------------------------
diff --git a/mina-core/src/main/java/org/apache/mina/filter/stream/StreamWriteFilter.java b/mina-core/src/main/java/org/apache/mina/filter/stream/StreamWriteFilter.java
index 6d546f1..96e16e3 100644
--- a/mina-core/src/main/java/org/apache/mina/filter/stream/StreamWriteFilter.java
+++ b/mina-core/src/main/java/org/apache/mina/filter/stream/StreamWriteFilter.java
@@ -36,17 +36,15 @@ import org.apache.mina.core.session.IoSession;
* {@link InputStream} written to the session and notifies
* {@link org.apache.mina.core.future.WriteFuture} on the
* original {@link org.apache.mina.core.write.WriteRequest}.
- * <p/>
+ * <p>
* This filter will ignore written messages which aren't {@link InputStream}
* instances. Such messages will be passed to the next filter directly.
- * </p>
- * <p/>
+ * <p>
* NOTE: this filter does not close the stream after all data from stream
* has been written. The {@link org.apache.mina.core.service.IoHandler} should take
* care of that in its
* {@link org.apache.mina.core.service.IoHandler#messageSent(IoSession,Object)}
* callback.
- * </p>
*
* @author <a href="http://mina.apache.org">Apache MINA Project</a>
* @org.apache.xbean.XBean