[HADOOP-11434] Correct the comment of ByteBufferReadable#read

• Type: Bug
• Status: Resolved
• Priority: Minor
• Resolution: Duplicate
• Component/s: documentation
• Assignee: Dian Fu
• Reporter: Dian Fu
• Created: 19/Dec/14 09:08
• Updated: 21/Dec/14 09:24
• Resolved: 19/Dec/14 13:08

Description

The following comment of ByteBufferReadable#read seems not correct, actually, the position of buf should be updated:

After a successful call, buf.position() and buf.limit() should be
-   * unchanged, and therefore any data can be immediately read from buf.
-   * buf.mark() may be cleared or updated.

Issue Links

• duplicates: HADOOP-11039 ByteBufferReadable API doc is inconsistent with the implementations.