PDFMergerUtility (PDFBox reactor 2.0.8 API)

java.lang.Object
- org.apache.pdfbox.multipdf.PDFMergerUtility

```
public class PDFMergerUtility
extends Object
```
This class will take a list of pdf documents and merge them, saving the result in a new document.

Author:

Ben Litchfield

Constructor Summary

Constructors
Constructor and Description

PDFMergerUtility()
Instantiate a new PDFMergerUtility.

Constructors
Constructor and Description
`PDFMergerUtility()` Instantiate a new PDFMergerUtility.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addSource(File source)` Add a source file to the list of files to merge.
`void`	`addSource(InputStream source)` Add a source to the list of documents to merge.
`void`	`addSource(String source)` Add a source file to the list of files to merge.
`void`	`addSources(List<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.
`PDDocumentInformation`	`getDestinationDocumentInformation()` Get the destination document information that is to be set in `mergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)`.
`String`	`getDestinationFileName()` Get the name of the destination file.
`PDMetadata`	`getDestinationMetadata()` Set the destination metadata that is to be set in `mergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)`.
`OutputStream`	`getDestinationStream()` Get the destination OutputStream.
`boolean`	`isIgnoreAcroFormErrors()` Indicates if acroform errors are ignored or not.
`void`	`mergeDocuments()` Deprecated. use `mergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)`
`void`	`mergeDocuments(MemoryUsageSetting memUsageSetting)` Merge the list of source documents, saving the result in the destination file.
`void`	`setDestinationDocumentInformation(PDDocumentInformation info)` Set the destination document information that is to be set in `mergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)`.
`void`	`setDestinationFileName(String destination)` Set the name of the destination file.
`void`	`setDestinationMetadata(PDMetadata meta)` Set the destination metadata that is to be set in `mergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)`.
`void`	`setDestinationStream(OutputStream destStream)` Set the destination OutputStream.
`void`	`setIgnoreAcroFormErrors(boolean ignoreAcroFormErrorsValue)` Set to true to ignore acroform errors.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PDFMergerUtility
```
public PDFMergerUtility()
```
    Instantiate a new PDFMergerUtility.
- Method Detail
  - getDestinationFileName
```
public String getDestinationFileName()
```
    Get the name of the destination file.
    
    Returns:
    Returns the destination.
  - setDestinationFileName
```
public void setDestinationFileName(String destination)
```
    Set the name of the destination file.
    
    Parameters:
    destination - The destination to set.
  - getDestinationStream
```
public OutputStream getDestinationStream()
```
    Get the destination OutputStream.
    
    Returns:
    Returns the destination OutputStream.
  - setDestinationStream
```
public void setDestinationStream(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 in mergeDocuments(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 in mergeDocuments(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 in mergeDocuments(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 in mergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting). The default is null, which means that it is ignored.
    
    Parameters:
    meta - The destination metadata.
  - addSource
```
public void addSource(String source)
               throws FileNotFoundException
```
    Add a source file to the list of files to merge.
    
    Parameters:
    source - Full path and file name of source document.
    
    Throws:
    
    FileNotFoundException - If the file doesn't exist
  - addSource
```
public void addSource(File source)
               throws FileNotFoundException
```
    Add a source file to the list of files to merge.
    
    Parameters:
    source - File representing source document
    
    Throws:
    
    FileNotFoundException - If the file doesn't exist
  - addSource
```
public void addSource(InputStream source)
```
    Add a source to the list of documents to merge.
    
    Parameters:
    source - InputStream representing source document
  - addSources
```
public void addSources(List<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 IOException
```
    Deprecated. use mergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)
    
    Merge the list of source documents, saving the result in the destination file.
    
    Throws:
    
    IOException - If there is an error saving the document.
  - mergeDocuments
```
public void mergeDocuments(MemoryUsageSetting memUsageSetting)
                    throws IOException
```
    Merge the list of source documents, saving the result in the destination file.
    
    Parameters:
    memUsageSetting - defines how memory is used for buffering PDF streams; in case of null unrestricted main memory is used
    
    Throws:
    
    IOException - If there is an error saving the document.
  - appendDocument
```
public void appendDocument(PDDocument destination,
                  PDDocument source)
                    throws IOException
```
    append all pages from source to destination.
    
    Parameters:
    destination - the document to receive the pages
    source - the document originating the new pages
    
    Throws:
    
    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

Class PDFMergerUtility

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PDFMergerUtility

Method Detail

getDestinationFileName

setDestinationFileName

getDestinationStream

setDestinationStream

getDestinationDocumentInformation

setDestinationDocumentInformation

getDestinationMetadata

setDestinationMetadata

addSource

addSource

addSource

addSources

mergeDocuments

mergeDocuments

appendDocument

isIgnoreAcroFormErrors

setIgnoreAcroFormErrors