From: Nick Burch Date: Mon, 15 Sep 2008 20:58:30 +0000 (+0000) Subject: Make MissingCellPolicy javadocs even more explicit about iterators, as people seem... X-Git-Tag: REL_3_2_FINAL~54 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=45c9804d3ab4ca9702a1989cca88d3881a95c5ab;p=poi.git 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/trunk@695621 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 7e4cf715fd..a11410a377 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java @@ -545,6 +545,8 @@ public final class HSSFRow implements Comparable { * 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 e751d9b38a..e71c8e5443 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java @@ -382,7 +382,10 @@ public class HSSFWorkbook extends POIDocument * 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;