Skip to content

[Javadoc] CSVFormat#setHeaderComments() #344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
garydgregory merged 8 commits into from
Aug 25, 2023
Merged

[Javadoc] CSVFormat#setHeaderComments() #344

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7f277bc
adding java doc optimization for method setHeaderComments()
gbidsilva Aug 24, 2023
72dc36b
changing the comment with template to be more meaningful
gbidsilva Aug 25, 2023
9fd815e
removing mistakenly add block comment
gbidsilva Aug 25, 2023
7b47b98
adding removed empty lines as originnaly present
gbidsilva Aug 25, 2023
f4df552
JAvadoc: Fix some grammar
garydgregory Aug 25, 2023
a8500ed
Fix grammar and errors
garydgregory Aug 25, 2023
a192e18
Remove trailing whitespace
garydgregory Aug 25, 2023
f1294a7
Fix copy pasta
garydgregory Aug 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 55 additions & 8 deletions src/main/java/org/apache/commons/csv/CSVFormat.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -521,28 +521,75 @@ public Builder setHeader(final String... header) {
}

/**
* Sets the header comments set to the given values. The comments will be printed first, before the headers. This setting is ignored by the parser.
*
* Sets the header comments to the given values before the CSV data.
* <p>
* This setting is ignored by the parser.
* </p>
* <p>
* Comments are printed first, before headers.
* </p>
* <p>
* Use {@link Builder#setCommentMarker(char)} or {@link Builder#setCommentMarker(Character)} to set the comment marker written at the start of
* each comment line.
* </p>
* <p>
* If the comment marker is not set, then the header comments are ignored.
* </p>
* <p>
* For example:
* </p>
* <pre>
* builder.setCommentMarker('#')
* .setHeaderComments("Generated by Apache Commons CSV", Instant.ofEpochMilli(0));
* </pre>
* <p>
* writes:
* </p>
* <pre>
* builder.setHeaderComments(&quot;Generated by Apache Commons CSV.&quot;, Instant.now());
* # Generated by Apache Commons CSV.
* # 1970-01-01T00:00:00Z
* </pre>
*
* @param headerComments the headerComments which will be printed by the Printer before the actual CSV data.
* @param headerComments the headerComments which will be printed by the Printer before the CSV data.
* @return This instance.
*/

public Builder setHeaderComments(final Object... headerComments) {
this.headerComments = CSVFormat.clone(toStringArray(headerComments));
return this;
}

/**
* Sets the header comments set to the given values. The comments will be printed first, before the headers. This setting is ignored by the parser.
*
* Sets the header comments to the given values before the CSV data.
* <p>
* This setting is ignored by the parser.
* </p>
* <p>
* Comments are printed first, before headers.
* </p>
* <p>
* Use {@link Builder#setCommentMarker(char)} or {@link Builder#setCommentMarker(Character)} to set the comment marker written at the start of
* each comment line.
* </p>
* <p>
* If the comment marker is not set, then the header comments are ignored.
* </p>
* <p>
* For example:
* </p>
* <pre>
* builder.setCommentMarker('#')
* .setHeaderComments("Generated by Apache Commons CSV", Instant.ofEpochMilli(0).toString());
* </pre>
* <p>
* writes:
* </p>
* <pre>
* Builder.setHeaderComments(&quot;Generated by Apache Commons CSV.&quot;, Instant.now());
* # Generated by Apache Commons CSV.
* # 1970-01-01T00:00:00Z
* </pre>
*
* @param headerComments the headerComments which will be printed by the Printer before the actual CSV data.
* @param headerComments the headerComments which will be printed by the Printer before the CSV data.
* @return This instance.
*/
public Builder setHeaderComments(final String... headerComments) {
Expand Down