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

Bug 61082: Adjust JavaDoc for getFirst/LastRow/Cell to explain that there might be empty rows/cells included in the counts 

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1809988 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Dominik Stadler 2017-09-28 13:12:32 +00:00
parent ec2c04d452
commit c2b434988e
2 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/java/org/apache/poi/ss/usermodel/Row.java
View File

@ -118,6 +118,11 @@ public interface Row extends Iterable<Cell> {
/**
* Get the number of the first cell contained in this row.
*
* Note: cells which had content before and were set to empty later might
* still be counted as cells by Excel and Apache POI, so the result of this
* method will include such rows and thus the returned value might be lower
* than expected!
*
* @return short representing the first logical cell in the row,
* or -1 if the row does not contain any cells.
*/
@ -139,6 +144,11 @@ public interface Row extends Iterable<Cell> {
* }
* </pre>
*
* Note: cells which had content before and were set to empty later might
* still be counted as cells by Excel and Apache POI, so the result of this
* method will include such rows and thus the returned value might be higher
* than expected!
*
* @return short representing the last logical cell in the row <b>PLUS ONE</b>,
* or -1 if the row does not contain any cells.
*/

12
src/java/org/apache/poi/ss/usermodel/Sheet.java
View File

@ -91,7 +91,12 @@ public interface Sheet extends Iterable<Row> {
int getPhysicalNumberOfRows();
/**
* Gets the first row on the sheet
* Gets the first row on the sheet.
*
* Note: rows which had content before and were set to empty later might
* still be counted as rows by Excel and Apache POI, so the result of this
* method will include such rows and thus the returned value might be lower
* than expected!
*
* @return the number of the first logical row on the sheet (0-based)
*/
@ -100,6 +105,11 @@ public interface Sheet extends Iterable<Row> {
/**
* Gets the last row on the sheet
*
* Note: rows which had content before and were set to empty later might
* still be counted as rows by Excel and Apache POI, so the result of this
* method will include such rows and thus the returned value might be higher
* than expected!
*
* @return last row contained n this sheet (0-based)
*/
int getLastRowNum();