Skip to content

Fix CSVPrinter.getRecordCount() Javadoc: the header record written by the constructor is counted #633

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

Open
lenamonj wants to merge 1 commit into
base: master
Choose a base branch
from
+3 −2
Open

Fix CSVPrinter.getRecordCount() Javadoc: the header record written by the constructor is counted #633

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 3 additions & 2 deletions src/main/java/org/apache/commons/csv/CSVPrinter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,9 +179,10 @@ public Appendable getOut() {
}

/**
* Gets the record count printed, this does not include comments or headers.
* Gets the record count printed. This includes the header record written by the constructor when the format has a header and
* {@link CSVFormat#getSkipHeaderRecord()} is false; it does not include comments or headers written by {@link #printHeaders(ResultSet)}.
*
* @return The record count, this does not include comments or headers.
* @return The record count, including the header record written by the constructor.
* @since 1.13.0
*/
public long getRecordCount() {
Expand Down
Loading