You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by sebb <se...@gmail.com> on 2013/04/16 17:56:35 UTC
Re: svn commit: r1467666 - /commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java
On 13 April 2013 18:55, <br...@apache.org> wrote:
> Author: britter
> Date: Sat Apr 13 17:55:16 2013
> New Revision: 1467666
>
> URL: http://svn.apache.org/r1467666
> Log:
> Change JavaDoc to match actual parameter name
>
> Modified:
>
> commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.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=1467666&r1=1467665&r2=1467666&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
> Sat Apr 13 17:55:16 2013
> @@ -98,7 +98,7 @@ public class CSVFormat implements Serial
> * @param nullToString TODO
> * @param header
> * the header
> - * @param recordSeparator
> + * @param lineSeparator
> * the line separator to use for output
>
Is it really a line separator?
Or is is a record separator?
It seems to me more like a record separator; often the chosen record
separator is a new-line (or CRLF).
The private field in which the value is stored is called "recordSeparator"
but the API uses lineSeparator.
I think the name "recordSeparator" is more appropriate.
* @throws IllegalArgumentException if the delimiter is a line
> break character
> */
>
>
>
Re: svn commit: r1467666 - /commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java
Posted by sebb <se...@gmail.com>.
On 17 April 2013 07:47, Benedikt Ritter <br...@apache.org> wrote:
> Thanks for pointing that out. I'll change that as soon as I get the time.
>
I'm happy to change it; we now seem to have agreement.
> Benedikt
>
>
> 2013/4/16 Gary Gregory <ga...@gmail.com>
>
> > I think Sebb is correct.
> >
> > Record separators are usually some kind of line separators (CR/LF).
> >
> > In addition, fields can contain /escaped/ line separators IIRC.
> >
> > Gary
> >
> >
> > On Tue, Apr 16, 2013 at 11:56 AM, sebb <se...@gmail.com> wrote:
> >
> > > On 13 April 2013 18:55, <br...@apache.org> wrote:
> > >
> > > > Author: britter
> > > > Date: Sat Apr 13 17:55:16 2013
> > > > New Revision: 1467666
> > > >
> > > > URL: http://svn.apache.org/r1467666
> > > > Log:
> > > > Change JavaDoc to match actual parameter name
> > > >
> > > > Modified:
> > > >
> > > >
> > >
> >
> commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.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=1467666&r1=1467665&r2=1467666&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
> > > > Sat Apr 13 17:55:16 2013
> > > > @@ -98,7 +98,7 @@ public class CSVFormat implements Serial
> > > > * @param nullToString TODO
> > > > * @param header
> > > > * the header
> > > > - * @param recordSeparator
> > > > + * @param lineSeparator
> > > > * the line separator to use for output
> > > >
> > >
> > > Is it really a line separator?
> > > Or is is a record separator?
> > >
> > > It seems to me more like a record separator; often the chosen record
> > > separator is a new-line (or CRLF).
> > >
> > > The private field in which the value is stored is called
> > "recordSeparator"
> > > but the API uses lineSeparator.
> > >
> > > I think the name "recordSeparator" is more appropriate.
> > >
> > > * @throws IllegalArgumentException if the delimiter is a line
> > > > break character
> > > > */
> > > >
> > > >
> > > >
> > >
> >
> >
> >
> > --
> > E-Mail: garydgregory@gmail.com | ggregory@apache.org
> > Java Persistence with Hibernate, Second Edition<
> > http://www.manning.com/bauer3/>
> > JUnit in Action, Second Edition <http://www.manning.com/tahchiev/>
> > Spring Batch in Action <http://www.manning.com/templier/>
> > Blog: http://garygregory.wordpress.com
> > Home: http://garygregory.com/
> > Tweet! http://twitter.com/GaryGregory
> >
>
>
>
> --
> http://people.apache.org/~britter/
> http://www.systemoutprintln.de/
> http://twitter.com/BenediktRitter
> http://github.com/britter
>
Re: svn commit: r1467666 - /commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java
Posted by Benedikt Ritter <br...@apache.org>.
Thanks for pointing that out. I'll change that as soon as I get the time.
Benedikt
2013/4/16 Gary Gregory <ga...@gmail.com>
> I think Sebb is correct.
>
> Record separators are usually some kind of line separators (CR/LF).
>
> In addition, fields can contain /escaped/ line separators IIRC.
>
> Gary
>
>
> On Tue, Apr 16, 2013 at 11:56 AM, sebb <se...@gmail.com> wrote:
>
> > On 13 April 2013 18:55, <br...@apache.org> wrote:
> >
> > > Author: britter
> > > Date: Sat Apr 13 17:55:16 2013
> > > New Revision: 1467666
> > >
> > > URL: http://svn.apache.org/r1467666
> > > Log:
> > > Change JavaDoc to match actual parameter name
> > >
> > > Modified:
> > >
> > >
> >
> commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.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=1467666&r1=1467665&r2=1467666&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
> > > Sat Apr 13 17:55:16 2013
> > > @@ -98,7 +98,7 @@ public class CSVFormat implements Serial
> > > * @param nullToString TODO
> > > * @param header
> > > * the header
> > > - * @param recordSeparator
> > > + * @param lineSeparator
> > > * the line separator to use for output
> > >
> >
> > Is it really a line separator?
> > Or is is a record separator?
> >
> > It seems to me more like a record separator; often the chosen record
> > separator is a new-line (or CRLF).
> >
> > The private field in which the value is stored is called
> "recordSeparator"
> > but the API uses lineSeparator.
> >
> > I think the name "recordSeparator" is more appropriate.
> >
> > * @throws IllegalArgumentException if the delimiter is a line
> > > break character
> > > */
> > >
> > >
> > >
> >
>
>
>
> --
> E-Mail: garydgregory@gmail.com | ggregory@apache.org
> Java Persistence with Hibernate, Second Edition<
> http://www.manning.com/bauer3/>
> JUnit in Action, Second Edition <http://www.manning.com/tahchiev/>
> Spring Batch in Action <http://www.manning.com/templier/>
> Blog: http://garygregory.wordpress.com
> Home: http://garygregory.com/
> Tweet! http://twitter.com/GaryGregory
>
--
http://people.apache.org/~britter/
http://www.systemoutprintln.de/
http://twitter.com/BenediktRitter
http://github.com/britter
Re: svn commit: r1467666 - /commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.java
Posted by Gary Gregory <ga...@gmail.com>.
I think Sebb is correct.
Record separators are usually some kind of line separators (CR/LF).
In addition, fields can contain /escaped/ line separators IIRC.
Gary
On Tue, Apr 16, 2013 at 11:56 AM, sebb <se...@gmail.com> wrote:
> On 13 April 2013 18:55, <br...@apache.org> wrote:
>
> > Author: britter
> > Date: Sat Apr 13 17:55:16 2013
> > New Revision: 1467666
> >
> > URL: http://svn.apache.org/r1467666
> > Log:
> > Change JavaDoc to match actual parameter name
> >
> > Modified:
> >
> >
> commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/CSVFormat.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=1467666&r1=1467665&r2=1467666&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
> > Sat Apr 13 17:55:16 2013
> > @@ -98,7 +98,7 @@ public class CSVFormat implements Serial
> > * @param nullToString TODO
> > * @param header
> > * the header
> > - * @param recordSeparator
> > + * @param lineSeparator
> > * the line separator to use for output
> >
>
> Is it really a line separator?
> Or is is a record separator?
>
> It seems to me more like a record separator; often the chosen record
> separator is a new-line (or CRLF).
>
> The private field in which the value is stored is called "recordSeparator"
> but the API uses lineSeparator.
>
> I think the name "recordSeparator" is more appropriate.
>
> * @throws IllegalArgumentException if the delimiter is a line
> > break character
> > */
> >
> >
> >
>
--
E-Mail: garydgregory@gmail.com | ggregory@apache.org
Java Persistence with Hibernate, Second Edition<http://www.manning.com/bauer3/>
JUnit in Action, Second Edition <http://www.manning.com/tahchiev/>
Spring Batch in Action <http://www.manning.com/templier/>
Blog: http://garygregory.wordpress.com
Home: http://garygregory.com/
Tweet! http://twitter.com/GaryGregory