[PDFBOX-4544] COSWriter.doWriteHeader(COSDocument) should use the document specified as parameter

• Type: Improvement
• Status: Closed
• Priority: Trivial
• Resolution: Fixed
• Affects Version/s: 2.0.14
• Fix Version/s: 2.0.16, 3.0.0 PDFBox
• Component/s: Writing
• Assignee: Tilman Hausherr
• Reporter: Jonathan
• Created: 13/May/19 12:22
• Updated: 28/Jun/19 04:39
• Resolved: 13/May/19 16:52

Description

COSWriter.doWriteHeader(COSDocument) currently takes a COSDocument as a parameter and its javadoc specifies that this document is used to retrieve the header data from. Still, the implementation actually uses the property fdDocument or pdDocument to get the pdf version number. This is usually equivalent to using the passed document, but there may be cases where this violates the contract specified in the javadoc. Besides, using the passed doc results in slightly less verbose code.