Deprecated API

Contents

• Deprecated Classes
• Deprecated Enums
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors
• Deprecated Enum Constants

Deprecated Classes

Class and Description
org.apache.poi.hwpf.model.BytePropertyNode byte positions shall not be saved in memory
org.apache.poi.ss.formula.atp.DateParser in 5.0.0 - use DateParser
org.apache.poi.hssf.usermodel.HSSFDateUtil Use DateUtil instead
org.apache.poi.ooxml.util.SAXHelper use XMLHelper
org.apache.poi.util.StaxHelper use XMLHelper
org.apache.poi.ooxml.util.TransformerHelper use XMLHelper

Deprecated Enums

Enum and Description
org.apache.poi.ss.usermodel.FontCharset enum will be replaced by common version org.apache.poi.common.usermodel.FontCharset

Deprecated Fields

Field and Description
org.apache.poi.hwpf.model.types.FibRgW97AbstractType.field_1_reserved1
org.apache.poi.hwpf.model.types.FibRgW97AbstractType.field_10_reserved10
org.apache.poi.hwpf.model.types.FibBaseAbstractType.field_11_Chs
org.apache.poi.hwpf.model.types.FibRgW97AbstractType.field_11_reserved11
org.apache.poi.hwpf.model.types.FibBaseAbstractType.field_12_chsTables
org.apache.poi.hwpf.model.types.FibRgW97AbstractType.field_12_reserved12
org.apache.poi.hwpf.model.types.FibRgLw97AbstractType.field_12_reserved4
org.apache.poi.hwpf.model.types.FibBaseAbstractType.field_13_fcMin
org.apache.poi.hwpf.model.types.FibRgW97AbstractType.field_13_reserved13
org.apache.poi.hwpf.model.types.FibRgLw97AbstractType.field_13_reserved5
org.apache.poi.hwpf.model.types.FibBaseAbstractType.field_14_fcMac
org.apache.poi.hwpf.model.types.FibRgLw95AbstractType.field_14_reserved5
org.apache.poi.hwpf.model.types.FibRgLw97AbstractType.field_14_reserved6
org.apache.poi.hwpf.model.types.FibRgLw97AbstractType.field_15_reserved7
org.apache.poi.hwpf.model.types.FibRgLw97AbstractType.field_16_reserved8
org.apache.poi.hwpf.model.types.FibRgLw97AbstractType.field_17_reserved9
org.apache.poi.hwpf.model.types.FibRgLw97AbstractType.field_18_reserved10
org.apache.poi.hwpf.model.types.FibRgLw97AbstractType.field_19_reserved11
org.apache.poi.hwpf.model.types.FibRgLw95AbstractType.field_2_reserved1
org.apache.poi.hwpf.model.types.FibRgLw97AbstractType.field_2_reserved1
org.apache.poi.hwpf.model.types.FibRgW97AbstractType.field_2_reserved2
org.apache.poi.hwpf.model.types.FibRgLw97AbstractType.field_20_reserved12
org.apache.poi.hwpf.model.types.FibRgLw97AbstractType.field_21_reserved13
org.apache.poi.hwpf.model.types.FibRgLw97AbstractType.field_22_reserved14
org.apache.poi.hwpf.model.types.FibRgLw95AbstractType.field_3_reserved2
org.apache.poi.hwpf.model.types.FibRgLw97AbstractType.field_3_reserved2
org.apache.poi.hwpf.model.types.FibRgW97AbstractType.field_3_reserved3
org.apache.poi.hwpf.model.types.FibRgLw95AbstractType.field_4_reserved3
org.apache.poi.hwpf.model.types.FibRgW97AbstractType.field_4_reserved4
org.apache.poi.hwpf.model.types.FibRgLw95AbstractType.field_5_reserved4
org.apache.poi.hwpf.model.types.FibRgW97AbstractType.field_5_reserved5
org.apache.poi.hwpf.model.types.FibRgW97AbstractType.field_6_reserved6
org.apache.poi.hwpf.model.types.FibRgLw97AbstractType.field_7_reserved3
org.apache.poi.hwpf.model.types.FibRgW97AbstractType.field_7_reserved7
org.apache.poi.hwpf.model.types.FibRgW97AbstractType.field_8_reserved8
org.apache.poi.hwpf.model.types.FibBaseAbstractType.field_9_envr
org.apache.poi.hwpf.model.types.FibRgW97AbstractType.field_9_reserved9
org.apache.poi.hwpf.model.FSPA.FSPA_SIZE
org.apache.poi.hwpf.model.FieldsTables.PLCFFLDATN
org.apache.poi.hwpf.model.FieldsTables.PLCFFLDEDN
org.apache.poi.hwpf.model.FieldsTables.PLCFFLDFTN
org.apache.poi.hwpf.model.FieldsTables.PLCFFLDHDR
org.apache.poi.hwpf.model.FieldsTables.PLCFFLDHDRTXBX
org.apache.poi.hwpf.model.FieldsTables.PLCFFLDMOM
org.apache.poi.hwpf.model.FieldsTables.PLCFFLDTXBX
org.apache.poi.hwpf.model.FIBFieldHandler.PLCFLST
org.apache.poi.xssf.usermodel.XSSFSheet.TWIPS_PER_POINT POI 5.0.0
org.apache.poi.hwpf.usermodel.Range.TYPE_CHARACTER POI 3.8 beta 5
org.apache.poi.hwpf.usermodel.Range.TYPE_LISTENTRY POI 3.8 beta 5
org.apache.poi.hwpf.usermodel.Range.TYPE_PARAGRAPH POI 3.8 beta 5
org.apache.poi.hwpf.usermodel.Range.TYPE_SECTION POI 3.8 beta 5
org.apache.poi.hwpf.usermodel.Range.TYPE_TABLE POI 3.8 beta 5
org.apache.poi.hwpf.usermodel.Range.TYPE_TEXT POI 3.8 beta 5
org.apache.poi.hwpf.usermodel.Range.TYPE_UNDEFINED POI 3.8 beta 5

Deprecated Methods

Method and Description
org.apache.poi.ooxml.POIXMLDocumentPart._invokeOnDocumentRead(POIXMLDocumentPart)
org.apache.poi.hwpf.model.OldTextPiece.adjustForDelete(int, int)
org.apache.poi.hwpf.model.TextPiece.adjustForDelete(int, int)
org.apache.poi.hwpf.model.TextPiece.characterLength()
org.apache.poi.hssf.record.aggregates.ValueRecordsAggregate.clone() use HSSFSheet.cloneSheet(HSSFWorkbook) instead
org.apache.poi.ss.usermodel.CellType.forInt(int) POI 3.15 beta 3. Used to transition code from ints to CellTypes.
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
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.hwpf.model.StyleSheet.getCharacterStyle(int)
org.apache.poi.hwpf.model.TextPieceTable.getCharIndex(int)
org.apache.poi.hwpf.model.TextPieceTable.getCharIndex(int, int)
org.apache.poi.hwpf.model.StyleDescription.getCHP()
org.apache.poi.ss.usermodel.CellType.getCode() POI 3.15 beta 3
org.apache.poi.sl.extractor.SlideShowExtractor.getCodepoints(String, Boolean, Boolean) use SlideShowExtractor.getCodepointsInSparseBitSet(String, Boolean, Boolean)
org.apache.poi.hwpf.usermodel.Picture.getDxaCropLeft() POI 3.8 beta 4.
org.apache.poi.hwpf.usermodel.Picture.getDxaCropRight() POI 3.8 beta 4.
org.apache.poi.hwpf.usermodel.Picture.getDyaCropBottom() POI 3.8 beta 5.
org.apache.poi.hwpf.usermodel.Picture.getDyaCropTop() POI 3.8 beta 5.
org.apache.poi.hwpf.model.BytePropertyNode.getEndBytes() Though bytes are actually stored in file, it is advised to use char positions for all operations. Including save operations, because only char positions are preserved.
org.apache.poi.hwpf.usermodel.HeaderStories.getEndnoteContNote() 3.8 beta 4
org.apache.poi.hwpf.usermodel.HeaderStories.getEndnoteContSeparator() 3.8 beta 4
org.apache.poi.hwpf.usermodel.HeaderStories.getEndnoteSeparator() 3.8 beta 4
org.apache.poi.hslf.usermodel.HSLFShape.getEscherProperty(AbstractEscherOptRecord, int) use HSLFShape.getEscherProperty(EscherPropertyTypes) instead
org.apache.poi.hslf.usermodel.HSLFShape.getEscherProperty(short, int) use HSLFShape.getEscherProperty(EscherPropertyTypes, int) instead
org.apache.poi.hwpf.usermodel.HeaderStories.getEvenFooter() 3.8 beta 4
org.apache.poi.hwpf.usermodel.HeaderStories.getEvenHeader() 3.8 beta 4
org.apache.poi.hwpf.model.FileInformationBlock.getFcPlcffldAtn()
org.apache.poi.hwpf.model.FileInformationBlock.getFcPlcffldEdn()
org.apache.poi.hwpf.model.FileInformationBlock.getFcPlcffldFtn()
org.apache.poi.hwpf.model.FileInformationBlock.getFcPlcffldHdr()
org.apache.poi.hwpf.model.FileInformationBlock.getFcPlcffldHdrtxbx()
org.apache.poi.hwpf.model.FileInformationBlock.getFcPlcffldMom()
org.apache.poi.hwpf.model.FileInformationBlock.getFcPlcffldTxbx()
org.apache.poi.hwpf.model.FileInformationBlock.getFcPlcfLst()
org.apache.poi.hwpf.model.FileInformationBlock.getFcPlcspaMom()
org.apache.poi.hwpf.model.FieldsTables.getFieldsPLCF(int)
org.apache.poi.hwpf.usermodel.HeaderStories.getFirstFooter() 3.8 beta 4
org.apache.poi.hwpf.usermodel.HeaderStories.getFirstHeader() 3.8 beta 4
org.apache.poi.hssf.usermodel.HSSFCellStyle.getFontIndexAsInt() use HSSFCellStyle.getFontIndex() instead
org.apache.poi.ss.usermodel.CellStyle.getFontIndexAsInt() use CellStyle.getFontIndex() instead
org.apache.poi.xssf.usermodel.XSSFCellStyle.getFontIndexAsInt() use XSSFCellStyle.getFontIndex() instead
org.apache.poi.xwpf.usermodel.XWPFRun.getFontSize() use XWPFRun.getFontSizeAsDouble()
org.apache.poi.xwpf.usermodel.XWPFDefaultRunStyle.getFontSize() use XWPFDefaultRunStyle.getFontSizeAsDouble()
org.apache.poi.hwpf.extractor.WordExtractor.getFooterText() 3.8 beta 4
org.apache.poi.hwpf.usermodel.HeaderStories.getFootnoteContNote() 3.8 beta 4
org.apache.poi.hwpf.usermodel.HeaderStories.getFootnoteContSeparator() 3.8 beta 4
org.apache.poi.hwpf.usermodel.HeaderStories.getFootnoteSeparator() 3.8 beta 4
org.apache.poi.hwpf.model.types.FibBaseAbstractType.getFSpare0() This field should not be used according to specification
org.apache.poi.hwpf.extractor.WordExtractor.getHeaderText() 3.8 beta 4
org.apache.poi.hssf.usermodel.HSSFFont.getIndexAsInt()
org.apache.poi.ss.usermodel.Font.getIndexAsInt() use Font.getIndex() instead
org.apache.poi.xssf.usermodel.XSSFFont.getIndexAsInt()
org.apache.poi.poifs.crypt.dsig.SignatureConfig.getKeyInfoFactory() in POI 5.0.0 - will be handled by SignatureInfo internally
org.apache.poi.hwpf.model.FileInformationBlock.getLcbPlcffldAtn()
org.apache.poi.hwpf.model.FileInformationBlock.getLcbPlcffldEdn()
org.apache.poi.hwpf.model.FileInformationBlock.getLcbPlcffldFtn()
org.apache.poi.hwpf.model.FileInformationBlock.getLcbPlcffldHdr()
org.apache.poi.hwpf.model.FileInformationBlock.getLcbPlcffldHdrtxbx()
org.apache.poi.hwpf.model.FileInformationBlock.getLcbPlcffldMom()
org.apache.poi.hwpf.model.FileInformationBlock.getLcbPlcffldTxbx()
org.apache.poi.hwpf.model.FileInformationBlock.getLcbPlcfLst()
org.apache.poi.hwpf.model.FileInformationBlock.getLcbPlcspaMom()
org.apache.poi.hssf.usermodel.HSSFWorkbook.getNumberOfFontsAsInt()
org.apache.poi.ss.usermodel.Workbook.getNumberOfFontsAsInt()
org.apache.poi.xssf.streaming.SXSSFWorkbook.getNumberOfFontsAsInt()
org.apache.poi.xssf.usermodel.XSSFWorkbook.getNumberOfFontsAsInt()
org.apache.poi.hwpf.usermodel.HeaderStories.getOddFooter() 3.8 beta 4
org.apache.poi.hwpf.usermodel.HeaderStories.getOddHeader() 3.8 beta 4
org.apache.poi.poifs.crypt.dsig.SignatureConfig.getOpcPackage() in POI 5.0.0 - use SignatureInfo.setOpcPackage(OPCPackage) instead
org.apache.poi.hwpf.model.StyleDescription.getPAP()
org.apache.poi.xwpf.usermodel.XWPFRun.getParagraph() use XWPFRun.getParent() instead
org.apache.poi.hwpf.model.PAPX.getParagraphProperties(StyleSheet)
org.apache.poi.hwpf.model.StyleSheet.getParagraphStyle(int)
org.apache.poi.hwpf.extractor.Word6Extractor.getParagraphText()
org.apache.poi.poifs.crypt.dsig.SignatureConfig.getProvider() in POI 5.0.0 - will be handled by SignatureInfo internally
org.apache.poi.hwpf.model.types.LSTFAbstractType.getReserved1() This field should not be used according to specification
org.apache.poi.xddf.usermodel.chart.XDDFChartData.getSeries() since POI 4.1.1
org.apache.poi.poifs.crypt.dsig.SignatureConfig.getSignatureFactory() in POI 5.0.0 - will be handled by SignatureInfo internally
org.apache.poi.hslf.record.DocumentAtom.getSlideSizeType() to be replaced by enum
org.apache.poi.hwpf.model.BytePropertyNode.getStartBytes() Though bytes are actually stored in file, it is advised to use char positions for all operations. Including save operations, because only char positions are preserved.
org.apache.poi.hwpf.model.TextPiece.getStringBuffer()
org.apache.poi.hwpf.model.types.LFOLVLBaseAbstractType.getUnused1() This field should not be used according to specification
org.apache.poi.hwpf.model.types.LFOLVLBaseAbstractType.getUnused2() This field should not be used according to specification
org.apache.poi.poifs.crypt.dsig.SignatureConfig.getUriDereferencer() in POI 5.0.0 - use SignatureInfo.getUriDereferencer() instead
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.poifs.filesystem.DocumentFactoryHelper.hasOOXMLHeader(InputStream) in 3.17-beta2, use FileMagic.valueOf(InputStream) == FileMagic.OOXML instead
org.apache.poi.ddf.DefaultEscherRecordFactory.isContainer(short, short) this method is not used anymore to identify container records
org.apache.poi.hwpf.model.types.FibBaseAbstractType.isFEmptySpecial() This field should not be used according to specification
org.apache.poi.hwpf.model.types.FibBaseAbstractType.isFMac() This field should not be used according to specification
org.apache.poi.hwpf.model.types.FibBaseAbstractType.isReserved1() This field should not be used according to specification
org.apache.poi.hwpf.model.types.FibBaseAbstractType.isReserved2() This field should not be used according to specification
org.apache.poi.xwpf.usermodel.XWPFRun.isStrike()
org.apache.poi.hwpf.model.types.LSTFAbstractType.isUnused1() This field should not be used according to specification
org.apache.poi.hwpf.model.types.LVLFAbstractType.isUnused1() This field should not be used according to specification
org.apache.poi.hwpf.model.types.LSTFAbstractType.isUnused2() This field should not be used according to specification
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.hssf.usermodel.HSSFCell.setCellErrorValue(byte) 3.15 beta 2. Use HSSFCell.setCellErrorValue(FormulaError) instead.
org.apache.poi.ss.usermodel.Cell.setCellType(CellType) This method is deprecated and will be removed in POI 5.0. Use explicit Cell.setCellFormula(String), setCellValue(...) or Cell.setBlank() to get the desired result.
org.apache.poi.xssf.usermodel.XSSFFont.setCharSet(FontCharset) use XSSFFont.setCharSet(FontCharset) instead
org.apache.poi.hslf.usermodel.HSLFShape.setEscherProperty(AbstractEscherOptRecord, short, int) use HSLFShape.setEscherProperty(AbstractEscherOptRecord, EscherPropertyTypes, int)
org.apache.poi.hslf.usermodel.HSLFShape.setEscherProperty(short, int) use HSLFShape.setEscherProperty(EscherPropertyTypes, int)
org.apache.poi.hwpf.model.FileInformationBlock.setFcPlcffldAtn(int)
org.apache.poi.hwpf.model.FileInformationBlock.setFcPlcffldEdn(int)
org.apache.poi.hwpf.model.FileInformationBlock.setFcPlcffldFtn(int)
org.apache.poi.hwpf.model.FileInformationBlock.setFcPlcffldHdr(int)
org.apache.poi.hwpf.model.FileInformationBlock.setFcPlcffldHdrtxbx(int)
org.apache.poi.hwpf.model.FileInformationBlock.setFcPlcffldMom(int)
org.apache.poi.hwpf.model.FileInformationBlock.setFcPlcffldTxbx(int)
org.apache.poi.hwpf.model.FileInformationBlock.setFcPlcfLst(int)
org.apache.poi.poifs.crypt.dsig.SignatureConfig.setKeyInfoFactory(KeyInfoFactory) in POI 5.0.0 - use SignatureInfo.setKeyInfoFactory(KeyInfoFactory)
org.apache.poi.hwpf.model.FileInformationBlock.setLcbPlcffldAtn(int)
org.apache.poi.hwpf.model.FileInformationBlock.setLcbPlcffldEdn(int)
org.apache.poi.hwpf.model.FileInformationBlock.setLcbPlcffldFtn(int)
org.apache.poi.hwpf.model.FileInformationBlock.setLcbPlcffldHdr(int)
org.apache.poi.hwpf.model.FileInformationBlock.setLcbPlcffldHdrtxbx(int)
org.apache.poi.hwpf.model.FileInformationBlock.setLcbPlcffldMom(int)
org.apache.poi.hwpf.model.FileInformationBlock.setLcbPlcffldTxbx(int)
org.apache.poi.hwpf.model.FileInformationBlock.setLcbPlcfLst(int)
org.apache.poi.poifs.crypt.dsig.SignatureConfig.setOpcPackage(OPCPackage) in POI 5.0.0 - use SignatureInfo.setOpcPackage(OPCPackage) instead
org.apache.poi.poifs.crypt.dsig.SignatureConfig.setProvider(Provider) in POI 5.0.0 - use SignatureInfo.setProvider(Provider)
org.apache.poi.poifs.crypt.dsig.SignatureConfig.setSignatureFactory(XMLSignatureFactory) in POI 5.0.0 - use SignatureInfo.setSignatureFactory(XMLSignatureFactory)
org.apache.poi.xwpf.usermodel.XWPFRun.setStrike(boolean)
org.apache.poi.poifs.crypt.dsig.SignatureConfig.setUriDereferencer(URIDereferencer) in POI 5.0.0 - use SignatureInfo.setUriDereferencer(URIDereferencer) instead
org.apache.poi.xwpf.usermodel.XWPFParagraph.setWordWrap(boolean)
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.hwpf.model.OldTextPiece.substring(int, int)
org.apache.poi.hwpf.model.TextPiece.substring(int, int)
org.apache.poi.hwpf.sprm.CharacterSprmUncompressor.uncompressCHP(CharacterProperties, byte[], int)
org.apache.poi.hwpf.model.FontTable.writeTo(HWPFFileSystem)
org.apache.poi.hwpf.model.ComplexFileTable.writeTo(HWPFFileSystem)
org.apache.poi.hwpf.model.SectionTable.writeTo(HWPFFileSystem, int)
org.apache.poi.hwpf.model.CHPBinTable.writeTo(HWPFFileSystem, int, CharIndexTranslator)

Deprecated Constructors

Constructor and Description
org.apache.poi.hwpf.model.CHPBinTable(byte[], byte[], int, int, int, TextPieceTable) Use CHPBinTable.CHPBinTable(byte[], byte[], int, int, CharIndexTranslator) instead
org.apache.poi.hwpf.model.CHPFormattedDiskPage(byte[], int, int, TextPieceTable) Use CHPFormattedDiskPage.CHPFormattedDiskPage(byte[], int, CharIndexTranslator) instead
org.apache.poi.hwpf.model.DocumentProperties(byte[], int) Use DocumentProperties.DocumentProperties(byte[],int,int) instead
org.apache.poi.ddf.EscherArrayProperty(short, boolean, byte[]) use EscherArrayProperty.EscherArrayProperty(EscherPropertyTypes, boolean, int) and EscherComplexProperty.setComplexData(byte[])
org.apache.poi.hwpf.model.FSPATable(byte[], int, int, List<TextPiece>)
org.apache.poi.hwpf.model.ListLevel(byte[], int)
org.apache.poi.hwpf.model.OldSectionTable(byte[], int, int, int, TextPieceTable) Use OldSectionTable.OldSectionTable(byte[],int,int) instead
org.apache.poi.hwpf.model.PicturesTable(HWPFDocument, byte[], byte[], FSPATable, EscherRecordHolder)
org.apache.poi.hwpf.model.PlexOfField(int, int, byte[])
org.apache.poi.hwpf.extractor.Word6Extractor(DirectoryNode, POIFSFileSystem) Use Word6Extractor.Word6Extractor(DirectoryNode) instead
org.apache.poi.xssf.usermodel.XSSFColor() as of 4.0.0, we want to have the indexed map, and all calling contexts have access to it.
org.apache.poi.xssf.usermodel.XSSFColor(Color) 3.17 beta 1 - pass the workbook styles indexed color map, if any
org.apache.poi.xssf.usermodel.XSSFColor(CTColor) 3.17 beta 1 - pass the workbook styles indexed color map, if any
org.apache.poi.xssf.usermodel.XSSFColor(CTColor, IndexedColorMap) 4.0.0 - use the factory XSSFColor.from(CTColor, IndexedColorMap) method instead to check for null CTColor instances. Make private eventually
org.apache.poi.xwpf.usermodel.XWPFRun(CTR, XWPFParagraph) Use XWPFRun.XWPFRun(CTR, IRunBody)

Deprecated Enum Constants

Enum Constant and Description
org.apache.poi.hwpf.model.SubdocumentType.MACRO