Package org.apache.pdfbox.examples.util

Class PDFMergerExample

java.lang.Object

org.apache.pdfbox.examples.util.PDFMergerExample

public class PDFMergerExample
extends java.lang.Object

This example demonstrates the use of the new methods PDFMergerUtility.setDestinationDocumentInformation(org.apache.pdfbox.pdmodel.PDDocumentInformation) and PDFMergerUtility.setDestinationMetadata(org.apache.pdfbox.pdmodel.common.PDMetadata) that were added in April 2016. These allow to control the meta data in a merge without having to reopen the result file.

Field Summary

Fields

Modifier and Type	Field	Description
private static org.apache.commons.logging.Log	LOG

Constructor Summary

Constructors

Constructor	Description
PDFMergerExample()

Method Summary

Modifier and Type	Method	Description
private PDDocumentInformation	createPDFDocumentInfo(java.lang.String title, java.lang.String creator, java.lang.String subject)
private PDFMergerUtility	createPDFMergerUtility(java.util.List<RandomAccessRead> sources, java.io.ByteArrayOutputStream mergedPDFOutputStream)
private PDMetadata	createXMPMetadata(COSStream cosStream, java.lang.String title, java.lang.String creator, java.lang.String subject)
java.io.InputStream	merge(java.util.List<RandomAccessRead> sources)	Creates a compound PDF document from a list of input documents.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

private static final org.apache.commons.logging.Log LOG

Constructor Detail

PDFMergerExample

public PDFMergerExample()

Method Detail

merge

public java.io.InputStream merge(java.util.List<RandomAccessRead> sources)
                          throws java.io.IOException

Creates a compound PDF document from a list of input documents.

The merged document is PDF/A-1b compliant, provided the source documents are as well. It contains document properties title, creator and subject, currently hard-coded.

Parameters:

sources - list of source PDF documents as RandomAccessRead.

Returns:

compound PDF document as a readable input stream.

Throws:

java.io.IOException - if anything goes wrong during PDF merge.

createPDFMergerUtility

private PDFMergerUtility createPDFMergerUtility(java.util.List<RandomAccessRead> sources,
                                                java.io.ByteArrayOutputStream mergedPDFOutputStream)

createPDFDocumentInfo

private PDDocumentInformation createPDFDocumentInfo(java.lang.String title,
                                                    java.lang.String creator,
                                                    java.lang.String subject)

createXMPMetadata

private PDMetadata createXMPMetadata(COSStream cosStream,
                                     java.lang.String title,
                                     java.lang.String creator,
                                     java.lang.String subject)
                              throws BadFieldValueException,
                                     javax.xml.transform.TransformerException,
                                     java.io.IOException

Throws:

BadFieldValueException

javax.xml.transform.TransformerException

java.io.IOException