Deprecated API

Contents

• Deprecated Classes
• 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

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.FibRgLw97AbstractType.field_2_reserved1
org.apache.poi.hwpf.model.types.FibRgLw95AbstractType.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.FibRgLw97AbstractType.field_3_reserved2
org.apache.poi.hwpf.model.types.FibRgLw95AbstractType.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.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.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.hwpf.model.TextPiece.adjustForDelete(int, int)
org.apache.poi.hwpf.model.OldTextPiece.adjustForDelete(int, int)
org.apache.poi.hwpf.model.TextPiece.characterLength()
org.apache.poi.hslf.usermodel.HSLFPictureData.create(PictureData.PictureType) Use HSLFSlideShow#addPicture(byte[], PictureType) or one of its overloads to create new HSLFPictureData. This API led to detached HSLFPictureData instances (See Bugzilla 46122) and prevented adding additional functionality.
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.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.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.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.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.usermodel.HeaderStories.getOddFooter() 3.8 beta 4
org.apache.poi.hwpf.usermodel.HeaderStories.getOddHeader() 3.8 beta 4
org.apache.poi.hwpf.model.StyleDescription.getPAP()
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.hwpf.model.types.LSTFAbstractType.getReserved1() This field should not be used according to specification
org.apache.poi.hslf.record.DocumentAtom.getSlideSizeTypeEnum() replaced by DocumentAtom.getSlideSizeType()
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.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.hwpf.model.types.LVLFAbstractType.isUnused1() This field should not be used according to specification
org.apache.poi.hwpf.model.types.LSTFAbstractType.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.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.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.hslf.usermodel.HSLFPictureData.setOffset(int) This function was only intended for POI internal use. If you have a use case you're concerned about, please open an issue in the POI issue tracker.
org.apache.poi.hslf.usermodel.HSLFPictureData.setRawData(byte[]) Set image data using HSLFPictureData.setData(byte[]).
org.apache.poi.hwpf.sprm.SprmUtils.shortArrayToByteArray(short[]) unused by POI internally
org.apache.poi.hwpf.model.TextPiece.substring(int, int)
org.apache.poi.hwpf.model.OldTextPiece.substring(int, int)
org.apache.poi.hwpf.sprm.CharacterSprmUncompressor.uncompressCHP(CharacterProperties, byte[], int)
org.apache.poi.hwpf.model.ComplexFileTable.writeTo(HWPFFileSystem)
org.apache.poi.hwpf.model.FontTable.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.hslf.blip.Bitmap() Use HSLFSlideShow#addPicture(byte[], PictureType) or one of its overloads to create new Bitmap. This API led to detached Bitmap instances (See Bugzilla 46122) and prevented adding additional functionality.
org.apache.poi.hwpf.model.CHPBinTable(byte[], byte[], int, int, int, TextPieceTable) Use CHPBinTable.CHPBinTable(byte[], byte[], int, int, CharIndexTranslator) instead
org.apache.poi.hslf.blip.DIB() Use HSLFSlideShow#addPicture(byte[], PictureType) or one of its overloads to create new DIB. This API led to detached DIB instances (See Bugzilla 46122) and prevented adding additional functionality.
org.apache.poi.hwpf.model.DocumentProperties(byte[], int) Use DocumentProperties.DocumentProperties(byte[],int,int) instead
org.apache.poi.hslf.blip.EMF() Use HSLFSlideShow#addPicture(byte[], PictureType) or one of its overloads to create new EMF. This API led to detached EMF instances (See Bugzilla 46122) and prevented adding additional functionality.
org.apache.poi.hslf.usermodel.HSLFPictureData() Use HSLFSlideShow#addPicture(byte[], PictureType) or one of its overloads to create new HSLFPictureData. This API led to detached HSLFPictureData instances (See Bugzilla 46122) and prevented adding additional functionality.
org.apache.poi.hslf.blip.JPEG() Use HSLFSlideShow#addPicture(byte[], PictureType) or one of its overloads to create new JPEG. This API led to detached JPEG instances (See Bugzilla 46122) and prevented adding additional functionality.
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.hslf.blip.PICT() Use HSLFSlideShow#addPicture(byte[], PictureType) or one of its overloads to create new PICT. This API led to detached PICT instances (See Bugzilla 46122) and prevented adding additional functionality.
org.apache.poi.hwpf.model.PicturesTable(HWPFDocument, byte[], byte[], FSPATable, OfficeArtContent)
org.apache.poi.hwpf.model.PlexOfField(int, int, byte[])
org.apache.poi.hslf.blip.PNG() Use HSLFSlideShow#addPicture(byte[], PictureType) or one of its overloads to create new PNG. This API led to detached PNG instances (See Bugzilla 46122) and prevented adding additional functionality.
org.apache.poi.hslf.blip.WMF() Use HSLFSlideShow#addPicture(byte[], PictureType) or one of its overloads to create new WMF. This API led to detached WMF instances (See Bugzilla 46122) and prevented adding additional functionality.
org.apache.poi.hwpf.extractor.Word6Extractor(DirectoryNode, POIFSFileSystem) Use Word6Extractor.Word6Extractor(DirectoryNode) instead

Deprecated Enum Constants

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