[jira] [Updated] (CSV-68) Use the Builder pattern for CSVFormat
[
https://issues.apache.org/jira/browse/CSV-68?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Benedikt Ritter updated CSV-68:
---
Attachment: CSV-68_20121117.patch
Hi again,
I have implemented equals and hashCode on CSVFormat, so that I could get rid of
the assertEqualFormats method.
I did't add brackets in all if branches, to keep the code short. This may cause
checkstyle errors. Please comment how you feel about that.
I also addressed the issue with the header array reference. The header array is
now copied in the CSVFormat constructor. How ever, the reference to the header
array can still escape the CSVFormatBuilder. This may cause issues if
CSVFormatBuilder instances are shared between multiple threads. Do you think
this is an issue that has to be addressed?
TIA for review,
Benedikt
Use the Builder pattern for CSVFormat
-
Key: CSV-68
URL: https://issues.apache.org/jira/browse/CSV-68
Project: Commons CSV
Issue Type: Improvement
Reporter: Sebb
Attachments: CSV-68_2012.patch, CSV-68_20121114.patch,
CSV-68_20121115.patch, CSV-68_20121117.patch, CSV-68.patch, CSVFormat2.java,
CVSFormat2Main.java
Using a builder pattern to create CSVFormat instances would allow the
settings to be validated at creation time and would eliminate the need to
keep creating new CSVFormat instances whilst still allowing the class to be
immutable.
A possible API is as follows:
{code}
CSVFormat DEFAULT = CSVFormat.init(',') // delimiter is required
.withEncapsulator('')
.withLeadingSpacesIgnored(true)
.withTrailingSpacesIgnored(true)
.withEmptyLinesIgnored(true)
.withLineSeparator(\r\n) // optional, as it would be the default
.build();
CSVFormat format = CSVFormat.init(CSVFormat.DEFAULT) // alternatively start
with pre-defined format
.withSurroundingSpacesIgnored(false)
.build();
{code}
Compare this with the current syntax:
{code}
// internal syntax; not easy to determine what all the parameters do
CSVFormat DEFAULT1 = new CSVFormat(',', '', DISABLED, DISABLED, true, true,
false, true, CRLF);
// external syntax
CSVFormat format = CSVFormat.DEFAULT.withSurroundingSpacesIgnored(false);
{code}
As a proof of concept I've written skeleton code which compiles (but needs
completing).
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (CSV-68) Use the Builder pattern for CSVFormat
[
https://issues.apache.org/jira/browse/CSV-68?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Benedikt Ritter updated CSV-68:
---
Attachment: CSV-68_20121115.patch
I have added a method that lets you initialize a CSVFormatBuilder with the
values of a given CSVFormat. I also included two tests methods. There is a
FIXME left in CSVFormatBuilderTest, because CSVFormat does not implement
equals. After equals is implemented Assert.assertEquals(Object, Object) can be
used to validate that the copied CSVFormat is equal to the one passed in.
Now I wonder if it is a good idea to simply pass format.header to the
CSVFormatBuilder in 441. This makes it possible to let a reference to the
header array escape to the calling code. Maybe we have to create copy of the
array? The same applies to all the other non primitive parameters.
Best regards,
Benedikt
Use the Builder pattern for CSVFormat
-
Key: CSV-68
URL: https://issues.apache.org/jira/browse/CSV-68
Project: Commons CSV
Issue Type: Improvement
Reporter: Sebb
Attachments: CSV-68_2012.patch, CSV-68_20121114.patch,
CSV-68_20121115.patch, CSV-68.patch, CSVFormat2.java, CVSFormat2Main.java
Using a builder pattern to create CSVFormat instances would allow the
settings to be validated at creation time and would eliminate the need to
keep creating new CSVFormat instances whilst still allowing the class to be
immutable.
A possible API is as follows:
{code}
CSVFormat DEFAULT = CSVFormat.init(',') // delimiter is required
.withEncapsulator('')
.withLeadingSpacesIgnored(true)
.withTrailingSpacesIgnored(true)
.withEmptyLinesIgnored(true)
.withLineSeparator(\r\n) // optional, as it would be the default
.build();
CSVFormat format = CSVFormat.init(CSVFormat.DEFAULT) // alternatively start
with pre-defined format
.withSurroundingSpacesIgnored(false)
.build();
{code}
Compare this with the current syntax:
{code}
// internal syntax; not easy to determine what all the parameters do
CSVFormat DEFAULT1 = new CSVFormat(',', '', DISABLED, DISABLED, true, true,
false, true, CRLF);
// external syntax
CSVFormat format = CSVFormat.DEFAULT.withSurroundingSpacesIgnored(false);
{code}
As a proof of concept I've written skeleton code which compiles (but needs
completing).
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Updated] (CSV-68) Use the Builder pattern for CSVFormat
[
https://issues.apache.org/jira/browse/CSV-68?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Gary Gregory updated CSV-68:
Summary: Use the Builder pattern for CSVFormat (was: Use Builder pattern
for CSVFormat)
Use the Builder pattern for CSVFormat
-
Key: CSV-68
URL: https://issues.apache.org/jira/browse/CSV-68
Project: Commons CSV
Issue Type: Improvement
Reporter: Sebb
Attachments: CSV-68_2012.patch, CSV-68_20121114.patch,
CSV-68.patch, CSVFormat2.java, CVSFormat2Main.java
Using a builder pattern to create CSVFormat instances would allow the
settings to be validated at creation time and would eliminate the need to
keep creating new CSVFormat instances whilst still allowing the class to be
immutable.
A possible API is as follows:
{code}
CSVFormat DEFAULT = CSVFormat.init(',') // delimiter is required
.withEncapsulator('')
.withLeadingSpacesIgnored(true)
.withTrailingSpacesIgnored(true)
.withEmptyLinesIgnored(true)
.withLineSeparator(\r\n) // optional, as it would be the default
.build();
CSVFormat format = CSVFormat.init(CSVFormat.DEFAULT) // alternatively start
with pre-defined format
.withSurroundingSpacesIgnored(false)
.build();
{code}
Compare this with the current syntax:
{code}
// internal syntax; not easy to determine what all the parameters do
CSVFormat DEFAULT1 = new CSVFormat(',', '', DISABLED, DISABLED, true, true,
false, true, CRLF);
// external syntax
CSVFormat format = CSVFormat.DEFAULT.withSurroundingSpacesIgnored(false);
{code}
As a proof of concept I've written skeleton code which compiles (but needs
completing).
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
