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

[#1196] Make it clear that addComponent(..) of CompositeByteBuf does NOT increase the writerIndex

Browse Source
This commit is contained in:
Norman Maurer 2013-03-25 10:58:50 +01:00
parent 20d76610da
commit 4eb0172251
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
buffer/src/main/java/io/netty/buffer/CompositeByteBuf.java
View File

@ -28,6 +28,9 @@ public interface CompositeByteBuf extends ByteBuf, Iterable<ByteBuf> {
/**
* Add the given {@link ByteBuf}.
*
* Be aware that this method does not increase the {@code writerIndex} of the {@link CompositeByteBuf}.
* If you need to have it increased you need to handle it by your own.
*
* @param buffer the {@link ByteBuf} to add
* @return self this instance
*/
@ -36,6 +39,9 @@ public interface CompositeByteBuf extends ByteBuf, Iterable<ByteBuf> {
/**
* Add the given {@link ByteBuf} on the specific index.
*
* Be aware that this method does not increase the {@code writerIndex} of the {@link CompositeByteBuf}.
* If you need to have it increased you need to handle it by your own.
*
* @param cIndex
* the index on which the {@link ByteBuf} will be added
* @param buffer
@ -50,6 +56,9 @@ public interface CompositeByteBuf extends ByteBuf, Iterable<ByteBuf> {
/**
* Add the given {@link ByteBuf}s.
*
* Be aware that this method does not increase the {@code writerIndex} of the {@link CompositeByteBuf}.
* If you need to have it increased you need to handle it by your own.
*
* @param buffers the {@link ByteBuf}s to add
* @return self this instance
*/
@ -58,6 +67,9 @@ public interface CompositeByteBuf extends ByteBuf, Iterable<ByteBuf> {
/**
* Add the given {@link ByteBuf}s.
*
* Be aware that this method does not increase the {@code writerIndex} of the {@link CompositeByteBuf}.
* If you need to have it increased you need to handle it by your own.
*
* @param buffers the {@link ByteBuf}s to add
* @return self this instance
*/
@ -66,6 +78,9 @@ public interface CompositeByteBuf extends ByteBuf, Iterable<ByteBuf> {
/**
* Add the given {@link ByteBuf}s on the specific index
*
* Be aware that this method does not increase the {@code writerIndex} of the {@link CompositeByteBuf}.
* If you need to have it increased you need to handle it by your own.
*
* @param cIndex
* the index on which the {@link ByteBuf} will be added.
* @param buffers
@ -81,6 +96,9 @@ public interface CompositeByteBuf extends ByteBuf, Iterable<ByteBuf> {
/**
* Add the given {@link ByteBuf}s on the specific index
*
* Be aware that this method does not increase the {@code writerIndex} of the {@link CompositeByteBuf}.
* If you need to have it increased you need to handle it by your own.
*
* @param cIndex
* the index on which the {@link ByteBuf} will be added.
* @param buffers