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

Fixes a javadoc for ByteBufUtil#copy method

Browse Source 
Motivation:
Javadoc of the `ByteBufUtil#copy(AsciiString, int, ByteBuf, int, int)` is incorrect.

Modifications:
Fix it.

Result:
The description of the `#copy` method is not misleading.
This commit is contained in:
Nikolay Fedorovskikh 2017-10-14 00:48:30 +05:00 committed by Norman Maurer
parent 09dd6a5d4d
commit 17e1a26d64
1 changed files with 17 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
buffer/src/main/java/io/netty/buffer/ByteBufUtil.java
View File

@ -776,20 +776,24 @@ public final class ByteBufUtil {
/** /**
* Copies the all content of {@code src} to a {@link ByteBuf} using {@link ByteBuf#writeBytes(byte[], int, int)}. * Copies the all content of {@code src} to a {@link ByteBuf} using {@link ByteBuf#writeBytes(byte[], int, int)}.
* @param src The source of the data to copy. *
* @param dst the destination byte array. * @param src the source string to copy
* @param dst the destination buffer
*/ */
public static void copy(AsciiString src, ByteBuf dst) { public static void copy(AsciiString src, ByteBuf dst) {
copy(src, 0, dst, src.length()); copy(src, 0, dst, src.length());
} }
/** /**
* Copies the content of {@code src} to a {@link ByteBuf} using {@link ByteBuf#writeBytes(byte[], int, int)}. * Copies the content of {@code src} to a {@link ByteBuf} using {@link ByteBuf#setBytes(int, byte[], int, int)}.
* @param src The source of the data to copy. * Unlike the {@link #copy(AsciiString, ByteBuf)} and {@link #copy(AsciiString, int, ByteBuf, int)} methods,
* @param srcIdx the starting offset of characters to copy. * this method do not increase a {@code writerIndex} of {@code dst} buffer.
* @param dst the destination byte array. *
* @param dstIdx the starting offset in the destination byte array. * @param src the source string to copy
* @param length the number of characters to copy. * @param srcIdx the starting offset of characters to copy
* @param dst the destination buffer
* @param dstIdx the starting offset in the destination buffer
* @param length the number of characters to copy
*/ */
public static void copy(AsciiString src, int srcIdx, ByteBuf dst, int dstIdx, int length) { public static void copy(AsciiString src, int srcIdx, ByteBuf dst, int dstIdx, int length) {
if (isOutOfBounds(srcIdx, length, src.length())) { if (isOutOfBounds(srcIdx, length, src.length())) {
@ -802,10 +806,11 @@ public final class ByteBufUtil {
/** /**
* Copies the content of {@code src} to a {@link ByteBuf} using {@link ByteBuf#writeBytes(byte[], int, int)}. * Copies the content of {@code src} to a {@link ByteBuf} using {@link ByteBuf#writeBytes(byte[], int, int)}.
* @param src The source of the data to copy. *
* @param srcIdx the starting offset of characters to copy. * @param src the source string to copy
* @param dst the destination byte array. * @param srcIdx the starting offset of characters to copy
* @param length the number of characters to copy. * @param dst the destination buffer
* @param length the number of characters to copy
*/ */
public static void copy(AsciiString src, int srcIdx, ByteBuf dst, int length) { public static void copy(AsciiString src, int srcIdx, ByteBuf dst, int length) {
if (isOutOfBounds(srcIdx, length, src.length())) { if (isOutOfBounds(srcIdx, length, src.length())) {