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

Fix ByteBuf.nioBuffer(...) and nioBuffers(...) docs to reflect reality.

Browse Source 
Motivation:

Depending on the implementation of ByteBuf nioBuffer(...) and nioBuffers(...) may either share the content or return a ByteBuffer that contains a copy of the content.

Modifications:

Fix javadocs.

Result:

Correct docs.
This commit is contained in:
Norman Maurer 2018-01-21 09:10:39 +01:00
parent ea58dc7ac7
commit 336bea9dc5
1 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
buffer/src/main/java/io/netty/buffer/ByteBuf.java
View File

@ -2280,13 +2280,13 @@ public abstract class ByteBuf implements ReferenceCounted, Comparable<ByteBuf> {
public abstract int nioBufferCount(); public abstract int nioBufferCount();
/** /**
* Exposes this buffer's readable bytes as an NIO {@link ByteBuffer}. The returned buffer * Exposes this buffer's readable bytes as an NIO {@link ByteBuffer}. The returned buffer
* shares the content with this buffer, while changing the position and limit of the returned * either share or contains the copied content of this buffer, while changing the position
* NIO buffer does not affect the indexes and marks of this buffer. This method is identical * and limit of the returned NIO buffer does not affect the indexes and marks of this buffer.
* to {@code buf.nioBuffer(buf.readerIndex(), buf.readableBytes())}. This method does not * This method is identical to {@code buf.nioBuffer(buf.readerIndex(), buf.readableBytes())}.
* modify {@code readerIndex} or {@code writerIndex} of this buffer. Please note that the * This method does not modify {@code readerIndex} or {@code writerIndex} of this buffer.
* returned NIO buffer will not see the changes of this buffer if this buffer is a dynamic * Please note that the returned NIO buffer will not see the changes of this buffer if this buffer
* buffer and it adjusted its capacity. * is a dynamic buffer and it adjusted its capacity.
* *
* @throws UnsupportedOperationException * @throws UnsupportedOperationException
* if this buffer cannot create a {@link ByteBuffer} that shares the content with itself * if this buffer cannot create a {@link ByteBuffer} that shares the content with itself
@ -2298,12 +2298,12 @@ public abstract class ByteBuf implements ReferenceCounted, Comparable<ByteBuf> {
public abstract ByteBuffer nioBuffer(); public abstract ByteBuffer nioBuffer();
/** /**
* Exposes this buffer's sub-region as an NIO {@link ByteBuffer}. The returned buffer * Exposes this buffer's sub-region as an NIO {@link ByteBuffer}. The returned buffer
* shares the content with this buffer, while changing the position and limit of the returned * either share or contains the copied content of this buffer, while changing the position
* NIO buffer does not affect the indexes and marks of this buffer. This method does not * and limit of the returned NIO buffer does not affect the indexes and marks of this buffer.
* modify {@code readerIndex} or {@code writerIndex} of this buffer. Please note that the * This method does not modify {@code readerIndex} or {@code writerIndex} of this buffer.
* returned NIO buffer will not see the changes of this buffer if this buffer is a dynamic * Please note that the returned NIO buffer will not see the changes of this buffer if this buffer
* buffer and it adjusted its capacity. * is a dynamic buffer and it adjusted its capacity.
* *
* @throws UnsupportedOperationException * @throws UnsupportedOperationException
* if this buffer cannot create a {@link ByteBuffer} that shares the content with itself * if this buffer cannot create a {@link ByteBuffer} that shares the content with itself
@ -2320,12 +2320,12 @@ public abstract class ByteBuf implements ReferenceCounted, Comparable<ByteBuf> {
public abstract ByteBuffer internalNioBuffer(int index, int length); public abstract ByteBuffer internalNioBuffer(int index, int length);
/** /**
* Exposes this buffer's readable bytes as an NIO {@link ByteBuffer}'s. The returned buffer * Exposes this buffer's readable bytes as an NIO {@link ByteBuffer}'s. The returned buffer
* shares the content with this buffer, while changing the position and limit of the returned * either share or contains the copied content of this buffer, while changing the position
* NIO buffer does not affect the indexes and marks of this buffer. This method does not * and limit of the returned NIO buffer does not affect the indexes and marks of this buffer.
* modify {@code readerIndex} or {@code writerIndex} of this buffer. Please note that the * This method does not modify {@code readerIndex} or {@code writerIndex} of this buffer.
* returned NIO buffer will not see the changes of this buffer if this buffer is a dynamic * Please note that the returned NIO buffer will not see the changes of this buffer if this buffer
* buffer and it adjusted its capacity. * is a dynamic buffer and it adjusted its capacity.
* *
* *
* @throws UnsupportedOperationException * @throws UnsupportedOperationException
@ -2339,9 +2339,9 @@ public abstract class ByteBuf implements ReferenceCounted, Comparable<ByteBuf> {
/** /**
* Exposes this buffer's bytes as an NIO {@link ByteBuffer}'s for the specified index and length * Exposes this buffer's bytes as an NIO {@link ByteBuffer}'s for the specified index and length
* The returned buffer shares the content with this buffer, while changing the position and limit * The returned buffer either share or contains the copied content of this buffer, while changing
* of the returned NIO buffer does not affect the indexes and marks of this buffer. This method does * the position and limit of the returned NIO buffer does not affect the indexes and marks of this buffer.
* not modify {@code readerIndex} or {@code writerIndex} of this buffer. Please note that the * This method does not modify {@code readerIndex} or {@code writerIndex} of this buffer. Please note that the
* returned NIO buffer will not see the changes of this buffer if this buffer is a dynamic * returned NIO buffer will not see the changes of this buffer if this buffer is a dynamic
* buffer and it adjusted its capacity. * buffer and it adjusted its capacity.
* *