diff options
Diffstat (limited to 'src/java/org/apache/poi/ss/usermodel/Row.java')
| -rw-r--r-- | src/java/org/apache/poi/ss/usermodel/Row.java | 50 |
1 files changed, 33 insertions, 17 deletions
diff --git a/src/java/org/apache/poi/ss/usermodel/Row.java b/src/java/org/apache/poi/ss/usermodel/Row.java index 1aae2f78d7..a2bacb487f 100644 --- a/src/java/org/apache/poi/ss/usermodel/Row.java +++ b/src/java/org/apache/poi/ss/usermodel/Row.java @@ -32,7 +32,7 @@ public interface Row extends Iterable<Cell> { * * @param column - the column number this cell represents * @return Cell a high level representation of the created cell. - * @throws IllegalArgumentException if columnIndex < 0 or greater than the maximum number of supported columns + * @throws IllegalArgumentException if columnIndex < 0 or greater than the maximum number of supported columns * (255 for *.xls, 1048576 for *.xlsx) */ Cell createCell(int column); @@ -48,7 +48,7 @@ public interface Row extends Iterable<Cell> { * @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 + * @throws IllegalArgumentException if columnIndex < 0 or greater than a maximum number of supported columns * (255 for *.xls, 1048576 for *.xlsx) * @see Cell#CELL_TYPE_BLANK * @see Cell#CELL_TYPE_BOOLEAN @@ -70,7 +70,7 @@ public interface Row extends Iterable<Cell> { * Set the row number of this row. * * @param rowNum the row number (0-based) - * @throws IllegalArgumentException if rowNum < 0 + * @throws IllegalArgumentException if rowNum < 0 */ void setRowNum(int rowNum); @@ -95,10 +95,7 @@ public interface Row extends Iterable<Cell> { * Returns the cell at the given (0 based) index, with the specified {@link org.apache.poi.ss.usermodel.Row.MissingCellPolicy} * * @return the cell at the given (0 based) index - * @throws IllegalArgumentException if cellnum < 0 or the specified MissingCellPolicy is invalid - * @see Row#RETURN_NULL_AND_BLANK - * @see Row#RETURN_BLANK_AS_NULL - * @see Row#CREATE_NULL_AS_BLANK + * @throws IllegalArgumentException if cellnum < 0 or the specified MissingCellPolicy is invalid */ Cell getCell(int cellnum, MissingCellPolicy policy); @@ -221,22 +218,41 @@ public interface Row extends Iterable<Cell> { * Used to specify the different possible policies * if for the case of null and blank cells */ - public static enum MissingCellPolicy { - RETURN_NULL_AND_BLANK(), - RETURN_BLANK_AS_NULL(), - CREATE_NULL_AS_BLANK(); + public enum MissingCellPolicy { + RETURN_NULL_AND_BLANK(1), + RETURN_BLANK_AS_NULL(2), + CREATE_NULL_AS_BLANK(3); - private int NEXT_ID = 1; + /** + * @deprecated as of POI 3.15-beta2, scheduled for removal in 3.17 - the id has no function and will be removed + */ + @Deprecated public final int id; - private MissingCellPolicy() { - this.id = NEXT_ID++; + private MissingCellPolicy(int id) { + this.id = id; } } - /** Missing cells are returned as null, Blank cells are returned as normal */ + + /** + * Missing cells are returned as null, Blank cells are returned as normal + * + * @deprecated as of POI 3.15-beta2, scheduled for removal in 3.17 - use the MissingCellPolicy enum + **/ + @Deprecated public static final MissingCellPolicy RETURN_NULL_AND_BLANK = MissingCellPolicy.RETURN_NULL_AND_BLANK; - /** Missing cells and blank cells are returned as null */ + /** + * Missing cells and blank cells are returned as null + * + * @deprecated as of POI 3.15-beta2, scheduled for removal in 3.17 - use the MissingCellPolicy enum + **/ + @Deprecated public static final MissingCellPolicy RETURN_BLANK_AS_NULL = MissingCellPolicy.RETURN_BLANK_AS_NULL; - /** A new, blank cell is created for missing cells. Blank cells are returned as normal */ + /** + * A new, blank cell is created for missing cells. Blank cells are returned as normal + * + * @deprecated as of POI 3.15-beta2, scheduled for removal in 3.17 - use the MissingCellPolicy enum + **/ + @Deprecated public static final MissingCellPolicy CREATE_NULL_AS_BLANK = MissingCellPolicy.CREATE_NULL_AS_BLANK; /** |