Skip to content

KAFKA-19877: Clarify ByteBuffer position and limit expectations for Deserializer #21371

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
Shally-Katariya wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

KAFKA-19877: Clarify ByteBuffer position and limit expectations for Deserializer #21371

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
5 changes: 5 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 @@ -94,6 +94,11 @@ 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 deserializer is expected to read data starting from the buffer's current position.
* Implementations may advance the buffer position by the number of bytes consumed during
* deserialization, but must not modify the buffer limit. Callers should not make assumptions
* about the buffer's position after deserialization and should treat the buffer as consumed.</p>
*
* <p>It is recommended to deserialize a {@code null} {@link ByteBuffer} to a {@code null} object.
*
Expand Down