commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Gary Gregory <garydgreg...@gmail.com>
Subject Re: [csv] ExtendedBufferedReader class name
Date Tue, 06 Aug 2013 17:12:58 GMT
On Tue, Aug 6, 2013 at 1:00 PM, Benedikt Ritter <britter@apache.org> wrote:

> 2013/8/6 Gary Gregory <garydgregory@gmail.com>
>
> > We have:
> >
> > /**
> >  * A special reader decorator which supports more sophisticated access to
> > the underlying reader object.
> >  * <p>
> >  * In particular the reader supports a look-ahead option, which allows
> you
> > to see the next char returned by
> >  * {@link #read()}.
> >  *
> >  * @version $Id: ExtendedBufferedReader.java 1509069 2013-08-01 02:04:27Z
> > ggregory $
> >  */
> > final class ExtendedBufferedReader extends BufferedReader { ... }
> >
> > I could see this class being called LookAheadBufferedReader.
> >
> > To me, ExtendedBufferedReader (or CSVBufferedReader) says "this is a
> class
> > we are dumping whatever we need to get [csv] to work as we best see fit"
> >
> > Thoughts?
> >
>
> Since it is package private I'm not crazy about the name. But I agree that
> it expresses the lack of a better name ;-)
>
> I don't know if LookAheadBufferedReader is a good name either. It Also
> supports to read the last character again. So if we go this road we would
> end up with LookAheadAndReadAgainBufferedReader...
>
> What I also find confusing is that fact that the JavaDoc talks about a
> decorator but this does not reflect in the class name.
>

I adjusted the Javadoc. Better?

Gary


>
> Benedikt
>
>
> >
> > Gary
> >
> > --
> > 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
>



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

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