Return-Path: Delivered-To: apmail-commons-commits-archive@locus.apache.org Received: (qmail 40873 invoked from network); 22 Jan 2009 00:52:38 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 22 Jan 2009 00:52:38 -0000 Received: (qmail 39983 invoked by uid 500); 22 Jan 2009 00:52:37 -0000 Delivered-To: apmail-commons-commits-archive@commons.apache.org Received: (qmail 39947 invoked by uid 500); 22 Jan 2009 00:52:37 -0000 Mailing-List: contact commits-help@commons.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@commons.apache.org Delivered-To: mailing list commits@commons.apache.org Received: (qmail 39938 invoked by uid 99); 22 Jan 2009 00:52:37 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 21 Jan 2009 16:52:37 -0800 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 22 Jan 2009 00:52:36 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 6562C2388A16; Wed, 21 Jan 2009 16:52:16 -0800 (PST) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r736507 - /commons/proper/io/trunk/src/java/org/apache/commons/io/HexDump.java Date: Thu, 22 Jan 2009 00:52:16 -0000 To: commits@commons.apache.org From: jukka@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20090122005216.6562C2388A16@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: jukka Date: Wed Jan 21 16:52:15 2009 New Revision: 736507 URL: http://svn.apache.org/viewvc?rev=736507&view=rev Log: IO-189: update javadoc on HexDump.dump method Modified: commons/proper/io/trunk/src/java/org/apache/commons/io/HexDump.java Modified: commons/proper/io/trunk/src/java/org/apache/commons/io/HexDump.java URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/HexDump.java?rev=736507&r1=736506&r2=736507&view=diff ============================================================================== --- commons/proper/io/trunk/src/java/org/apache/commons/io/HexDump.java (original) +++ commons/proper/io/trunk/src/java/org/apache/commons/io/HexDump.java Wed Jan 21 16:52:15 2009 @@ -41,10 +41,24 @@ } /** - * Dump an array of bytes to an OutputStream. + * Dump an array of bytes to an OutputStream. The output is formatted + * for human inspection, with a hexadecimal offset followed by the + * hexadecimal values of the next 16 bytes of data and the printable ASCII + * characters (if any) that those bytes represent printed per each line + * of output. + *

+ * The offset argument specifies the start offset of the data array + * within a larger entity like a file or an incoming stream. For example, + * if the data array contains the third kibibyte of a file, then the + * offset argument should be set to 2048. The offset value printed + * at the beginning of each line indicates where in that larger entity + * the first byte on that line is located. + *

+ * All bytes between the given index (inclusive) and the end of the + * data array are dumped. * * @param data the byte array to be dumped - * @param offset its offset, whatever that might mean + * @param offset offset of the byte array within a larger entity * @param stream the OutputStream to which the data is to be * written * @param index initial index into the byte array