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

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

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1479639 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Nick Burch 2013-05-06 16:53:04 +00:00
parent 76fac97865
commit 808c01e365
2 changed files with 15 additions and 4 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

@ -129,8 +129,10 @@ public final class HSSFRow implements Row {
/** /**
* Use this to create new cells within the row and return it. * Use this to create new cells within the row and return it.
* <p> * <p>
* The cell that is returned is a CELL_TYPE_BLANK. The type can be changed * The cell that is returned will be of the requested type.
* either through calling setCellValue or setCellType. * 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 * @param columnIndex - the column number this cell represents
* *

13
src/java/org/apache/poi/ss/usermodel/Row.java
View File

@ -40,13 +40,22 @@ public interface Row extends Iterable<Cell> {
/** /**
* Use this to create new cells within the row and return it. * Use this to create new cells within the row and return it.
* <p> * <p>
* The cell that is returned is a {@link Cell#CELL_TYPE_BLANK}. The type can be changed * The cell that is returned will be of the requested type.
* either through calling setCellValue or setCellType. * 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 column - the column number this cell represents
* @param type - the cell's data type
* @return Cell a high level representation of the created cell. * @return Cell a high level representation of the created cell.
* @throws IllegalArgumentException if columnIndex < 0 or greate than a maximum number of supported columns * @throws IllegalArgumentException if columnIndex < 0 or greate than a maximum number of supported columns
* (255 for *.xls, 1048576 for *.xlsx) * (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); Cell createCell(int column, int type);