Improve comments on ByteBufferReadable.read
-------------------------------------------
Key: HADOOP-8244
URL: https://issues.apache.org/jira/browse/HADOOP-8244
Project: Hadoop Common
Issue Type: Improvement
Reporter: Henry Robinson
Assignee: Henry Robinson
There are a couple of ways in which the comment on ByteBufferReadable.read can
be improved. Since this is a public-facing API with potentially many
implementations, it's worth taking the time to get it right.
* We should describe what can become of the byte buffer state in the case of an
exception (is the limit changed? where's the position?). For the DFSInputStream
implementation, position and limit are unchanged if there is an error, but I
don't think that's the right think to mandate for all implementations.
* We should mention explicitly that 0-byte reads are legitimate - this is
particularly important in light of HDFS-3110 which detects support for direct
reads by issuing a 0-byte read from libhdfs.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
