From: Nick Burch <nick@apache.org>
Date: Mon, 6 May 2013 16:53:04 +0000 (+0000)
Subject: Fix #54891 - correct javadoc on HSSF + SS (XSSF was correct) for Row.createCell(int... 
X-Git-Tag: 3.10-beta1~48
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=f8ccd5d014575505bcda702859bb107fbb1fc4e7;p=poi.git

Fix #54891 - correct javadoc on HSSF + SS (XSSF was correct) for Row.createCell(int,int)

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1479639 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 0c6a612fcf..402397e542 100644
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java
@@ -129,8 +129,10 @@ public final class HSSFRow implements Row {
     /**
      * Use this to create new cells within the row and return it.
      * <p>
-     * The cell that is returned is a CELL_TYPE_BLANK. The type can be changed
-     * either through calling setCellValue or setCellType.
+     * The cell that is returned will be of the requested type.
+     * The type can be changed either through calling setCellValue 
+     *  or setCellType, but there is a small overhead to doing this,
+     *  so it is best to create of the required type up front.
      *
      * @param columnIndex - the column number this cell represents
      *
diff --git a/src/java/org/apache/poi/ss/usermodel/Row.java b/src/java/org/apache/poi/ss/usermodel/Row.java
index 5d93f6492c..08fb4254df 100644
--- a/src/java/org/apache/poi/ss/usermodel/Row.java
+++ b/src/java/org/apache/poi/ss/usermodel/Row.java
@@ -40,13 +40,22 @@ public interface Row extends Iterable<Cell> {
     /**
      * Use this to create new cells within the row and return it.
      * <p>
-     * The cell that is returned is a {@link Cell#CELL_TYPE_BLANK}. The type can be changed
-     * either through calling setCellValue or setCellType.
+     * The cell that is returned will be of the requested type.
+     * The type can be changed either through calling setCellValue 
+     *  or setCellType, but there is a small overhead to doing this,
+     *  so it is best to create of the required type up front.
      *
      * @param column - the column number this cell represents
+     * @param type - the cell's data type
      * @return Cell a high level representation of the created cell.
      * @throws IllegalArgumentException if columnIndex < 0 or greate than a maximum number of supported columns
      * (255 for *.xls, 1048576 for *.xlsx)
+     * @see Cell#CELL_TYPE_BLANK
+     * @see Cell#CELL_TYPE_BOOLEAN
+     * @see Cell#CELL_TYPE_ERROR
+     * @see Cell#CELL_TYPE_FORMULA
+     * @see Cell#CELL_TYPE_NUMERIC
+     * @see Cell#CELL_TYPE_STRING
      */
     Cell createCell(int column, int type);