Package org.apache.pdfbox.multipdf
Class PDFMergerUtility
- java.lang.Object
-
- org.apache.pdfbox.multipdf.PDFMergerUtility
-
public class PDFMergerUtility extends java.lang.Object
This class will take a list of pdf documents and merge them, saving the result in a new document.- Author:
- Ben Litchfield
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PDFMergerUtility.AcroFormMergeMode
The mode to use when merging AcroForm between documents:PDFMergerUtility.AcroFormMergeMode.JOIN_FORM_FIELDS_MODE
fields with the same fully qualified name will be merged into one with the widget annotations of the merged fields becoming part of the same field.
Although the API is finalized processing of different form field types is still in development. Currently only (nested) text fields do work with intermediate nodes being existent.static class
PDFMergerUtility.DocumentMergeMode
The mode to use when merging documents:PDFMergerUtility.DocumentMergeMode.OPTIMIZE_RESOURCES_MODE
Optimizes resource handling such as closing documents early.
-
Constructor Summary
Constructors Constructor Description PDFMergerUtility()
Instantiate a new PDFMergerUtility.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addSource(java.io.File source)
Add a source file to the list of files to merge.void
addSource(java.io.InputStream source)
Add a source to the list of documents to merge.void
addSource(java.lang.String source)
Add a source file to the list of files to merge.void
addSources(java.util.List<java.io.InputStream> sourcesList)
Add a list of sources to the list of documents to merge.void
appendDocument(PDDocument destination, PDDocument source)
append all pages from source to destination.PDFMergerUtility.AcroFormMergeMode
getAcroFormMergeMode()
Get the merge mode to be used for merging AcroForms between documentsPDFMergerUtility.AcroFormMergeMode
PDDocumentInformation
getDestinationDocumentInformation()
Get the destination document information that is to be set inmergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)
.java.lang.String
getDestinationFileName()
Get the name of the destination file.PDMetadata
getDestinationMetadata()
Set the destination metadata that is to be set inmergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)
.java.io.OutputStream
getDestinationStream()
Get the destination OutputStream.PDFMergerUtility.DocumentMergeMode
getDocumentMergeMode()
Get the merge mode to be used for merging documentsPDFMergerUtility.DocumentMergeMode
boolean
isIgnoreAcroFormErrors()
Indicates if acroform errors are ignored or not.void
mergeDocuments()
Deprecated.void
mergeDocuments(MemoryUsageSetting memUsageSetting)
Merge the list of source documents, saving the result in the destination file.void
setAcroFormMergeMode(PDFMergerUtility.AcroFormMergeMode theAcroFormMergeMode)
Set the merge mode to be used for merging AcroForms between documentsPDFMergerUtility.AcroFormMergeMode
void
setDestinationDocumentInformation(PDDocumentInformation info)
Set the destination document information that is to be set inmergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)
.void
setDestinationFileName(java.lang.String destination)
Set the name of the destination file.void
setDestinationMetadata(PDMetadata meta)
Set the destination metadata that is to be set inmergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)
.void
setDestinationStream(java.io.OutputStream destStream)
Set the destination OutputStream.void
setDocumentMergeMode(PDFMergerUtility.DocumentMergeMode theDocumentMergeMode)
Set the merge mode to be used for merging documentsPDFMergerUtility.DocumentMergeMode
void
setIgnoreAcroFormErrors(boolean ignoreAcroFormErrorsValue)
Set to true to ignore acroform errors.
-
-
-
Method Detail
-
getAcroFormMergeMode
public PDFMergerUtility.AcroFormMergeMode getAcroFormMergeMode()
Get the merge mode to be used for merging AcroForms between documentsPDFMergerUtility.AcroFormMergeMode
-
setAcroFormMergeMode
public void setAcroFormMergeMode(PDFMergerUtility.AcroFormMergeMode theAcroFormMergeMode)
Set the merge mode to be used for merging AcroForms between documentsPDFMergerUtility.AcroFormMergeMode
-
setDocumentMergeMode
public void setDocumentMergeMode(PDFMergerUtility.DocumentMergeMode theDocumentMergeMode)
Set the merge mode to be used for merging documentsPDFMergerUtility.DocumentMergeMode
-
getDocumentMergeMode
public PDFMergerUtility.DocumentMergeMode getDocumentMergeMode()
Get the merge mode to be used for merging documentsPDFMergerUtility.DocumentMergeMode
-
getDestinationFileName
public java.lang.String getDestinationFileName()
Get the name of the destination file.- Returns:
- Returns the destination.
-
setDestinationFileName
public void setDestinationFileName(java.lang.String destination)
Set the name of the destination file.- Parameters:
destination
- The destination to set.
-
getDestinationStream
public java.io.OutputStream getDestinationStream()
Get the destination OutputStream.- Returns:
- Returns the destination OutputStream.
-
setDestinationStream
public void setDestinationStream(java.io.OutputStream destStream)
Set the destination OutputStream.- Parameters:
destStream
- The destination to set.
-
getDestinationDocumentInformation
public PDDocumentInformation getDestinationDocumentInformation()
Get the destination document information that is to be set inmergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)
. The default is null, which means that it is ignored.- Returns:
- The destination document information.
-
setDestinationDocumentInformation
public void setDestinationDocumentInformation(PDDocumentInformation info)
Set the destination document information that is to be set inmergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)
. The default is null, which means that it is ignored.- Parameters:
info
- The destination document information.
-
getDestinationMetadata
public PDMetadata getDestinationMetadata()
Set the destination metadata that is to be set inmergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)
. The default is null, which means that it is ignored.- Returns:
- The destination metadata.
-
setDestinationMetadata
public void setDestinationMetadata(PDMetadata meta)
Set the destination metadata that is to be set inmergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)
. The default is null, which means that it is ignored.- Parameters:
meta
- The destination metadata.
-
addSource
public void addSource(java.lang.String source) throws java.io.FileNotFoundException
Add a source file to the list of files to merge.- Parameters:
source
- Full path and file name of source document.- Throws:
java.io.FileNotFoundException
- If the file doesn't exist
-
addSource
public void addSource(java.io.File source) throws java.io.FileNotFoundException
Add a source file to the list of files to merge.- Parameters:
source
- File representing source document- Throws:
java.io.FileNotFoundException
- If the file doesn't exist
-
addSource
public void addSource(java.io.InputStream source)
Add a source to the list of documents to merge.- Parameters:
source
- InputStream representing source document
-
addSources
public void addSources(java.util.List<java.io.InputStream> sourcesList)
Add a list of sources to the list of documents to merge.- Parameters:
sourcesList
- List of InputStream objects representing source documents
-
mergeDocuments
@Deprecated public void mergeDocuments() throws java.io.IOException
Deprecated.Merge the list of source documents, saving the result in the destination file.- Throws:
java.io.IOException
- If there is an error saving the document.
-
mergeDocuments
public void mergeDocuments(MemoryUsageSetting memUsageSetting) throws java.io.IOException
Merge the list of source documents, saving the result in the destination file. The source list is not reset after merge. If you want to merge one document at a time, then it's better to useappendDocument(org.apache.pdfbox.pdmodel.PDDocument, org.apache.pdfbox.pdmodel.PDDocument)
.- Parameters:
memUsageSetting
- defines how memory is used for buffering PDF streams; in case ofnull
unrestricted main memory is used- Throws:
java.io.IOException
- If there is an error saving the document.
-
appendDocument
public void appendDocument(PDDocument destination, PDDocument source) throws java.io.IOException
append all pages from source to destination.- Parameters:
destination
- the document to receive the pagessource
- the document originating the new pages- Throws:
java.io.IOException
- If there is an error accessing data from either document.
-
isIgnoreAcroFormErrors
public boolean isIgnoreAcroFormErrors()
Indicates if acroform errors are ignored or not.- Returns:
- true if acroform errors are ignored
-
setIgnoreAcroFormErrors
public void setIgnoreAcroFormErrors(boolean ignoreAcroFormErrorsValue)
Set to true to ignore acroform errors.- Parameters:
ignoreAcroFormErrorsValue
- true if acroform errors should be ignored
-
-