Skip to content

Clarify usage in documentation for MessagePacker.addPayload() #473

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xerial merged 1 commit into from
Apr 22, 2018
Merged

Clarify usage in documentation for MessagePacker.addPayload() #473

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions msgpack-core/src/main/java/org/msgpack/core/MessagePacker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1025,13 +1025,17 @@ public MessagePacker writePayload(byte[] src, int off, int len)
/**
* Writes a byte array to the output.
* <p>
* Unlike {@link #writePayload(byte[])} method, this method doesn't copy the byte array even when given byte
* array is shorter than {@link MessagePack.PackerConfig#withBufferFlushThreshold(int)}. This is faster than
* {@link #writePayload(byte[])} method but caller must not modify the byte array after calling this method.
* This method is used with {@link #packRawStringHeader(int)} or {@link #packBinaryHeader(int)} methods.
* <p>
* Unlike {@link #writePayload(byte[])} method, this method does not make a defensive copy of the given byte
* array, even if it is shorter than {@link MessagePack.PackerConfig#withBufferFlushThreshold(int)}. This is
* faster than {@link #writePayload(byte[])} method but caller must not modify the byte array after calling
* this method.
*
* @param src the data to add
* @return this
* @throws IOException when underlying output throws IOException
* @see #writePayload(byte[])
*/
public MessagePacker addPayload(byte[] src)
throws IOException
Expand All @@ -1042,16 +1046,19 @@ public MessagePacker addPayload(byte[] src)
/**
* Writes a byte array to the output.
* <p>
* Unlike {@link #writePayload(byte[], int, int)} method, this method doesn't copy the byte array even when
* given byte array is shorter than {@link MessagePack.PackerConfig#withBufferFlushThreshold(int)}.
* This is faster than {@link #writePayload(byte[], int, int)} method but caller must not modify the byte array
* after calling this method.
* This method is used with {@link #packRawStringHeader(int)} or {@link #packBinaryHeader(int)} methods.
* <p>
* Unlike {@link #writePayload(byte[], int, int)} method, this method does not make a defensive copy of the
* given byte array, even if it is shorter than {@link MessagePack.PackerConfig#withBufferFlushThreshold(int)}.
* This is faster than {@link #writePayload(byte[])} method but caller must not modify the byte array after
* calling this method.
*
* @param src the data to add
* @param off the start offset in the data
* @param len the number of bytes to add
* @return this
* @throws IOException when underlying output throws IOException
* @see #writePayload(byte[], int, int)
*/
public MessagePacker addPayload(byte[] src, int off, int len)
throws IOException
Expand Down