Return-Path: X-Original-To: apmail-commons-dev-archive@www.apache.org Delivered-To: apmail-commons-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id B8B60F170 for ; Wed, 20 Mar 2013 19:53:59 +0000 (UTC) Received: (qmail 34366 invoked by uid 500); 20 Mar 2013 19:53:59 -0000 Delivered-To: apmail-commons-dev-archive@commons.apache.org Received: (qmail 34237 invoked by uid 500); 20 Mar 2013 19:53:59 -0000 Mailing-List: contact dev-help@commons.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: "Commons Developers List" Delivered-To: mailing list dev@commons.apache.org Received: (qmail 34220 invoked by uid 99); 20 Mar 2013 19:53:59 -0000 Received: from minotaur.apache.org (HELO minotaur.apache.org) (140.211.11.9) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 20 Mar 2013 19:53:59 +0000 Received: from localhost (HELO mail-wg0-f54.google.com) (127.0.0.1) (smtp-auth username britter, mechanism plain) by minotaur.apache.org (qpsmtpd/0.29) with ESMTP; Wed, 20 Mar 2013 19:53:58 +0000 Received: by mail-wg0-f54.google.com with SMTP id fm10so1633101wgb.21 for ; Wed, 20 Mar 2013 12:53:56 -0700 (PDT) MIME-Version: 1.0 X-Received: by 10.180.12.48 with SMTP id v16mr583119wib.1.1363809236791; Wed, 20 Mar 2013 12:53:56 -0700 (PDT) Received: by 10.194.7.42 with HTTP; Wed, 20 Mar 2013 12:53:56 -0700 (PDT) In-Reply-To: <20130320195228.5171B23888CD@eris.apache.org> References: <20130320195228.5171B23888CD@eris.apache.org> Date: Wed, 20 Mar 2013 20:53:56 +0100 Message-ID: Subject: Re: svn commit: r1459020 - /commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVRecord.java From: Benedikt Ritter To: Commons Developers List Content-Type: multipart/alternative; boundary=001a11c2236419bbe304d86095cb --001a11c2236419bbe304d86095cb Content-Type: text/plain; charset=ISO-8859-1 2013/3/20 > Author: britter > Date: Wed Mar 20 19:52:27 2013 > New Revision: 1459020 > > URL: http://svn.apache.org/r1459020 > Log: > Add missing JavaDoc > > Modified: > > commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVRecord.java > > Modified: > commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVRecord.java > URL: > http://svn.apache.org/viewvc/commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVRecord.java?rev=1459020&r1=1459019&r2=1459020&view=diff > > ============================================================================== > --- > commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVRecord.java > (original) > +++ > commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVRecord.java > Wed Mar 20 19:52:27 2013 > @@ -23,7 +23,7 @@ import java.util.Iterator; > import java.util.Map; > > /** > - * A CSV record > + * A CSV record parsed from a CSV file. > * > * @version $Id$ > */ > @@ -103,6 +103,11 @@ public class CSVRecord implements Serial > return isMapped(name) && mapping.get(name).intValue() < > values.length; > } > > + /** > + * Returns an iterator over the values of this record. > + * > + * @return an iterator over the values of this record. > + */ > I had no better idea how to comment this. Any suggestions how to make this less redundant? > public Iterator iterator() { > return Arrays.asList(values).iterator(); > } > @@ -111,16 +116,29 @@ public class CSVRecord implements Serial > return values; > } > > + /** > + * Returns the comment for this record, if any. > + * > + * @return the comment for this record, or null if no comment for this > + * record is available. > + */ > public String getComment() { > return comment; > } > > + /** > + * Returns the number of this record in the parsed CSV file. > + * > + * @return the number of this record. > + */ > public long getRecordNumber() { > return recordNumber; > } > > /** > * Returns the number of values in this record. > + * > + * @return the number of values. > */ > public int size() { > return values.length; > > > --001a11c2236419bbe304d86095cb--