Return-Path: X-Original-To: apmail-hadoop-common-issues-archive@minotaur.apache.org Delivered-To: apmail-hadoop-common-issues-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 9030FCD67 for ; Tue, 30 Dec 2014 14:46:18 +0000 (UTC) Received: (qmail 84469 invoked by uid 500); 30 Dec 2014 14:46:13 -0000 Delivered-To: apmail-hadoop-common-issues-archive@hadoop.apache.org Received: (qmail 84425 invoked by uid 500); 30 Dec 2014 14:46:13 -0000 Mailing-List: contact common-issues-help@hadoop.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: common-issues@hadoop.apache.org Delivered-To: mailing list common-issues@hadoop.apache.org Received: (qmail 84413 invoked by uid 99); 30 Dec 2014 14:46:13 -0000 Received: from arcas.apache.org (HELO arcas.apache.org) (140.211.11.28) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 30 Dec 2014 14:46:13 +0000 Date: Tue, 30 Dec 2014 14:46:13 +0000 (UTC) From: "Hudson (JIRA)" To: common-issues@hadoop.apache.org Message-ID: In-Reply-To: References: Subject: [jira] [Commented] (HADOOP-11039) ByteBufferReadable API doc is inconsistent with the implementations. MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 [ https://issues.apache.org/jira/browse/HADOOP-11039?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14261129#comment-14261129 ] Hudson commented on HADOOP-11039: --------------------------------- FAILURE: Integrated in Hadoop-Hdfs-trunk-Java8 #54 (See [https://builds.apache.org/job/Hadoop-Hdfs-trunk-Java8/54/]) HADOOP-11039. ByteBufferReadable API doc is inconsistent with the implementations. (Yi Liu via Colin P. McCabe) (cmccabe: rev 249cc905017948d64aab3d14d7a64df3b7b35a13) * hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/ByteBufferReadable.java * hadoop-common-project/hadoop-common/CHANGES.txt > ByteBufferReadable API doc is inconsistent with the implementations. > -------------------------------------------------------------------- > > Key: HADOOP-11039 > URL: https://issues.apache.org/jira/browse/HADOOP-11039 > Project: Hadoop Common > Issue Type: Bug > Components: documentation > Reporter: Yi Liu > Assignee: Yi Liu > Priority: Minor > Fix For: 2.7.0 > > Attachments: HADOOP-11039.001.patch > > > In {{ByteBufferReadable}}, API doc of {{int read(ByteBuffer buf)}} says: > {quote} > 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. > {quote} > {quote} > @param buf > the ByteBuffer to receive the results of the read operation. Up to > buf.limit() - buf.position() bytes may be read. > {quote} > But actually the implementations (e.g. {{DFSInputStream}}, {{RemoteBlockReader2}}) would be: > *Upon return, buf.position() will be advanced by the number of bytes read.* > code implementation of {{RemoteBlockReader2}} is as following: > {code} > @Override > public int read(ByteBuffer buf) throws IOException { > if (curDataSlice == null || curDataSlice.remaining() == 0 && bytesNeededToFinish > 0) { > readNextPacket(); > } > if (curDataSlice.remaining() == 0) { > // we're at EOF now > return -1; > } > int nRead = Math.min(curDataSlice.remaining(), buf.remaining()); > ByteBuffer writeSlice = curDataSlice.duplicate(); > writeSlice.limit(writeSlice.position() + nRead); > buf.put(writeSlice); > curDataSlice.position(writeSlice.position()); > return nRead; > } > {code} > This description is very important and will guide user how to use this API, and all the implementations should keep the same behavior. We should fix the javadoc. -- This message was sent by Atlassian JIRA (v6.3.4#6332)