andreacavalli/netty5
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

More JavaDoc

Browse Source
This commit is contained in:
Trustin Lee 2008-08-11 04:08:41 +00:00
parent 0a594a27d5
commit b2cc6c264c
2 changed files with 97 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

89
src/main/java/org/jboss/netty/buffer/ChannelBuffer.java
View File

@ -886,10 +886,66 @@ public interface ChannelBuffer extends Comparable<ChannelBuffer> {
*/
long readLong();
/**
* Transfers this buffer's data to a newly created buffer starting at
* the current {@code readerIndex} and increases the {@code readerIndex}
* by the number of the transferred bytes (= {@code length}).
* The returned buffer's {@code readerIndex} and {@code writerIndex} are
* {@code 0} and {@code length} respectively.
*
* @param length the number of bytes to transfer
*
* @return the newly created buffer which contains the transferred bytes
*
* @throws IndexOutOfBoundsException
* if {@code length} is greater than {@code this.readableBytes}
*/
ChannelBuffer readBytes(int length);
ChannelBuffer readBytes(ChannelBufferIndexFinder endIndexFinder);
/**
* Transfers this buffer's data to a newly created buffer starting at
* the current {@code readerIndex} until the specified {@code indexFinder}
* returns {@code true} and increases the {@code readerIndex}
* by the number of the transferred bytes. The returned buffer's
* {@code readerIndex} and {@code writerIndex} are {@code 0} and
* the number of the transferred bytes respectively.
*
* @param length the number of bytes to transfer
*
* @return the newly created buffer which contains the transferred bytes
*
* @throws NoSuchElementException
* if {@code indexFinder} didn't return {@code true} at all
*/
ChannelBuffer readBytes(ChannelBufferIndexFinder indexFinder);
/**
* Returns a new slice of this buffer's sub-region starting at the current
* {@code readerIndex} and increases the {@code readerIndex} by the size
* of the new slice (= {@code length}).
*
* @param length the size of the new slice
*
* @return the newly created slice
*
* @throws IndexOutOfBoundsException
* if {@code length} is greater than {@code this.readableBytes}
*/
ChannelBuffer readSlice(int length);
ChannelBuffer readSlice(ChannelBufferIndexFinder endIndexFinder);
/**
* Returns a new slice of this buffer's sub-region starting at the current
* {@code readerIndex} and increases the {@code readerIndex} by the size
* of the new slice (determined by {@code indexFinder}).
*
* @param indexFinder finds the end index of the sub-region to be sliced
*
* @return the newly created slice
*
* @throws NoSuchElementException
* if {@code indexFinder} didn't return {@code true} at all
*/
ChannelBuffer readSlice(ChannelBufferIndexFinder indexFinder);
/**
* Transfers this buffer's data to the specified destination starting at
@ -1014,14 +1070,14 @@ public interface ChannelBuffer extends Comparable<ChannelBuffer> {
/**
* Increases the current {@code readerIndex} until the specified
* {@code firstIndexFinder} returns {@code true} in this buffer.
* {@code indexFinder} returns {@code true} in this buffer.
*
* @return the number of skipped bytes
*
* @throws NoSuchElementException
* if {@code firstIndexFinder} didn't return {@code true} at all
*/
int skipBytes(ChannelBufferIndexFinder firstIndexFinder);
int skipBytes(ChannelBufferIndexFinder indexFinder);
/**
* Sets the specified byte at the current {@code writerIndex}
@ -1201,7 +1257,32 @@ public interface ChannelBuffer extends Comparable<ChannelBuffer> {
*/
void writeZero(int length);
/**
* Locates the first occurrence of the specified {@code value} in this
* buffer. The search takes place from the specified {@code fromIndex}
* (inclusive) to the specified {@code toIndex} (exclusive).
* <p>
* If {@code fromIndex} is greater than {@code toIndex}, the search is
* performed in a reversed order.
*
* @return the absolute index of the first occurrence if found.
* {@code -1} otherwise.
*/
int indexOf(int fromIndex, int toIndex, byte value);
/**
* Locates the first index where the specified {@code indexFinder}
* returns {@code true}. The search takes place from the specified
* {@code fromIndex} (inclusive) to the specified {@code toIndex}
* (exclusive).
* <p>
* If {@code fromIndex} is greater than {@code toIndex}, the search is
* performed in a reversed order.
*
* @return the absolute index where the specified {@code indexFinder}
* returned {@code true} if the {@code indexFinder} returned
* {@code true}. {@code -1} otherwise.
*/
int indexOf(int fromIndex, int toIndex, ChannelBufferIndexFinder indexFinder);
/**

17
src/main/java/org/jboss/netty/buffer/ChannelBuffers.java
View File

@ -630,10 +630,9 @@ public class ChannelBuffers {
}
/**
* Returns {@code true} if and only if the two specified buffers have the
* same content and the same readable bytes. They don't need to have the
* same {@code readerIndex}. This method is useful when implementing a
* new buffer type.
* Returns {@code true} if and only if the two specified buffers are
* identical to each other as described in {@code ChannelBuffer#equals(Object)}.
* This method is useful when implementing a new buffer type.
*/
public static boolean equals(ChannelBuffer bufferA, ChannelBuffer bufferB) {
final int aLen = bufferA.readableBytes();
@ -666,7 +665,7 @@ public class ChannelBuffers {
}
/**
* Compares the two specified buffers as described in {@link Comparable}.
* Compares the two specified buffers as described in {@link ChannelBuffer#compareTo(ChannelBuffer)}.
* This method is useful when implementing a new buffer type.
*/
public static int compare(ChannelBuffer bufferA, ChannelBuffer bufferB) {
@ -705,6 +704,10 @@ public class ChannelBuffers {
return aLen - bLen;
}
/**
* The default implementation of {@link ChannelBuffer#indexOf(int, int, byte)}.
* This method is useful when implementing a new buffer type.
*/
public static int indexOf(ChannelBuffer buffer, int fromIndex, int toIndex, byte value) {
if (fromIndex <= toIndex) {
return firstIndexOf(buffer, fromIndex, toIndex, value);
@ -713,6 +716,10 @@ public class ChannelBuffers {
}
}
/**
* The default implementation of {@link ChannelBuffer#indexOf(int, int, ChannelBufferIndexFinder)}.
* This method is useful when implementing a new buffer type.
*/
public static int indexOf(ChannelBuffer buffer, int fromIndex, int toIndex, ChannelBufferIndexFinder indexFinder) {
if (fromIndex <= toIndex) {
return firstIndexOf(buffer, fromIndex, toIndex, indexFinder);