Merged revisions 695621 via svnmerge from

https://svn.apache.org/repos/asf/poi/trunk

........
  r695621 | nick | 2008-09-15 21:58:30 +0100 (Mon, 15 Sep 2008) | 1 line

  Make MissingCellPolicy javadocs even more explicit about iterators, as people seem not to quite get it
........

git-svn-id: https://svn.apache.org/repos/asf/poi/branches/ooxml@695625 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java b/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java
index 44922014fd963ccc2d16543b9e294c06196c9b21..26fd999efc0dd7ded21642ba314a217991f3571f 100644 (file)
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java
@@ -531,6 +531,8 @@ public final class HSSFRow implements Comparable, Row {
      * 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.
+     * As this only ever works on physically defined cells, 
+     *  the {@link MissingCellPolicy} has no effect.
      */
     public Iterator cellIterator()
     {

diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
index dd808a3413d10d73062202cd3aa99dd98489ddfb..b0da561faee457a9b4fdf9a955db32178664ad6a 100644 (file)
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
@@ -383,7 +383,10 @@ public class HSSFWorkbook extends POIDocument implements org.apache.poi.ss.userm
      *  getting missing or blank cells from a row.
      * This will then apply to all calls to
      *  {@link HSSFRow.getCell()}. See
-     *  {@link MissingCellPolicy}
+     *  {@link MissingCellPolicy}.
+     * Note that this has no effect on any
+     *  iterators, only on when fetching Cells
+     *  by their column index.
      */
     public void setMissingCellPolicy(MissingCellPolicy missingCellPolicy) {
         this.missingCellPolicy = missingCellPolicy;