+1 to Jörg, that would be my recommendation as well! my 0.02 cents, -Simo
http://people.apache.org/~simonetripodi/ http://simonetripodi.livejournal.com/ http://twitter.com/simonetripodi http://www.99soft.org/ On Tue, Oct 16, 2012 at 3:14 PM, Jörg Schaible <joerg.schai...@scalaris.com> wrote: > Hi Gary, > > Gary Gregory wrote: > >> Hi All: >> >> The format object can configure various aspects of input and output >> formatting. >> >> With my recent addition of the Quote enum for [CSV-53], there are now two >> aspects of quoting to configure: the quote character and the quote policy >> (minimal, all, non-numeric, and none.) FYI, 'none' is currently not >> implemented. >> >> First, I changed (without consulting this list, and please accept my >> apologies for this) the - IMO - cryptic and burdensome terminology of >> "encapsulator" to "quote char", and added "quote policy": >> >> - withQuoteChar(char) >> - withQuotePolicy(Quote) >> >> My intention here is that all Quote APIs start with "withQuote" followed >> by what aspect of quoting is being configured. >> >> Alternatively, we could have: >> >> - withQuote(char) >> - withQuotePolicy(Quote) > > or > > - withQuote(char) > - withQuote(Quote) > > ;-) > >> Which makes the API more consistent with the other char/Character based >> properties: >> >> - withEscape >> - withDelimiter >> - withLineSeparator >> - withCommentStart >> >> none of the above are post-fixed with a "Char" in the name. >> >> As far as reading, for me, the "-r" names are OK because the they are >> nouns (things): "a delimiter", "a line separator." But I do not talk about >> "an escape" because that would be an act (think Alcatraz) as opposed to >> what we have here: a character used to /perform/ escapes. >> >> So I propose to change "escape" to "escape char" because "escaper" is not >> a word. >> >> The name "comment start" is not great also because it implies (to me) that >> there is a "comment end" missing. So plain "comment" or "comment char" >> would be better. > > Who said it has to be a single char? > > .withEOLComment("//") > > > Same applies to the line separator: > > .withLineSeparator("\n\r") > >> Circling back to "quote char" which I have the way it is now for the same >> reason as for the "escape" property. >> >> In summary, using *Char names is better IMO. > > Only if it can be a single char only. If it can either be a single char or a > String, I normally tend to use overloaded methods: > > - withEOLComment(char) > - withEOLComment(CharSequence) > >> Discuss! :) > > Can or worms opened :)) > > - Jörg > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org > For additional commands, e-mail: dev-h...@commons.apache.org > --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org For additional commands, e-mail: dev-h...@commons.apache.org
