/**
* get the cells type (numeric, formula or string)
+ * @since POI 3.15 beta 3
* @deprecated POI 3.15 beta 3
+ * Will be deleted when we make the CellType enum transition. See bug 59791.
*/
@Internal
@Override
* @return one of ({@link CellType#NUMERIC}, {@link CellType#STRING},
* {@link CellType#BOOLEAN}, {@link CellType#ERROR}) depending
* on the cached value of the formula
+ * @since POI 3.15 beta 3
* @deprecated POI 3.15 beta 3
+ * Will be deleted when we make the CellType enum transition. See bug 59791.
*/
@Internal
@Override
public int getCellType() {
return _cell.getCellType();
}
- /** @deprecated POI 3.15 beta 3 */
+ /**
+ * @since POI 3.15 beta 3
+ * @deprecated POI 3.15 beta 3.
+ * Will be deleted when we make the CellType enum transition. See bug 59791.
+ */
@Internal
@Override
public CellType getCellTypeEnum() {
public int getCachedFormulaResultType() {
return _cell.getCachedFormulaResultType();
}
- /** @deprecated POI 3.15 beta 3 */
+ /**
+ * @since POI 3.15 beta 3
+ * @deprecated POI 3.15 beta 3.
+ * Will be deleted when we make the CellType enum transition. See bug 59791.
+ */
@Internal\r
@Override
public CellType getCachedFormulaResultTypeEnum() {\r
}
/**
- * If cell contains formula, it evaluates the formula, and saves the result of the formula. The
- * cell remains as a formula cell. If the cell does not contain formula, this method returns -1
- * and leaves the cell unchanged.
- *
- * Note that the type of the <em>formula result</em> is returned, so you know what kind of
- * cached formula result is also stored with the formula.
- * <pre>
- * int evaluatedCellType = evaluator.evaluateFormulaCell(cell);
- * </pre>
- * Be aware that your cell will hold both the formula, and the result. If you want the cell
- * replaced with the result of the formula, use {@link #evaluateInCell(org.apache.poi.ss.usermodel.Cell)}
- * @param cell The cell to evaluate
- * @return -1 for non-formula cells, or the type of the <em>formula result</em>
- * @deprecated POI 3.15 beta 3
- */
- @Internal
- @Override
- public CellType evaluateFormulaCellEnum(Cell cell) {
- if (cell == null || cell.getCellTypeEnum() != CellType.FORMULA) {
- return CellType._UNINITIALIZED;
- }
- CellValue cv = evaluateFormulaCellValue(cell);
- // cell remains a formula cell, but the cached value is changed
- setCellValue(cell, cv);
- return cv.getCellType();
- }
+ * If cell contains formula, it evaluates the formula, and saves the result of the formula. The
+ * cell remains as a formula cell. If the cell does not contain formula, this method returns -1
+ * and leaves the cell unchanged.
+ *
+ * Note that the type of the <em>formula result</em> is returned, so you know what kind of
+ * cached formula result is also stored with the formula.
+ * <pre>
+ * int evaluatedCellType = evaluator.evaluateFormulaCell(cell);
+ * </pre>
+ * Be aware that your cell will hold both the formula, and the result. If you want the cell
+ * replaced with the result of the formula, use {@link #evaluateInCell(org.apache.poi.ss.usermodel.Cell)}
+ * @param cell The cell to evaluate
+ * @return -1 for non-formula cells, or the type of the <em>formula result</em>
+ * @deprecated POI 3.15 beta 3. Will be deleted when we make the CellType enum transition. See bug 59791.
+ */
+ @Internal
+ @Override
+ public CellType evaluateFormulaCellEnum(Cell cell) {
+ if (cell == null || cell.getCellTypeEnum() != CellType.FORMULA) {
+ return CellType._UNINITIALIZED;
+ }
+ CellValue cv = evaluateFormulaCellValue(cell);
+ // cell remains a formula cell, but the cached value is changed
+ setCellValue(cell, cv);
+ return cv.getCellType();
+ }
/**
* If cell contains formula, it evaluates the formula, and
* value computed for you, use {@link #evaluateFormulaCellEnum(Cell)}}
*/
@Override
- public HSSFCell evaluateInCell(Cell cell) {
+ public HSSFCell evaluateInCell(Cell cell) {
if (cell == null) {
return null;
}
* @return cell type
*/
int getCellType();
- /** @deprecated POI 3.15 beta 3 */
+ /**
+ * @since POI 3.15 beta 3
+ * @deprecated POI 3.15 beta 3.
+ * Will be deleted when we make the CellType enum transition. See bug 59791.
+ */
CellType getCellTypeEnum();
double getNumericCellValue();
* @return cell type of cached formula result
*/
int getCachedFormulaResultType();
- /** @deprecated POI 3.15 beta 3 */\r
+ /**
+ * @since POI 3.15 beta 3
+ * @deprecated POI 3.15 beta 3.
+ * Will be deleted when we make the CellType enum transition. See bug 59791.
+ */\r
CellType getCachedFormulaResultTypeEnum();\r
}\r
public int getCellType() {
return _cellType.getCode();
}
- /** @deprecated POI 3.15 beta 3 */
+ /**
+ * @since POI 3.15 beta 3
+ * @deprecated POI 3.15 beta 3.
+ * Will be deleted when we make the CellType enum transition. See bug 59791.
+ */
@Internal
@Override
public CellType getCellTypeEnum() {
public int getCachedFormulaResultType() {
return _masterCell.getCachedFormulaResultType();
}
- /** @deprecated POI 3.15 beta 3. */
+ /**
+ * @since POI 3.15 beta 3
+ * @deprecated POI 3.15 beta 3.
+ * Will be deleted when we make the CellType enum transition. See bug 59791.
+ */
@Internal
@Override
public CellType getCachedFormulaResultTypeEnum() {
* Return the cell type.
*
* @return the cell type
+ * @since POI 3.15 beta 3
* @deprecated POI 3.15 beta 3
+ * Will be deleted when we make the CellType enum transition. See bug 59791.
*/
@Internal
CellType getCellTypeEnum();
* @return one of ({@link CellType#NUMERIC}, {@link CellType#STRING},
* {@link CellType#BOOLEAN}, {@link CellType#ERROR}) depending
* on the cached value of the formula
+ * @since POI 3.15 beta 3
* @deprecated POI 3.15 beta 3
+ * Will be deleted when we make the CellType enum transition. See bug 59791.
*/
@Internal
CellType getCachedFormulaResultTypeEnum();
* @see CellType#BOOLEAN
* @see CellType#ERROR
* @deprecated POI 3.15 beta 3. Use {@link #setCellType(CellType)} instead.
+ * Will be deleted when we make the CellType enum transition. See bug 59791.
*/
@Override
public void setCellType(int cellType)
* Return the cell type.
*
* @return the cell type
+ * @since POI 3.15 beta 3
* @deprecated POI 3.15 beta 3
+ * Will be deleted when we make the CellType enum transition. See bug 59791.
*/
@Internal
@Override
* @return one of ({@link CellType#NUMERIC}, {@link CellType#STRING},
* {@link CellType#BOOLEAN}, {@link CellType#ERROR}) depending
* on the cached value of the formula
+ * @since POI 3.15 beta 3
* @deprecated POI 3.15 beta 3.
+ * Will be deleted when we make the CellType enum transition. See bug 59791.
*/
@Internal
@Override
public int getCellType() {
return _cell.getCellType();
}
- /** @deprecated POI 3.15 beta 3 */
+ /**
+ * @since POI 3.15 beta 3
+ * @deprecated POI 3.15 beta 3.
+ * Will be deleted when we make the CellType enum transition. See bug 59791.
+ */
@Internal
@Override
public CellType getCellTypeEnum() {
public int getCachedFormulaResultType() {
return _cell.getCachedFormulaResultType();
}
- /** @deprecated POI 3.15 beta 3 */
+ /**
+ * @since POI 3.15 beta 3
+ * @deprecated POI 3.15 beta 3.
+ * Will be deleted when we make the CellType enum transition. See bug 59791.
+ */
@Internal\r
@Override
public CellType getCachedFormulaResultTypeEnum() {\r
* so you know what kind of value is also stored with
* the formula.
* <pre>
- * int evaluatedCellType = evaluator.evaluateFormulaCell(cell);
+ * CellType evaluatedCellType = evaluator.evaluateFormulaCellEnum(cell);
* </pre>
* Be aware that your cell will hold both the formula,
* and the result. If you want the cell replaced with
* Return the cell type.
*
* @return the cell type
+ * @since POI 3.15 beta 3
* @deprecated POI 3.15 beta 3
+ * Will be deleted when we make the CellType enum transition. See bug 59791.
*/
@Internal
@Override
* @return one of ({@link CellType#NUMERIC}, {@link CellType#STRING},
* {@link CellType#BOOLEAN}, {@link CellType#ERROR}) depending
* on the cached value of the formula
+ * @since POI 3.15 beta 3
* @deprecated POI 3.15 beta 3
+ * Will be deleted when we make the CellType enum transition. See bug 59791.
*/
@Internal
@Override
public int getCellType() {
return _cell.getCellType();
}
- /** @deprecated POI 3.15 beta 3 */
+ /**
+ * @since POI 3.15 beta 3
+ * @deprecated POI 3.15 beta 3.
+ * Will be deleted when we make the CellType enum transition. See bug 59791.
+ */
@Internal
@Override
public CellType getCellTypeEnum() {
public int getCachedFormulaResultType() {
return _cell.getCachedFormulaResultType();
}
- /** @deprecated POI 3.15 beta 3 */
+ /**
+ * @since POI 3.15 beta 3
+ * @deprecated POI 3.15 beta 3.
+ * Will be deleted when we make the CellType enum transition. See bug 59791.
+ */
@Internal\r
@Override
public CellType getCachedFormulaResultTypeEnum() {\r