History of Changes

The change log for POI 3.x and older releases can be found in the history section.

Summary

• Upgrade to ECMA-376 5th edition (transitional) schemas - expect API breaks when using XmlBeans directly
• Change artifact names of poi-/ooxml-schemas to poi-ooxml-lite/full
• Upgrade to XMLSec 2.2.0
• updated dependencies to Bouncycastle 1.67, Commons-Codec 1.15, Commons-Compress 1.20
• XWPF - improvements in table and paragraph
• XSLF - improvements for paragraph
• provide JigSaw modules
• removed dependencies to jaxb
• removed deprecated code
• ooxml-security is part of poi-ooxml-full (known as ooxml-schemas) now and won't be provided separately
• new experimental DeferredSXSSFWorkbook which avoids temp files by lazily generating rows (see DeferredGeneration in poi-examples)

Changes

Type	Bug	Module	Description
		SS_Common	SS method to check if a Named Range is hidden or not
		HSMF	HSMF enhancements - NamedIdChunk, MultiValueChunks, ByteChunkDeferred
		SS_Common	Fix incorrect handling of format which should not produce any digit for zero
		SS_Common	Speed up auto-sizing of columns when the sheet contains merged regions
		OPC	Decrease usage of ThreadLocals in XML Signature API
		SS_Common	Picture.resize(double scale) scales width wrong for small pictures and when dx1 is set
		OPC	upgrading xmlsec causes junit tests to fail
		XSLF	XSLF - Wrong scheme colors used when rendering
		XWPF	Method setText in XWPFTableCell updates the xml and also updates the runs and iruns
		XWPF	XWPFTableCell does not process bodyElements when handle paragraph
		XWPF	XWPFNumbering.addAbstractNum will definitely throw an exception
		OPC	Allow try-with-resources with OPCPackage.revert()
		HSSF	Add traversing and debugging interface to HSSF
		POI_Overall	Sonar fix - "Iterator.next()" methods should throw "NoSuchElementException"
		HWPF	RuntimeException on extracting text from Word 97-2004 Document
		HSSF	CountryRecord not found
		POIFS	Big POIFS stream result in OOM
		POI_Overall	Provide JigSaw modules (breaks backwards compatibility)
		SS_Common	Synchronize code that initialises WorkbookFactory
		SS_Common	Support DateValue function
		SS_Common	Add an option for RangeCopier.copyRange() also clone styles
		XSLF	Retrieve default run properties from paragraph
		POIFS	Ole10Native aka embedded / object packager - handle UTF16 variants
		XWPF	XWPFSDTContent.getText() is empty for nested SDT elements
		SXSSF	Missing quoting of pre-evaluated string values in formula cells causes corrupt files
		HEMF	POI HwmfGraphics cannot read the embedded document title
		HWMF	WMF font typeface charset encoding error
		POI_Overall	Visual signatures for .xlsx/.docx
		POIFS	Fix issue in testXLSXinPPT
		SS_Common	Change TRUNC implementation to use MathX
		SL_Common	Provide PDF rendering with PPTX2PNG
		SS_Common	Converting cell values to boolean should throw IllegalStateException instead of RuntimeException when conversion is not possible
		XSSF	XSSFFont setCharset(FontCharset) should use latest class instead of deprecated one
		XSSF	Improve performance of cell merge
		SXSSF	Improve performance of SXSSF cell evaluation
		SS_Common	Change some methods to return ints instead of shorts (Font and CellStyle)
		OOXML	Upgrade OOXML schema to 3rd edition (transitional) (breaks backwards compatibility)
		OOXML	Change artifact names of poi-/ooxml-schemas
		OOXML	Upgrade OOXML schema to 5th edition (transitional) (breaks backwards compatibility)
		XSLF	Unable to convert pptx to pdf
		POI_Overall	Migrate tests to Junit 5
		POI_Overall	Use SLF4J instead of commons-logging - use jcl-over-slf4j
		XSSF	Handle VmlDrawings containing spreadsheet-ml default namespace
		HSLF	WMF parsing failed on closed empty polygon
		POI_Overall	Remove jdk.charset module dependency for spreadsheets generation
		OOXML	Delete unused certificate exceptions
		SS_Common	Fix RuntimeException on array formula referencing blank cell
		SS_Common	Move date parsing logic to DateParser
		XSSF	Add length validation for Excel DataValidations that are list literals
		SXSSF	New EmittingSXSSFWorkbook
		XSSF	Remove limit on number of rules in XSSFSheetConditionalFormatting
		HSSF	Avoid NullPointerException if RangeCopier encounters empty/missing rows

Summary

• Removed a lot of internal uses of StringBuffers
• XDDF - some work on better chart support
• Common SL / EMF - ongoing rendering fixes
• XSLF - OOM fixes when parsing arbitrary shape ids + a new dependency to SparseBitSet 1.2
• updated dependencies to Bouncycastle 1.64

Changes

Type	Bug	Module	Description
		POI_Overall	Swap zaxxer.com:SparseBitSet for java.util.BitSet
		XWPF	When removing AbstractNum match by abstractNumId, not list index
		POI_Overall	Avoid endless loop/out of memory on string-replace with empty search string
		POI_Overall	Make D* functions work with numeric result column
		SXSSF	Write pre-evaluated string-values in formula cells with the correct type
		POI_Overall	Function AND / OR should treat missing parameters as FALSE
		POI_Overall	Make getFirstRowNum() and getFirstCellNum() return -1 consistently with empty data
		POI_Overall	Make IOUtils.setByteArrayMaxOverride() work correctly
		XSLF	Add, insert and remove columns on XSLFTable
		POI_Overall	Fix issue with fractions where the whole number part is too large to store as an int
		XDDF	Produce valid PPTX file with several chart series
		SL_Common XSLF	Fix texture fill - scale stretched images correctly
		XDDF	Add Doughnut chart data series support
		HMEF	HMEFContentsExtractor fails to extract content from winmail.dat
		POI_Overall	Inconsistent mapping of Norwegian locales for date formats
		XSSF	Add set level numbering on XWPFParagraph
		XSSF	Fix Bug in XSSFTable.setCellReferences when table is single cell
		POI_Overall	Replace Cloneable / clone() with copy constructor
		POI_Overall	Replace reflection calls in factories for Java 9+
		POI_Overall	Fix issue with setCellValue(LocalDate) not supporting nulls properly
		SL_Common XSLF	SlideShow rendering fixes
		XWPF	XWPFRun: Whitespace in text not preserved if starting with tab character.
		POI_Overall	unsafe pipe character ("|") in Relationship target attribute is not being encoded into a '%7C'.
		XDDF	Expose invert if negative on bar charts
		HSSF	Support commas, exclamation marks correctly in AreaReference
		XSSF	XSSFWorkbook constructor doesn't close ZipFile if an exception occurs
		HSSF	Regression in OldSheetRecord

Summary

• XSSF: Memory improvements which use much less memory while writing large xlsx files
• XDDF: Improved chart support: more types and some API changes around angles and width units
• updated dependencies to Bouncycastle 1.62, Commons-Codec 1.13, Commons-Collections4 4.4, Commons-Compress 1.19
• XWPF: Additional API methods
• XSSF: Fixes to XSSFSheet.addMergedRegion() and XSSFRow.shiftRows()
• EMF/HSLF: Rendering fixes
• CVE-2019-12415 - XML External Entity (XXE) Processing in Apache POI

Changes

Type	Bug	Module	Description
		POI_Overall	Cache pids to speed up custom properties "add" method
		SS_Common	Add support for the new Java date/time API added in Java 8
		HWPF	Avoid NullPointerException when reading Word Document with tables and a cell with a null descriptor
		HWPF	Read cells of tables correctly in cases where the last cell is not 'fake'
		HWPF	Do not use WeakReference for parents in Ranges to avoid spurious failures in tests
		XSSF	Fix regression with memory usage in XSSFRow.onDocumentWrite and some other temporary memory leaks
		SS_Common	FractionFormat casts whole part of the value into 'int'
		HSLF	Allow multiple charsets for same font typeface
		XSSF	XSSFExportToXml adjust settings on SchemaFactory
		XSLF	NullPointerException from XSLFSimpleShape.getAnchor for empty xfrm tags
		POI_Overall	Add traversing and debugging interface
		XSSF	Fix regression when XSSFRow.shiftRows() is used
		SL_Common HSLF XSLF	Fix texture paint handling
		HSLF	HSLF rendering - adjust values for presetShapeDefinition differs in HSLF/XSLF
		HSLF	Don't fallback to master shape properties, if master shape is not assigned
		POI_Overall	Add a ThreadLocalUtil.clearAllThreadLocals which can be used to clear thread-locals
		XSSF	XSSFSheet.addMergedRegion should adjust count of merged cells
		XSSF	Return value of XSSFSheet.addMergedRegion is off by one
		OPC	Error opening XLSX after saving with a Drawing using POI
		XDDF	Support to create new chart without reading template
		HPSF	MAPIType.isFixedLength: not true in case of length > 8
		XDDF	Support for seven new chart types
		HSMF	improve MAPIMessage.getHtmlBody
		XWPF	Add XWPFPicture getWidth and getDepth methods
		XWPF	Add XWPFRun getStyle method
		XWPF	Add XWPFParagraph setKeepNext method
		XWPF	Add XWPFParagraph createHyperlinkRun method
		SXSSF	Improved support for writing large files
		OOXML	Add setters to POIXMLProperties
		XDDF	Enable safe removal of data series from charts
		XDDF	Provide example of threshold line in bar chart

Summary

• Improved support/fixes for Java 9+ and IBM JVM
• New EMF renderer and support of SVG images in XSLF
• Security, stability and memory/resource handling improvements
• Various bug fixes across function and conditional format rule evaluation
• Upgrade to XMLBeans 3.1.0
• Upgrade to Bouncycastle 1.61
• Upgrade to Curvesapi 1.06
• Upgrade to Commons-Codec 1.12
• Upgrade to Commons-Collections4 4.3
• Upgrade to XMLSec 2.1.2

Changes

Type	Bug	Module	Description
		XSLF	Avoid a possible NullPointerException in XSLFShape.selectPaint()
		SS_Common	Implement 'ignore hidden rows' variations for existing implemented variants
		SS_Common	Conditional Format rule evaluation calculates relative references incorrectly
		SS_Common	Fix NPE in EDATE function when date evaluates to an invalid value
		POIFS	Work around illegal reflective access in Java 9+ when freeing buffers
		OPC	OPCPackage Potentially clobbers files on close()
		SS_Common XSSF HSSF	Make D* functions ignore case in headings
		XSSF	Adding custom properties creates invalid .xlsx file on second write
		SL_Common	Null pointer exception in ExternSheetNameResolver.prependSheetName method
		XSSF	Fix copying styles/conditional formatting
		SS_Common XSSF HSSF	Improved evaluation of array formulas with errors in arguments
		POI_Overall	Make POILogger subclassable
		SS_Common XSSF HSSF	Support array arguments in IF and logical IS*** functions
		SL_Common XSLF HSLF	Provide font embedding for slideshows
		SXSSF	Fix setting values/types during formula evaluation for SXSSF
		OPC	Allow to handle files with invalid content types for pictures
		SL_Common	Fix MathX.floor for negative n
		SL_Common	Sheetnum is not checked in InternalWorkbook.setSheetHidden()
		OPC	Regression extracting text from corrupted docx files
		SL_Common XSLF	Remove rows from a XSLFTable
		SL_Common XSLF HSLF	EMF image support in slideshows
		XSLF	SVG image support in XSLF
		XSSF	Support GEOMEAN function
		OPC	Multiple digital signature in excel file broke first signature
		SL_Common	IBM JDK JIT causes AIOOBE in TexturePaintContext
		POI_Overall	IBM JCE workarounds
		SL_Common	init presetShapeDefinitions.xml fail under IBM jdk
		SL_Common XSLF HSLF	Rendering of FreeformShapes with formula fails
		POI_Overall	Remove support for reading files that have XML entity definitions
		XWPF	add XWPFRun setLang method
		XSSF	Remove unnecessary synchronization on DocumentHelper.newDocumentBuilder and SAXHelper.newXMLReader
		SS_Common	Fix NPE in EDATE function when date evaluates to an invalid value
		SS_Common	Conditional Format rule evaluation calculates relative references incorrectly
		SS_Common	Implement 'ignore hidden rows' variations for existing SUBTOTAL function variants
		SS_Common	Fix issue with CellUtil.setFont adding unnecessary styles
		SS_Common	getForceFormulaRecalculation() returns wrong value
		SS_Common	DataFormatter.formatCellValue() ignores use1904Windowing w/4-part date formats

Summary

• Fixes pom.xml entries for commons-maths3 (missing), curvesapi and commons-codec
• Improvements for XDDF charts and text manipulation
• Upgrade to XMLBeans 3.0.2

Changes

Type	Bug	Module	Description
		POI_Overall	Move loop invariants outside of loop for faster execution
		POI_Overall	poi-ooxml pom.xml should include dependency on poi-scratchpad
		POI_Overall	Missing Maven dependency to commons-math3
		OPC	WildFly XML parser not properly supported - Property 'http://www.oracle.com/xml/jaxp/properties/entityExpansionLimit' is not recognized
		POI_Overall	Download page must link to https://www.apache.org/dist/poi/KEYS
		XSLF	XSLFBackground setFill() can corrupt the document
		XSSF	poi-ooxml 4.0.0 should have dependency on curvesapi 1.05
		XSSF	XSSFTable constructor automatically assigns invalid (non-unique) column IDs
		OPC	OPCPackage#close() method is incorrectly synchronized
		POI_Overall	Remove XML Event parser code from PackagePropertiesMarshaller
		XSLF	Fix null pointer exception if a picture shape has no blip id
		POI_Overall	Fix Old-Xerces build issues
		XSLF	XSLFTableCell#removeBorder(BorderEdge.right) removes the bottom edge not the right edge.
		POI_Overall	POI Encryption didn't work with 4.0.0 but did work with 3.17
		POI_Overall	FileMagic not correctly identified
		SL_Common	SlideShow rendering - keyframe fractions must be increasing
		POI_Overall	Provide OOXMLLite alternative for Java 12+
		POI_Overall	Handle off-spec, variant REFERENCE_NAME record structure in VBAMacroReader
		POI_Overall	Handle module name mapping in VBAMacroReader
		SS_Common	Support TREND function
		XWPF	Rare NPE while creating XWPFSDTContent
		SS_Common	Support for FREQUENCY function
		POI_Overall	WorkbookFactory.create support for subclass of File, eg from JFileChooser
		XSSF	XLSB number extraction improvements
		SS_Common	Support FREQUENCY function
		POI_Overall	Add common-compress jar to bin zip/tgz
		POI_Overall	Upgrade bouncycastle dependency to 1.60
		XWPF	Relations on XSLFPictureShape were removed unconditionally
		XDDF	Define XDDF user model for text body, its paragraphs and text runs
		XSSF	Import chart on drawing
		XDDF	Support axIds in XDDF
		XSSF	XSSFWorkbook.setSheetName() does not update references in charts
		XWPF	Localisation (Internationalisation in other languages) when applied in charts corrupt the MS Word file

Summary

• Removed support for Java 6 and 7 making Java 8 the minimum version supported
• New OOXML schema (1.4) necessary, because of incompatible XMLBeans loading not anymore through POIXMLTypeLoader

Changes

Type	Bug	Module	Description
		POIFS	Remove OPOIFS* (breaks backwards compatibility)
		XSLF	Importing content does not copy hyperlink address
		XSLF	repeated call to XSLFSheet.removeShape leads to java.lang.IllegalArgumentException: partName
		OOXML	Don't try to parse embedded package relationships
		OOXML	Work on providing an updated version of XMLBeans
		HPSF	Document last printed in the year 27321
		SXSSF XSSF OPC	(S)XSSFWorkbook/POIXMLDocument.write(OutputStream) closes the OutputStream (breaks backwards compatibility)
		OPC	Extract configuration while verifying XML signatures
		OPC	Compiling with Java 10 fails with ClassCastException / use commons-compress (breaks backwards compatibility)
		POI_Overall	Unsplit packages for Jigsaw / Java 9 compatibility (breaks backwards compatibility)
		SL_Common	TestFonts fails on Mac
		XSLF	Two shapes have the same shapeId within the same slide
		XSLF	Zero width shapes aren't rendered
		SL_Common	SlideNames should not be null but have a default as if accessed by VBA
		SL_Common	Fix rendering of AutoShapes
		POI_Overall	Forbid calls to InputStream.available
		HSSF	HSSFWorkbook.setActiveCell() does not actually make the cell selected in Excel
		HSLF	HSLFShape.getShapeName() returns name of shapeType and not the shape name
		SL_Common	Decommission XSLF-/PowerPointExtractor (breaks backwards compatibility)
		SL_Common	Text not extracted from grouped text shapes in HSLF
		OPC	Support XML signature over windows certificate store
		XDDF	Add support for major and minor units on chart axes
		XWPF	Added methods to position table
		POI_Overall	Remove deprecated classes (POI 4.0.0)
		XWPF	Add functions to get, set, remove outer borders for tables
		XDDF	Define XDDF user model for shape properties to be shared between XSLF, XSSF and XWPF
		XSSF	Do not fail with "part already exists" when tables are created/removed (breaks backwards compatibility)
		POI_Overall	Add more information to exception text and verify that it is thrown (breaks backwards compatibility)
		POI_Overall	Add .gitattribute file and set lf for one sample-file (breaks backwards compatibility)
		SL_Common	Embed Excel / Ole objects into powerpoint (breaks backwards compatibility)
		SL_Common	narrow generics definition because of tighter java9 checks
		OPC	Refactor PackagePartName handling and add getUnusedPartIndex method
		POIFS	Move Ole marker generation to Ole10Native
		POI_Overall	Replace ClassID statics with enum
		OPC	Provide schema for AlternateContent - provide new ooxml-schemas-1.4.jar
		HSSF	Change how deleted content is detected to not incorrectly see too much text as deleted, this was introduced with bug 58067
		HSSF	Fix usage of getLastCellNum() when calculating worksheet dimension during saving
		HWPF	Avoid IndexOutOfBounds access when reading pictures
		HSSF	Support third party tool generated files using WorkBook as their POIFS directory name
		HSLF	Regression in ppt parsing: typeface can't be null or empty
		XDDF XSLF XSSF XWPF	Share chart data implementation between XSLFChart, XSSFChart and XWPFChart through XDDF
		HPSF	Infinite loop in SectionIDMap.get() and .put()
		XSSF	Surface XSSF Header/Footer Attributes
		SS_Common	CellRangeAddresses support iterating over their CellAddresses
		SS_Common	CellRangeUtil merge cell ranges broken for certain orders of arguments
		HSSF	Fix various situations that were handled incorrectly in HSSFOptimiser
		XSLF	XSLFSlide does not contain isHidden and setHidden like HSLFSlide does
		XSSF	Performance improvement to XSSFExportToXML
		XSSF	Add a method to pass the actual Color to StylesTable.findFont()
		POIFS	Add support for modules in VBAMacroReader
		XSSF	Add XSSFWorkbook.setCellFormulaValidation() to control if formulas are validated during Cell.setCellFormula()
		SXSSF	Fix calculating/setting formula value
		SS_Common	Support behavior of function CEILING in newer versions of Microsoft Excel
		SS_Common	Correctly handle references that end up outside the workbook when cells with formulas are copied
		XSSF	Add endSheet() to XSSFEventBasedExcelExtractor
		OPC	Exchange order of writing parts into Zip to allow some tools to handle files better
		SS_Common	Support matrix functions
		OPC	Deleting a picture that is used twice on a slide corrupt the slide
		POI_Overall	Back-off to brute-force search for macro content if macro offset is incorrect
		XSSF	Pivot table enhancements
		XSSF	add API for working with RichStringText
		SS_Common	Avoid iterating over chars (use codepoints instead)
		SS_Common	Update OFFSET function to support optional values
		XSSF	Rename getAllEmbedds method to getAllEmbeddedParts (getAllEmbedds is retained but deprecated)
		POI_Overall	Replace org.apache.poi.openxml4j.util.Nullable with java.lang.Optional (breaks backwards compatibility)
		XSSF	Change default DSIG signing algorithm to SHA256
		SS_Common	Support AREAS function
		XWPF	Renames org.apache.poi.xwpf.usermodel.TextSegement to org.apache.poi.xwpf.usermodel.TextSegment (breaks backwards compatibility)
		XWPF	Better support for Footnotes and Endnotes