commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Gary Gregory <garydgreg...@gmail.com>
Subject Re: svn commit: r1459447 - in /commons/proper/csv/trunk/src/main/java/org/apache/commons/csv: CSVFormat.java CSVParser.java
Date Thu, 21 Mar 2013 20:13:15 GMT
On Mar 21, 2013, at 16:04, sebb <sebbaz@gmail.com> wrote:

> On 21 March 2013 18:47,  <ggregory@apache.org> wrote:
>> Author: ggregory
>> Date: Thu Mar 21 18:47:40 2013
>> New Revision: 1459447
>>
>> URL: http://svn.apache.org/r1459447
>> Log:
>> Javadoc.
>>
>> Modified:
>>    commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java
>>    commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVParser.java
>>
>> Modified: commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java
>> URL: http://svn.apache.org/viewvc/commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java?rev=1459447&r1=1459446&r2=1459447&view=diff
>> ==============================================================================
>> --- commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java
(original)
>> +++ commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java
Thu Mar 21 18:47:40 2013
>> @@ -136,6 +136,13 @@ public class CSVFormat implements Serial
>>         return new CSVFormatBuilder(delimiter);
>>     }
>>
>> +    /**
>> +     * Creates a CSVFormatBuilder, using the values of the given CSVFormat.
>> +     *
>> +     * @param format
>> +     *            The format to use values from
>> +     * @return a new CSVFormatBuilder
>> +     */
>>     public static CSVFormatBuilder newBuilder(final CSVFormat format) {
>>         return new CSVFormatBuilder(format);
>>     }
>> @@ -326,6 +333,7 @@ public class CSVFormat implements Serial
>>      *
>>      * @param in
>>      *            the input stream
>> +     * @throws IOException
>
> There should be an explanation of when the exception is thrown please,
> otherwise there's no point in adding the tag.

Agreed. That was an inadvertent add. I plan on reviewing all the docs
again once the API is final.

Gary
>
>>      */
>>     public Iterable<CSVRecord> parse(final Reader in) throws IOException {
>>         return new CSVParser(in, this);
>> @@ -484,6 +492,9 @@ public class CSVFormat implements Serial
>>         return true;
>>     }
>>
>> +    /**
>> +     * Builds CSVFormat objects.
>> +     */
>>     public static class CSVFormatBuilder {
>>
>>         private char delimiter;
>> @@ -540,7 +551,6 @@ public class CSVFormat implements Serial
>>         }
>>
>>         /**
>> -         *
>>          * Creates a CSVFormatBuilder, using the values of the given CSVFormat.
>>          *
>>          * @param format
>> @@ -567,6 +577,11 @@ public class CSVFormat implements Serial
>>             this(delimiter, null, null, null, null, false, false, null, null);
>>         }
>>
>> +        /**
>> +         * Builds a new CSVFormat configured with the values from this builder.
>> +         *
>> +         * @return a new CSVFormat
>> +         */
>>         public CSVFormat build() {
>>             validate();
>>             return new CSVFormat(delimiter, quoteChar, quotePolicy, commentStart,
escape,
>>
>> Modified: commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVParser.java
>> URL: http://svn.apache.org/viewvc/commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVParser.java?rev=1459447&r1=1459446&r2=1459447&view=diff
>> ==============================================================================
>> --- commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVParser.java
(original)
>> +++ commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVParser.java
Thu Mar 21 18:47:40 2013
>> @@ -96,7 +96,7 @@ public class CSVParser implements Iterab
>>      * Customized CSV parser using the given {@link CSVFormat}
>>      *
>>      * @param input
>> -     *            a Reader containing "csv-formatted" input
>> +     *            a Reader containing CSV-formatted input
>>      * @param format
>>      *            the CSVFormat used for CSV parsing
>>      * @throws IllegalArgumentException
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Mime
View raw message