Top Deprecated
Apache POI - Common 5.3.0

Deprecated API


No API in this release is deprecated for removal.

Deprecated Item Summary

SinceDeprecated Item and Description
org.apache.poi.common.usermodel.HyperlinkType(int
The unique number for this type.
code
)

POI 3.15 beta 3

Returns:

the old integer code for a HyperlinkType enum
org.apache.poi.common.usermodel.HyperlinkType.getCode
()

POI 3.15 beta 3

org.apache.poi.ddf.EscherArrayProperty(short
the property number part of the property id
propertyNumber
,
boolean
true, if it references a blip
isBlipId
,
byte[]
the data
complexData
)

use EscherArrayProperty(EscherPropertyTypes, boolean, int) and setComplexData(byte[])

org.apache.poi.ddf.EscherMetafileBlip.RECORD_ID_EMF

use EscherRecordTypes.BLIP_EMF.typeID

org.apache.poi.ddf.EscherMetafileBlip.RECORD_ID_PICT

use EscherRecordTypes.BLIP_PICT.typeID

org.apache.poi.ddf.EscherMetafileBlip.RECORD_ID_WMF

use EscherRecordTypes.BLIP_WMF.typeID

Returns:

The type of the cached value or CellType.NUMERIC.getCode() if the cached value is empty
org.apache.poi.hssf.record.FormulaRecord.getCachedResultType
()

POI 5.0.0, will be removed in 6.0, use getCachedResultTypeEnum until switch to enum is fully done

org.apache.poi.hssf.record.FormulaSpecialCachedValue.getValueType()

POI 5.0.0, will be removed in 5.0, use getValueTypeEnum until switch to enum is fully done

org.apache.poi.hssf.record.OldFormulaRecord.getCachedResultType()

POI 5.0.0, will be removed in 5.0, use getCachedResultTypeEnum until switch to enum is fully done

Returns:

all byte data for the current record
org.apache.poi.hssf.record.RecordInputStream.readAllContinuedRemainder
()

POI 2.0 Best to write an input stream that wraps this one where there is special sub record that may overlap continue records.

org.apache.poi.hssf.usermodel.HSSFCell.setCellErrorValue(byte
the error value to set this cell to. For formulas, we'll set the precalculated value , for errors we'll set its value. For other types, we will change the cell to an error cell and set its value. For error code byte, see FormulaError.
errorCode
)

3.15 beta 2. Use setCellErrorValue(FormulaError) instead.

org.apache.poi.hssf.usermodel.HSSFSheet.createSplitPane(int
Horizontal position of split (in 1/20th of a point).
xSplitPos
,
int
Vertical position of split (in 1/20th of a point).
ySplitPos
,
int
Left column visible in right pane.
leftmostColumn
,
int
Top row visible in bottom pane
topRow
,
int
Active pane. One of: PANE_LOWER_RIGHT, PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT
activePane
)

use createSplitPane(int, int, int, int, PaneType)

Returns:

the size of the margin
org.apache.poi.hssf.usermodel.HSSFSheet.getMargin
(short
which margin to get
margin
)

use getMargin(PageMargin)

org.apache.poi.hssf.usermodel.HSSFSheet.setMargin(short
which margin to set
margin
,
double
the size of the margin
size
)

use setMargin(PageMargin, double) instead

org.apache.poi.hssf.usermodel.HSSFSheet.shiftMerged(int
the start-index of the rows to shift, zero-based
startRow
,
int
the end-index of the rows to shift, zero-based
endRow
,
int
how far to shift, negative to shift up
n
,
boolean
unused, kept for backwards compatibility
isRow
)

POI 3.15 beta 2. Use HSSFRowShifter#shiftMergedRegions(int, int, int).

org.apache.poi.poifs.filesystem.DocumentFactoryHelper.hasOOXMLHeader(InputStream
An InputStream which supports either mark/reset
inp
)

in 3.17-beta2, use FileMagic#valueOf(InputStream) == FileMagic.OOXML instead

Returns:

a bitset with the marked/used codepoints
org.apache.poi.sl.extractor.SlideShowExtractor.getCodepoints
(String
the typeface/font family of the textruns to examine
typeface
,
Boolean
use true for italic TextRuns, false for non-italic ones and null if it doesn't matter
italic
,
Boolean
use true for bold TextRuns, false for non-bold ones and null if it doesn't matter
bold
)

use getCodepointsInSparseBitSet(String, Boolean, Boolean)

Returns:

true if the placeholder should be displayed/rendered
org.apache.poi.sl.usermodel.Slide.getDisplayPlaceholder
(Placeholder
the placeholder type
placeholder
)

in POI 5.2.0 - use getDisplayPlaceholder(SimpleShape)

org.apache.poi.ss.formula.functions.Fixed0ArgFunction

replaced by lambda expressions in 5.1.0

org.apache.poi.ss.formula.functions.Function0Arg

replaced by lambda expressions in 5.0.1

org.apache.poi.ss.usermodel.Cell.setCellType(CellType cellType)

This method is deprecated and will be removed in POI 5.0. Use explicit setCellFormula(String), setCellValue(...) or setBlank() to get the desired result.

org.apache.poi.ss.usermodel.CellType.forInt(int code)

POI 3.15 beta 3. Used to transition code from ints to CellTypes.

Returns:

unique index number of the underlying record this Font represents (probably you don't care unless you're comparing which one is which)
org.apache.poi.ss.usermodel.Font.getIndexAsInt
()

use getIndex() instead

org.apache.poi.ss.usermodel.FontCharset

enum will be replaced by common version org.apache.poi.common.usermodel.FontCharset

org.apache.poi.ss.usermodel.FontCharset.ANSI

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.FontCharset.ARABIC

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.FontCharset.BALTIC

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.FontCharset.CHINESEBIG5

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.FontCharset.DEFAULT

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.FontCharset.EASTEUROPE

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.FontCharset.GB2312

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.FontCharset.GREEK

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.FontCharset.HANGEUL

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.FontCharset.HEBREW

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.FontCharset.JOHAB

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.FontCharset.MAC

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.FontCharset.OEM

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.FontCharset.RUSSIAN

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.FontCharset.SHIFTJIS

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.FontCharset.SYMBOL

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.FontCharset.THAI

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.FontCharset.TURKISH

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.FontCharset.VIETNAMESE

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.FontCharset._table

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.FontCharset.valueOf(String name)

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.FontCharset.valueOf(int value)

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.FontCharset.values()

Deprecated as a consequence of FontCharset being deprecated. See corresponding docs for further information.

org.apache.poi.ss.usermodel.Sheet.createSplitPane(int
Horizontal position of split (in 1/20th of a point).
xSplitPos
,
int
Vertical position of split (in 1/20th of a point).
ySplitPos
,
int
Left column visible in right pane.
leftmostColumn
,
int
Top row visible in bottom pane
topRow
,
int
Active pane. One of: PANE_LOWER_RIGHT, PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT
activePane
)

use createSplitPane(int, int, int, int, PaneType)

Returns:

the size of the margin
org.apache.poi.ss.usermodel.Sheet.getMargin
(short
which margin to get
margin
)

use getMargin(PageMargin)

org.apache.poi.ss.usermodel.Sheet.setMargin(short
which margin to set
margin
,
double
the size of the margin
size
)

use setMargin(PageMargin, double) instead

Returns:

the width in pixels or -1 if cell is empty
org.apache.poi.ss.util.SheetUtil.getCellWidth
(Cell
the cell whose width is to be calculated
cell
,
int
the width of a single character
defaultCharWidth
,
DataFormatter
formatter used to prepare the text to be measured
formatter
,
boolean
whether to use merged cells
useMergedCells
)

since POI 5.2.5, it is better to pass defaultCharWidth as a float

Returns:

the width in pixels or -1 if cell is empty
org.apache.poi.ss.util.SheetUtil.getCellWidth
(Cell
the cell whose width is to be calculated
cell
,
int
the width of a single character
defaultCharWidth
,
DataFormatter
formatter used to prepare the text to be measured
formatter
,
boolean
whether to use merged cells
useMergedCells
,
List<CellRangeAddress>
The list of merged regions as received via cell.getSheet().getMergedRegions()
mergedRegions
)

since POI 5.2.5, it is better to pass defaultCharWidth as a float

Returns:

default character width in pixels
org.apache.poi.ss.util.SheetUtil.getDefaultCharWidth
(final Workbook
the workbook to get the default character width from
wb
)

since POI 5.2.5, it is recommended to switch to getDefaultCharWidthAsFloat(Workbook).