aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/org/apache/poi/ss
diff options
context:
space:
mode:
Diffstat (limited to 'src/java/org/apache/poi/ss')
-rw-r--r--src/java/org/apache/poi/ss/usermodel/Row.java13
1 files changed, 11 insertions, 2 deletions
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);