moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

Improve JavaDocs about iterators and gaps

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@653815 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Nick Burch 2008-05-06 15:37:45 +00:00
parent 6fc050034d
commit 54200838bf
2 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/java/org/apache/poi/hssf/usermodel/HSSFRow.java
View File

@ -479,8 +479,10 @@ public final class HSSFRow implements Comparable {
} }
/** /**
* @return cell iterator of the physically defined cells. Note element 4 may * @return cell iterator of the physically defined cells.
* actually be row cell depending on how many are defined! * Note that the 4th element might well not be cell 4, as the iterator
* will not return un-defined (null) cells.
* Call getCellNum() on the returned cells to know which cell they are.
*/ */
public Iterator cellIterator() public Iterator cellIterator()
{ {

1
src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
View File

@ -699,6 +699,7 @@ public final class HSSFSheet {
/** /**
* @return an iterator of the PHYSICAL rows. Meaning the 3rd element may not * @return an iterator of the PHYSICAL rows. Meaning the 3rd element may not
* be the third row if say for instance the second row is undefined. * be the third row if say for instance the second row is undefined.
* Call getRowNum() on each row if you care which one it is.
*/ */
public Iterator rowIterator() public Iterator rowIterator()
{ {