You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by tr...@apache.org on 2005/12/01 07:12:15 UTC

svn commit: r350185 - /directory/network/trunk/src/java/org/apache/mina/common/ByteBuffer.java

Author: trustin
Date: Wed Nov 30 22:12:11 2005
New Revision: 350185

URL: http://svn.apache.org/viewcvs?rev=350185&view=rev
Log:
DIRMINA-133 JavaDocs to ByteBuffer to link to java.nio.ByteBuffer
* Applied Peter's patch

Modified:
    directory/network/trunk/src/java/org/apache/mina/common/ByteBuffer.java

Modified: directory/network/trunk/src/java/org/apache/mina/common/ByteBuffer.java
URL: http://svn.apache.org/viewcvs/directory/network/trunk/src/java/org/apache/mina/common/ByteBuffer.java?rev=350185&r1=350184&r2=350185&view=diff
==============================================================================
--- directory/network/trunk/src/java/org/apache/mina/common/ByteBuffer.java (original)
+++ directory/network/trunk/src/java/org/apache/mina/common/ByteBuffer.java Wed Nov 30 22:12:11 2005
@@ -86,7 +86,7 @@
  *   <li>You pass the buffer by calling {@link ProtocolEncoderOutput#write(ByteBuffer)}.</li>
  * </ul>
  * And, you don't need to release any {@link ByteBuffer} which is passed as a parameter
- * of {@link IoHandler#messageReceived(IoSession, ByteBuffer)} method.  They are released
+ * of {@link IoHandler#messageReceived(IoSession, Object)} method.  They are released
  * automatically when the method returns.
  * <p>
  * You have to release buffers manually by calling {@link #release()} when:
@@ -346,52 +346,124 @@
      */
     public abstract void setPooled( boolean pooled );
     
+    /**
+     * @see java.nio.Buffer#position()
+     */
     public abstract int position();
 
+    /**
+     * @see java.nio.Buffer#position(int)
+     */
     public abstract ByteBuffer position( int newPosition );
 
+    /**
+     * @see java.nio.Buffer#limit()
+     */
     public abstract int limit();
 
+    /**
+     * @see java.nio.Buffer#limit(int)
+     */
     public abstract ByteBuffer limit( int newLimit );
 
+    /**
+     * @see java.nio.Buffer#mark()
+     */
     public abstract ByteBuffer mark();
 
+    /**
+     * @see java.nio.Buffer#reset()
+     */
     public abstract ByteBuffer reset();
 
+    /**
+     * @see java.nio.Buffer#clear()
+     */
     public abstract ByteBuffer clear();
 
+    /**
+     * @see java.nio.Buffer#flip()
+     */
     public abstract ByteBuffer flip();
 
+    /**
+     * @see java.nio.Buffer#rewind()
+     */
     public abstract ByteBuffer rewind();
 
+    /**
+     * @see java.nio.Buffer#remaining()
+     */
     public abstract int remaining();
 
+    /**
+     * @see java.nio.Buffer#hasRemaining()
+     */
     public abstract boolean hasRemaining();
 
+    /**
+     * @see java.nio.ByteBuffer#get()
+     */
     public abstract byte get();
 
+    /**
+     * Reads one unsigned byte as a short integer.
+     */
     public abstract short getUnsigned();
 
+    /**
+     * @see java.nio.ByteBuffer#put(byte)
+     */
     public abstract ByteBuffer put( byte b );
 
+    /**
+     * @see java.nio.ByteBuffer#get(int)
+     */
     public abstract byte get( int index );
 
+    /**
+     * Reads one byte as an unsigned short integer.
+     */
     public abstract short getUnsigned( int index );
 
+    /**
+     * @see java.nio.ByteBuffer#put(int, byte)
+     */
     public abstract ByteBuffer put( int index, byte b );
 
+    /**
+     * @see java.nio.ByteBuffer#get(byte[], int, int)
+     */
     public abstract ByteBuffer get( byte[] dst, int offset, int length );
 
+    /**
+     * @see java.nio.ByteBuffer#get(byte[])
+     */
     public abstract ByteBuffer get( byte[] dst );
 
+    /**
+     * Writes the content of the specified <tt>src</tt> into this buffer.
+     */
     public abstract ByteBuffer put( java.nio.ByteBuffer src );
 
+    /**
+     * Writes the content of the specified <tt>src</tt> into this buffer.
+     */
     public abstract ByteBuffer put( ByteBuffer src );
 
+    /**
+     * @see java.nio.ByteBuffer#put(byte[], int, int)
+     */
     public abstract ByteBuffer put( byte[] src, int offset, int length );
 
+    /**
+     * @see java.nio.ByteBuffer#put(byte[])
+     */
     public abstract ByteBuffer put( byte[] src );
 
+    /**
+     * @see java.nio.ByteBuffer#compact()
+     */
     public abstract ByteBuffer compact();
 
     public abstract String toString();
@@ -402,76 +474,184 @@
 
     public abstract int compareTo( ByteBuffer that );
 
+    /**
+     * @see java.nio.ByteBuffer#order()
+     */
     public abstract ByteOrder order();
 
+    /**
+     * @see java.nio.ByteBuffer#order(ByteOrder)
+     */
     public abstract ByteBuffer order( ByteOrder bo );
 
+    /**
+     * @see java.nio.ByteBuffer#getChar()
+     */
     public abstract char getChar();
 
+    /**
+     * @see java.nio.ByteBuffer#putChar(char)
+     */
     public abstract ByteBuffer putChar( char value );
 
+    /**
+     * @see java.nio.ByteBuffer#getChar(int)
+     */
     public abstract char getChar( int index );
 
+    /**
+     * @see java.nio.ByteBuffer#putChar(int, char)
+     */
     public abstract ByteBuffer putChar( int index, char value );
 
+    /**
+     * @see java.nio.ByteBuffer#asCharBuffer()
+     */
     public abstract CharBuffer asCharBuffer();
 
+    /**
+     * @see java.nio.ByteBuffer#getShort()
+     */
     public abstract short getShort();
 
+    /**
+     * Reads two bytes unsigned integer.
+     */
     public abstract int getUnsignedShort();
 
+    /**
+     * @see java.nio.ByteBuffer#putShort(short)
+     */
     public abstract ByteBuffer putShort( short value );
 
+    /**
+     * @see java.nio.ByteBuffer#getShort()
+     */
     public abstract short getShort( int index );
 
+    /**
+     * Reads two bytes unsigned integer.
+     */
     public abstract int getUnsignedShort( int index );
 
+    /**
+     * @see java.nio.ByteBuffer#putShort(int, short)
+     */
     public abstract ByteBuffer putShort( int index, short value );
 
+    /**
+     * @see java.nio.ByteBuffer#asShortBuffer()
+     */
     public abstract ShortBuffer asShortBuffer();
 
+    /**
+     * @see java.nio.ByteBuffer#getInt()
+     */
     public abstract int getInt();
 
+    /**
+     * Reads four bytes unsigned integer.
+     */
     public abstract long getUnsignedInt();
 
+    /**
+     * @see java.nio.ByteBuffer#putInt(int)
+     */
     public abstract ByteBuffer putInt( int value );
 
+    /**
+     * @see java.nio.ByteBuffer#getInt(int)
+     */
     public abstract int getInt( int index );
 
+    /**
+     * Reads four bytes unsigned integer.
+     */
     public abstract long getUnsignedInt( int index );
 
+    /**
+     * @see java.nio.ByteBuffer#putInt(int, int)
+     */
     public abstract ByteBuffer putInt( int index, int value );
 
+    /**
+     * @see java.nio.ByteBuffer#asIntBuffer()
+     */
     public abstract IntBuffer asIntBuffer();
 
+    /**
+     * @see java.nio.ByteBuffer#getLong()
+     */
     public abstract long getLong();
 
+    /**
+     * @see java.nio.ByteBuffer#putLong(int, long)
+     */
     public abstract ByteBuffer putLong( long value );
 
+    /**
+     * @see java.nio.ByteBuffer#getLong(int)
+     */
     public abstract long getLong( int index );
 
+    /**
+     * @see java.nio.ByteBuffer#putLong(int, long)
+     */
     public abstract ByteBuffer putLong( int index, long value );
 
+    /**
+     * @see java.nio.ByteBuffer#asLongBuffer()
+     */
     public abstract LongBuffer asLongBuffer();
 
+    /**
+     * @see java.nio.ByteBuffer#getFloat()
+     */
     public abstract float getFloat();
 
+    /**
+     * @see java.nio.ByteBuffer#putFloat(float)
+     */
     public abstract ByteBuffer putFloat( float value );
 
+    /**
+     * @see java.nio.ByteBuffer#getFloat(int)
+     */
     public abstract float getFloat( int index );
 
+    /**
+     * @see java.nio.ByteBuffer#putFloat(int, float)
+     */
     public abstract ByteBuffer putFloat( int index, float value );
 
+    /**
+     * @see java.nio.ByteBuffer#asFloatBuffer()
+     */
     public abstract FloatBuffer asFloatBuffer();
 
+    /**
+     * @see java.nio.ByteBuffer#getDouble()
+     */
     public abstract double getDouble();
 
+    /**
+     * @see java.nio.ByteBuffer#putDouble(double)
+     */
     public abstract ByteBuffer putDouble( double value );
 
+    /**
+     * @see java.nio.ByteBuffer#getDouble(int)
+     */
     public abstract double getDouble( int index );
 
+    /**
+     * @see java.nio.ByteBuffer#putDouble(int, double)
+     */
     public abstract ByteBuffer putDouble( int index, double value );
 
+    /**
+     * @see java.nio.ByteBuffer#asDoubleBuffer()
+     */
     public abstract DoubleBuffer asDoubleBuffer();
     
     /**