[jira] [Updated] (CSV-130) CSVFormat#withHeader doesn't work well with #printComment, add withHeaderComments(String...)

["Gary Gregory (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/CSV-130?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Gary Gregory updated CSV-130:
-----------------------------
    Summary: CSVFormat#withHeader doesn't work well with #printComment, add withHeaderComments(String...)  (was: CSVFormat#withHeader doesn't work well with #printComment)

> CSVFormat#withHeader doesn't work well with #printComment, add withHeaderComments(String...)
> --------------------------------------------------------------------------------------------
>
>                 Key: CSV-130
>                 URL: https://issues.apache.org/jira/browse/CSV-130
>             Project: Commons CSV
>          Issue Type: Improvement
>          Components: Printer
>    Affects Versions: 1.0
>            Reporter: Sergei Lebedev
>            Priority: Minor
>
> For some applications it might be useful to add a top comment to the CSV file being printed. However, this isn't possible with #120 implemented the way it is. Here's an example:
> {code}
> public class Example {
>   public static void main(final String[] args) throws IOException {
>     final CSVPrinter csvPrinter = CSVFormat.TDF
>         .withCommentMarker('#')
>         .withHeader("foo", "bar")
>         .print(System.out);
>     csvPrinter.printComment("generated by yada v1.0");
>     csvPrinter.printComment("foo  some description");
>     csvPrinter.printComment("bar  more here");
>     csvPrinter.printRecord(42, 24);
>     csvPrinter.printRecord(24, 42);
>   }
> }
> // Outputs:
> // foo	bar
> // # generated by yada v1.0
> // # foo  some description
> // # bar  more here
> // 42	24
> // 24	42
> {code}
> Obviously, there's a way to "fix" this: output the header in the first call to `#printRecord`, but it just doesn't feel right. What to do you think?



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)