bug 59791: add @Removal tags to Cell.CELL_TYPE_* constants, deprecated by CellType enum

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1757239 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Javen O'Neal 2016-08-22 18:25:45 +00:00
parent 8da1a2fb32
commit 5f36c460d4
1 changed files with 12 additions and 3 deletions

View File

@ -24,6 +24,7 @@ import org.apache.poi.ss.formula.FormulaParseException;
import org.apache.poi.ss.util.CellAddress; import org.apache.poi.ss.util.CellAddress;
import org.apache.poi.ss.util.CellRangeAddress; import org.apache.poi.ss.util.CellRangeAddress;
import org.apache.poi.util.Internal; import org.apache.poi.util.Internal;
import org.apache.poi.util.Removal;
/** /**
* High level representation of a cell in a row of a spreadsheet. * High level representation of a cell in a row of a spreadsheet.
@ -46,6 +47,7 @@ public interface Cell {
* @see #getCellType() * @see #getCellType()
* @deprecated POI 3.15 beta 3. Use {@link CellType#NUMERIC} instead. * @deprecated POI 3.15 beta 3. Use {@link CellType#NUMERIC} instead.
*/ */
@Removal(version="4.0")
int CELL_TYPE_NUMERIC = 0; //CellType.NUMERIC.getCode(); int CELL_TYPE_NUMERIC = 0; //CellType.NUMERIC.getCode();
/** /**
@ -54,6 +56,7 @@ public interface Cell {
* @see #getCellType() * @see #getCellType()
* @deprecated POI 3.15 beta 3. Use {@link CellType#STRING} instead. * @deprecated POI 3.15 beta 3. Use {@link CellType#STRING} instead.
*/ */
@Removal(version="4.0")
int CELL_TYPE_STRING = 1; //CellType.STRING.getCode(); int CELL_TYPE_STRING = 1; //CellType.STRING.getCode();
/** /**
@ -62,6 +65,7 @@ public interface Cell {
* @see #getCellType() * @see #getCellType()
* @deprecated POI 3.15 beta 3. Use {@link CellType#FORMULA} instead. * @deprecated POI 3.15 beta 3. Use {@link CellType#FORMULA} instead.
*/ */
@Removal(version="4.0")
int CELL_TYPE_FORMULA = 2; //CellType.FORMULA.getCode(); int CELL_TYPE_FORMULA = 2; //CellType.FORMULA.getCode();
/** /**
@ -70,6 +74,7 @@ public interface Cell {
* @see #getCellType() * @see #getCellType()
* @deprecated POI 3.15 beta 3. Use {@link CellType#BLANK} instead. * @deprecated POI 3.15 beta 3. Use {@link CellType#BLANK} instead.
*/ */
@Removal(version="4.0")
int CELL_TYPE_BLANK = 3; //CellType.BLANK.getCode(); int CELL_TYPE_BLANK = 3; //CellType.BLANK.getCode();
/** /**
@ -78,6 +83,7 @@ public interface Cell {
* @see #getCellType() * @see #getCellType()
* @deprecated POI 3.15 beta 3. Use {@link CellType#BOOLEAN} instead. * @deprecated POI 3.15 beta 3. Use {@link CellType#BOOLEAN} instead.
*/ */
@Removal(version="4.0")
int CELL_TYPE_BOOLEAN = 4; //CellType.BOOLEAN.getCode(); int CELL_TYPE_BOOLEAN = 4; //CellType.BOOLEAN.getCode();
/** /**
@ -86,6 +92,7 @@ public interface Cell {
* @see #getCellType() * @see #getCellType()
* @deprecated POI 3.15 beta 3. Use {@link CellType#ERROR} instead. * @deprecated POI 3.15 beta 3. Use {@link CellType#ERROR} instead.
*/ */
@Removal(version="4.0")
int CELL_TYPE_ERROR = 5; //CellType.ERROR.getCode(); int CELL_TYPE_ERROR = 5; //CellType.ERROR.getCode();
/** /**
@ -136,6 +143,7 @@ public interface Cell {
* @see CellType#ERROR * @see CellType#ERROR
* @deprecated POI 3.15 beta 3. Use {@link #setCellType(CellType)} instead. * @deprecated POI 3.15 beta 3. Use {@link #setCellType(CellType)} instead.
*/ */
@Removal(version="4.0")
void setCellType(int cellType); void setCellType(int cellType);
/** /**
* Set the cells type (numeric, formula or string). * Set the cells type (numeric, formula or string).
@ -155,7 +163,7 @@ public interface Cell {
/** /**
* Return the cell type. * Return the cell type.
* *
* Will return {@link CellType} in a future version of POI. * Will return {@link CellType} in version 4.0 of POI.
* For forwards compatibility, do not hard-code cell type literals in your code. * For forwards compatibility, do not hard-code cell type literals in your code.
* *
* @return the cell type * @return the cell type
@ -168,9 +176,10 @@ public interface Cell {
* @return the cell type * @return the cell type
* @since POI 3.15 beta 3 * @since POI 3.15 beta 3
* @deprecated POI 3.15 beta 3 * @deprecated POI 3.15 beta 3
* Will be deleted when we make the CellType enum transition. See bug 59791. * Will be renamed to <code>getCellType()</code> when we make the CellType enum transition in POI 4.0. See bug 59791.
*/ */
@Internal(since="POI 3.15 beta 3") @Internal(since="POI 3.15 beta 3")
@Removal(version="4.2")
CellType getCellTypeEnum(); CellType getCellTypeEnum();
/** /**
@ -192,7 +201,7 @@ public interface Cell {
* on the cached value of the formula * on the cached value of the formula
* @since POI 3.15 beta 3 * @since POI 3.15 beta 3
* @deprecated POI 3.15 beta 3 * @deprecated POI 3.15 beta 3
* Will be deleted when we make the CellType enum transition. See bug 59791. * Will be renamed to <code>getCachedFormulaResultType()</code> when we make the CellType enum transition in POI 4.0. See bug 59791.
*/ */
@Internal(since="POI 3.15 beta 3") @Internal(since="POI 3.15 beta 3")
CellType getCachedFormulaResultTypeEnum(); CellType getCachedFormulaResultTypeEnum();