commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Benedikt Ritter <brit...@apache.org>
Subject Re: svn commit: r1459020 - /commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVRecord.java
Date Wed, 20 Mar 2013 19:53:56 GMT
2013/3/20 <britter@apache.org>

> 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<String> 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;
>
>
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message