Apache
/
commons-csv
mirror of https://github.com/apache/commons-csv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1623987 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Gary D. Gregory 2014-09-10 12:50:47 +00:00
parent e650b9d699
commit 581279310e
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/main/java/org/apache/commons/csv/CSVFormat.java
View File

@ -880,10 +880,12 @@ public final class CSVFormat implements Serializable {
}
/**
* Sets the header comments of the format. The comments will be printed first, before the headers.
* Sets the header comments of the format. The comments will be printed first, before the headers. This setting is
* ignored by the parser.
*
* <pre>
* CSVFormat format = aformat.withHeaderComments("Generated by Apache Commons CSV 1.1.", new Date());</pre>
* CSVFormat format = aformat.withHeaderComments(&quot;Generated by Apache Commons CSV 1.1.&quot;, new Date());
* </pre>
*
* @param header
* the header, {@code null} if disabled, empty if parsed automatically, user specified otherwise.