Skip to content

KAFKA-19877: Clarify Deserializer ByteBuffer position/limit contract #22791

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

Open
vismaytiwari wants to merge 1 commit into
base: trunk
Choose a base branch
from
+6 −0
Open

KAFKA-19877: Clarify Deserializer ByteBuffer position/limit contract #22791

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
6 changes: 6 additions & 0 deletions clients/src/main/java/org/apache/kafka/common/serialization/Deserializer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,12 @@ default T deserialize(String topic, Headers headers, byte[] data) {
* <p>Similarly, if this method is overridden, the implementation cannot make any assumptions about the
* passed in {@link ByteBuffer} either.
*
* <p>The serialized bytes are the buffer's {@link ByteBuffer#remaining() remaining} bytes, i.e. those
* between its current {@code position} and {@code limit}. An implementation should read the data without
* changing the buffer's {@code position}, {@code limit}, or {@code mark}: the caller retains ownership of
* the buffer and may read it again after this method returns (for example, to determine the serialized
* size of the value), so mutating the buffer's state can corrupt unrelated processing.
*
* <p>It is recommended to deserialize a {@code null} {@link ByteBuffer} to a {@code null} object.
*
* <p>Note that the passed in {@link Headers} may be empty, but never {@code null}.
Expand Down