Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Enums
• Deprecated Fields
• Deprecated Methods

Deprecated Interfaces

Interface and Description
org.apache.poi.ss.usermodel.Chart
org.apache.poi.ss.usermodel.charts.ChartAxis use XDDFChartAxis instead
org.apache.poi.ss.usermodel.charts.ChartAxisFactory
org.apache.poi.ss.usermodel.charts.ChartData use XDDFChartData instead
org.apache.poi.ss.usermodel.charts.ChartDataFactory
org.apache.poi.ss.usermodel.charts.ChartDataSource use XDDFDataSource instead
org.apache.poi.ss.usermodel.charts.ChartLegend use XDDFChartLegend instead
org.apache.poi.ss.usermodel.charts.ChartSeries
org.apache.poi.ss.usermodel.charts.LineChartData use XDDFLineChartData instead
org.apache.poi.ss.usermodel.charts.LineChartSeries use XDDFLineChartData.Series instead
org.apache.poi.ss.usermodel.charts.ManualLayout use XDDFManualLayout instead
org.apache.poi.ss.usermodel.charts.ManuallyPositionable
org.apache.poi.ss.usermodel.charts.ScatterChartData use XDDFScatterChartData instead
org.apache.poi.ss.usermodel.charts.ScatterChartSeries use XDFFScatterChartData.Series instead
org.apache.poi.ss.usermodel.charts.ValueAxis use XDDFValueAxis instead

Deprecated Classes

Class and Description
org.apache.poi.hssf.util.CellReference POI 4.0.0-SNAPSHOT. Use CellReference instead. Actually the replacement CellReference was added earlier, but the deprecation notice was added only in 4.0.0-SNAPSHOT.
org.apache.poi.ss.usermodel.charts.DataSources use XDDFDataSourcesFactory instead
org.apache.poi.hssf.util.HSSFRegionUtil POI 4.0.0
org.apache.poi.hpsf.wellknown.SectionIDMap in 4.0.0, there's no way to create custom PropertyIDMaps, therefore this class is obsolete

Deprecated Enums

Enum and Description
org.apache.poi.ss.usermodel.charts.AxisCrossBetween use XDDF AxisCrossBetween
org.apache.poi.ss.usermodel.charts.AxisCrosses use XDDF AxisCrosses instead
org.apache.poi.ss.usermodel.charts.AxisOrientation use XDDF AxisOrientation
org.apache.poi.ss.usermodel.charts.AxisPosition use XDDF AxisPosition instead
org.apache.poi.ss.usermodel.charts.AxisTickMark use XDDF AxisTickMark 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.charts.LayoutMode
org.apache.poi.ss.usermodel.charts.LayoutTarget use XDDF LayoutTarget instead
org.apache.poi.ss.usermodel.charts.LegendPosition use XDDF LayoutPosition instead
org.apache.poi.ss.usermodel.charts.TitleType

Deprecated Fields

Field and Description
org.apache.poi.hpsf.wellknown.SectionIDMap.DOCUMENT_SUMMARY_INFORMATION_ID use DocumentSummaryInformation.FORMAT_ID
org.apache.poi.hpsf.ClassID.EQUATION30 use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.EXCEL_V3 use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.EXCEL_V3_CHART use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.EXCEL_V3_MACRO use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.EXCEL2003 use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.EXCEL2007 use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.EXCEL2007_MACRO use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.EXCEL2007_XLSB use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.EXCEL2010 use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.EXCEL2010_CHART use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.EXCEL2010_ODS use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.EXCEL95 use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.EXCEL95_CHART use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.EXCEL97 use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.EXCEL97_CHART use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.OLE10_PACKAGE use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.POWERPOINT2007 use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.POWERPOINT2007_MACRO use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.POWERPOINT95 use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.POWERPOINT97 use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.PPT_SHOW use enum ClassIDPredefined
org.apache.poi.hpsf.wellknown.SectionIDMap.SUMMARY_INFORMATION_ID use SummaryInformation.FORMAT_ID
org.apache.poi.hpsf.ClassID.TXT_ONLY use enum ClassIDPredefined
org.apache.poi.hpsf.wellknown.SectionIDMap.UNDEFINED use PropertyIDMap.UNDEFINED
org.apache.poi.hpsf.ClassID.WORD2007 use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.WORD2007_MACRO use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.WORD95 use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.WORD97 use enum ClassIDPredefined
org.apache.poi.hpsf.ClassID.XLS_WORKBOOK use enum ClassIDPredefined

Deprecated Methods

Method and Description
org.apache.poi.hssf.model.DrawingManager2.allocateShapeId(short) in POI 3.17-beta2, use allocateShapeId(EscherDgRecord)
org.apache.poi.hssf.model.DrawingManager2.allocateShapeId(short, EscherDgRecord) in POI 3.17-beta2, use allocateShapeId(EscherDgRecord)
org.apache.poi.ss.formula.SheetNameFormatter.appendFormat(StringBuffer, String) use appendFormat(StringBuilder out, String rawSheetName) instead
org.apache.poi.ss.formula.SheetNameFormatter.appendFormat(StringBuffer, String, String) use appendFormat(StringBuilder out, String workbookName, String rawSheetName) instead
org.apache.poi.ss.usermodel.WorkbookFactory.create(Object) use XSSFWorkbookFactory.create
org.apache.poi.ss.formula.BaseFormulaEvaluator.evaluateFormulaCellEnum(Cell) use evaluateFormulaCell(cell) instead
org.apache.poi.ss.usermodel.FormulaEvaluator.evaluateFormulaCellEnum(Cell) use evaluateFormulaCell(cell)
org.apache.poi.common.usermodel.HyperlinkType.forInt(int) POI 3.15 beta 3
org.apache.poi.ss.usermodel.CellType.forInt(int) POI 3.15 beta 3. Used to transition code from ints to CellTypes.
org.apache.poi.ss.usermodel.CellStyle.getAlignmentEnum() use getAlignment() instead
org.apache.poi.ss.usermodel.CellStyle.getBorderBottomEnum() use getBorderBottom() instead
org.apache.poi.ss.usermodel.BorderFormatting.getBorderBottomEnum() use getBorderBottom instead
org.apache.poi.ss.usermodel.BorderFormatting.getBorderDiagonalEnum() use getBorderDiagonal instead
org.apache.poi.hssf.usermodel.HSSFBorderFormatting.getBorderHorizontalEnum()
org.apache.poi.ss.usermodel.BorderFormatting.getBorderHorizontalEnum() use getBorderHorizontal instead
org.apache.poi.ss.usermodel.CellStyle.getBorderLeftEnum() use getBorderLeft() instead
org.apache.poi.ss.usermodel.BorderFormatting.getBorderLeftEnum() use getBorderLeft instead
org.apache.poi.ss.usermodel.CellStyle.getBorderRightEnum() use getBorderRight() instead
org.apache.poi.ss.usermodel.BorderFormatting.getBorderRightEnum() use getBorderRight instead
org.apache.poi.ss.usermodel.CellStyle.getBorderTopEnum() use getBorderTop() instead
org.apache.poi.ss.usermodel.BorderFormatting.getBorderTopEnum() use getBorderTop instead
org.apache.poi.hssf.usermodel.HSSFBorderFormatting.getBorderVerticalEnum()
org.apache.poi.ss.usermodel.BorderFormatting.getBorderVerticalEnum() use getBorderVertical instead
org.apache.poi.hssf.usermodel.HSSFCell.getCachedFormulaResultTypeEnum() use getCachedFormulaResultType Will be deleted when we make the CellType enum transition. See bug 59791.
org.apache.poi.ss.formula.EvaluationCell.getCachedFormulaResultTypeEnum() POI 3.15 beta 3. Will be deleted when we make the CellType enum transition. See bug 59791.
org.apache.poi.ss.usermodel.Cell.getCachedFormulaResultTypeEnum()
org.apache.poi.hssf.usermodel.HSSFCell.getCellTypeEnum()
org.apache.poi.ss.formula.EvaluationCell.getCellTypeEnum() POI 3.15 beta 3.
org.apache.poi.ss.usermodel.Cell.getCellTypeEnum()
org.apache.poi.ss.usermodel.CellValue.getCellTypeEnum() use getCellType instead
org.apache.poi.common.usermodel.HyperlinkType.getCode() POI 3.15 beta 3
org.apache.poi.ss.usermodel.CellType.getCode() POI 3.15 beta 3
org.apache.poi.ss.usermodel.CellStyle.getFillPatternEnum() use getFillPattern() instead
org.apache.poi.hssf.usermodel.HSSFWorkbook.getFontAt(short)
org.apache.poi.ss.usermodel.Workbook.getFontAt(short) use getFontAt(int)
org.apache.poi.hssf.usermodel.HSSFCellStyle.getFontIndex()
org.apache.poi.ss.usermodel.CellStyle.getFontIndex() use getFontIndexAsInt() instead
org.apache.poi.ss.usermodel.Font.getIndex() use getIndexAsInt() instead
org.apache.poi.ss.usermodel.Workbook.getNameAt(int) 4.0.0. New projects should avoid accessing named ranges by index.
org.apache.poi.ss.usermodel.Workbook.getNameIndex(String) 3.18. New projects should avoid accessing named ranges by index. Use Workbook.getName(String) instead.
org.apache.poi.hssf.usermodel.HSSFWorkbook.getNumberOfFonts()
org.apache.poi.ss.usermodel.Workbook.getNumberOfFonts() use getNumberOfFontsAsInt() instead
org.apache.poi.hpsf.PropertySet.getSingleSection() superfluous convenience method
org.apache.poi.common.usermodel.Hyperlink.getTypeEnum() use getType() instead
org.apache.poi.hssf.usermodel.HSSFHyperlink.getTypeEnum() use getType() instead
org.apache.poi.ss.usermodel.CellStyle.getVerticalAlignmentEnum() use getVerticalAlignment() instead
org.apache.poi.poifs.filesystem.DocumentFactoryHelper.hasOOXMLHeader(InputStream) in 3.17-beta2, use FileMagic.valueOf(InputStream) == FileMagic.OOXML instead
org.apache.poi.hssf.record.RecordInputStream.readAllContinuedRemainder() POI 2.0 Best to write a input stream that wraps this one where there is special sub record that may overlap continue records.
org.apache.poi.ss.usermodel.Workbook.removeName(int) 3.18. New projects should use Workbook.removeName(Name).
org.apache.poi.ss.usermodel.Workbook.removeName(String) 3.18. New projects should use Workbook.removeName(Name).
org.apache.poi.hssf.usermodel.HSSFCell.setCellErrorValue(byte) 3.15 beta 2. Use HSSFCell.setCellErrorValue(FormulaError) instead.
org.apache.poi.hssf.usermodel.HSSFSheet.shiftMerged(int, int, int, boolean) POI 3.15 beta 2. Use RowShifter.shiftMergedRegions(int, int, int).
org.apache.poi.ss.format.CellFormat.ultimateTypeEnum(Cell) use ultimateType instead
org.apache.poi.util.IOUtils.write(POIDocument, OutputStream) since 4.0, use try-with-resources, will be removed in 4.2
org.apache.poi.util.IOUtils.write(Workbook, OutputStream) since 4.0, use try-with-resources, will be removed in 4.2
org.apache.poi.util.IOUtils.writeAndClose(POIDocument) since 4.0, use try-with-resources, will be removed in 4.2
org.apache.poi.util.IOUtils.writeAndClose(POIDocument, File) since 4.0, use try-with-resources, will be removed in 4.2
org.apache.poi.util.IOUtils.writeAndClose(POIDocument, OutputStream) since 4.0, use try-with-resources, will be removed in 4.2
org.apache.poi.util.IOUtils.writeAndClose(Workbook, OutputStream) since 4.0, use try-with-resources, will be removed in 4.2