Nested and Inner Type Summary

Modifier and Type Class and Description

Modifier and Type	Class and Description
public static enum	PDFMergerUtility.AcroFormMergeMode The mode to use when merging AcroForm between documents: `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. `AcroFormMergeMode#PDFBOX_LEGACY_MODE` fields with the same fully qualified name will be renamed and treated as independent. This mode was used in versions of PDFBox up to 2.x.
public static enum	PDFMergerUtility.DocumentMergeMode The mode to use when merging documents: `DocumentMergeMode#OPTIMIZE_RESOURCES_MODE` Optimizes resource handling such as closing documents early. Not all document elements are merged compared to the PDFBOX_LEGACY_MODE. Currently supported are: Page content and resources

public static enum

PDFMergerUtility.AcroFormMergeMode

The mode to use when merging AcroForm between documents:

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.
AcroFormMergeMode#PDFBOX_LEGACY_MODE fields with the same fully qualified name will be renamed and treated as independent. This mode was used in versions of PDFBox up to 2.x.

public static enum

PDFMergerUtility.DocumentMergeMode

The mode to use when merging documents:

DocumentMergeMode#OPTIMIZE_RESOURCES_MODE Optimizes resource handling such as closing documents early. Not all document elements are merged compared to the PDFBOX_LEGACY_MODE. Currently supported are:
- Page content and resources

Field Summary

Modifier and Type	Field and Description
private PDFMergerUtility.AcroFormMergeMode	acroFormMergeMode
private PDDocumentInformation	destinationDocumentInformation
private String	destinationFileName
private PDMetadata	destinationMetadata
private OutputStream	destinationStream
private PDFMergerUtility.DocumentMergeMode	documentMergeMode
private boolean	ignoreAcroFormErrors
private static final Log	LOG Log instance.
private int	nextFieldNum
private final List<Object>	sources

Constructor Summary

Access	Constructor and Description
public	PDFMergerUtility() Instantiate a new PDFMergerUtility.

Method Summary

Modifier and Type	Method and Description
private void	acroFormJoinFieldsMode(PDFCloneUtility cloner, PDAcroForm destAcroForm, PDAcroForm srcAcroForm)
private void	acroFormLegacyMode(PDFCloneUtility cloner, PDAcroForm destAcroForm, PDAcroForm srcAcroForm)
public void	addSource(String Full path and file name of source document. source) Add a source file to the list of files to merge.
public void	addSource(File File representing source document source) Add a source file to the list of files to merge.
public void	addSource(RandomAccessRead RandomAccessRead representing source document. To pass an InputStream, wrap it into a `RandomAccessReadBuffer`. source) Add a source to the list of documents to merge.
public void	addSources(List<RandomAccessRead> List of RandomAccessRead objects representing source documents sourcesList) Add a list of sources to the list of documents to merge.
public void	appendDocument(PDDocument the document to receive the pages destination, PDDocument the document originating the new pages source) append all pages from source to destination.
public PDFMergerUtility.AcroFormMergeMode	Returns: the current AcroFormMergeMode getAcroFormMergeMode() Get the merge mode to be used for merging AcroForms between documents `AcroFormMergeMode`
public PDDocumentInformation	Returns: The destination document information. getDestinationDocumentInformation() Get the destination document information that is to be set in `mergeDocuments(org.apache.pdfbox.io.RandomAccessStreamCache.StreamCacheCreateFunction)`.
public String	Returns: Returns the destination. getDestinationFileName() Get the name of the destination file.
public PDMetadata	Returns: The destination metadata. getDestinationMetadata() Set the destination metadata that is to be set in `mergeDocuments(org.apache.pdfbox.io.RandomAccessStreamCache.StreamCacheCreateFunction)`.
public OutputStream	Returns: Returns the destination OutputStream. getDestinationStream() Get the destination OutputStream.
public PDFMergerUtility.DocumentMergeMode	Returns: the current DocumentMergeMode getDocumentMergeMode() Get the merge mode to be used for merging documents `DocumentMergeMode`
pack-priv static Map<String, PDStructureElement>	getIDTreeAsMap(PDNameTreeNode<PDStructureElement> idTree)
pack-priv static Map<Integer, COSObjectable>	getNumberTreeAsMap(PDNumberTreeNode tree)
private boolean	hasOnlyDocumentsOrParts(COSArray kLevelOneArray)
private boolean	Returns: true if there is a dynamic XFA form. isDynamicXfa(PDAcroForm the AcroForm acroForm) Test for dynamic XFA content.
public boolean	Returns: true if acroform errors are ignored isIgnoreAcroFormErrors() Indicates if acroform errors are ignored or not.
private void	legacyMergeDocuments(RandomAccessStreamCache.StreamCacheCreateFunction a function to create an instance of a stream cache; in case of `null` unrestricted main memory is used streamCacheCreateFunction, CompressParameters compressParameters) Merge the list of source documents, saving the result in the destination file.
private void	mergeAcroForm(PDFCloneUtility cloner, PDDocumentCatalog destCatalog, PDDocumentCatalog srcCatalog)
public void	mergeDocuments(RandomAccessStreamCache.StreamCacheCreateFunction a function to create an instance of a stream cache; in case of `null` unrestricted main memory is used streamCacheCreateFunction) Merge the list of source documents, saving the result in the destination file.
public void	mergeDocuments(RandomAccessStreamCache.StreamCacheCreateFunction a function to create an instance of a stream cache; in case of `null` unrestricted main memory is used streamCacheCreateFunction, CompressParameters defines if compressed object streams are enabled compressParameters) Merge the list of source documents, saving the result in the destination file.
private void	mergeIDTree(PDFCloneUtility cloner, PDStructureTreeRoot srcStructTree, PDStructureTreeRoot destStructTree)
private void	mergeInto(COSDictionary The source dictionary to get the keys/values from. src, COSDictionary The destination dictionary to merge the keys/values into. dst, Set<COSName> Names of keys that shall be skipped. exclude) This will add all of the dictionaries keys/values to this dictionary, but only if they are not in an exclusion list and if they don't already exist.
private void	mergeKEntries(PDFCloneUtility cloner, PDStructureTreeRoot srcStructTree, PDStructureTreeRoot destStructTree)
private void	mergeLanguage(PDDocumentCatalog destCatalog, PDDocumentCatalog srcCatalog)
private void	mergeMarkInfo(PDDocumentCatalog destCatalog, PDDocumentCatalog srcCatalog)
private void	mergeOutputIntents(PDFCloneUtility cloner, PDDocumentCatalog srcCatalog, PDDocumentCatalog destCatalog)
private void	mergeRoleMap(PDStructureTreeRoot srcStructTree, PDStructureTreeRoot destStructTree)
private void	mergeViewerPreferences(PDDocumentCatalog destCatalog, PDDocumentCatalog srcCatalog)
private void	optimizedMergeDocuments(RandomAccessStreamCache.StreamCacheCreateFunction streamCacheCreateFunction, CompressParameters compressParameters)
public void	setAcroFormMergeMode(PDFMergerUtility.AcroFormMergeMode AcroFormMergeMode to be used theAcroFormMergeMode) Set the merge mode to be used for merging AcroForms between documents `AcroFormMergeMode`
public void	setDestinationDocumentInformation(PDDocumentInformation The destination document information. info) Set the destination document information that is to be set in `mergeDocuments(org.apache.pdfbox.io.RandomAccessStreamCache.StreamCacheCreateFunction)`.
public void	setDestinationFileName(String The destination to set. destination) Set the name of the destination file.
public void	setDestinationMetadata(PDMetadata The destination metadata. meta) Set the destination metadata that is to be set in `mergeDocuments(org.apache.pdfbox.io.RandomAccessStreamCache.StreamCacheCreateFunction)`.
public void	setDestinationStream(OutputStream The destination to set. destStream) Set the destination OutputStream.
public void	setDocumentMergeMode(PDFMergerUtility.DocumentMergeMode DocumentMergeMode to be used theDocumentMergeMode) Set the merge mode to be used for merging documents `DocumentMergeMode`
public void	setIgnoreAcroFormErrors(boolean true if acroform errors should be ignored ignoreAcroFormErrorsValue) Set to true to ignore acroform errors.
private void	updatePageReferences(PDFCloneUtility cloner, Map<Integer, COSObjectable> numberTreeAsMap, Map<COSDictionary, COSDictionary> objMapping) Update the Pg and Obj references to the new (merged) page.
private void	updatePageReferences(PDFCloneUtility cloner, COSDictionary parentTreeEntry, Map<COSDictionary, COSDictionary> mapping between old and new references objMapping) Update the Pg and Obj references to the new (merged) page.
private void	updatePageReferences(PDFCloneUtility cloner, COSArray parentTreeEntry, Map<COSDictionary, COSDictionary> objMapping)
private void	updateParentEntry(COSArray the kids array kArray, COSDictionary the new parent newParent, COSName the new structure type in /S or null so it doesn't get replaced newStructureType) Update the P reference to the new parent dictionary.
private void	updateStructParentEntries(PDPage the new page page, int the offset which should be applied structParentOffset) Update the StructParents and StructParent values in a PDPage.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

acroFormMergeMode	back to summary
private PDFMergerUtility.AcroFormMergeMode acroFormMergeMode

destinationDocumentInformation	back to summary
private PDDocumentInformation destinationDocumentInformation

destinationFileName	back to summary
private String destinationFileName

destinationMetadata	back to summary
private PDMetadata destinationMetadata

destinationStream	back to summary
private OutputStream destinationStream

documentMergeMode	back to summary
private PDFMergerUtility.DocumentMergeMode documentMergeMode

ignoreAcroFormErrors	back to summary
private boolean ignoreAcroFormErrors

LOG	back to summary
private static final Log LOG Log instance.

nextFieldNum	back to summary
private int nextFieldNum

sources	back to summary
private final List<Object> sources

Constructor Detail

PDFMergerUtility	back to summary
public PDFMergerUtility() Instantiate a new PDFMergerUtility.

Method Detail

acroFormJoinFieldsMode	back to summary
private void acroFormJoinFieldsMode(PDFCloneUtility cloner, PDAcroForm destAcroForm, PDAcroForm srcAcroForm) throws IOException

acroFormLegacyMode	back to summary
private void acroFormLegacyMode(PDFCloneUtility cloner, PDAcroForm destAcroForm, PDAcroForm srcAcroForm) throws IOException

addSource	back to summary
public void addSource(String source) throws FileNotFoundException Add a source file to the list of files to merge. Parameters source:String Full path and file name of source document. Exceptions FileNotFoundException: If the file doesn't exist

addSource

back to summary

public void addSource(String source) throws FileNotFoundException

Add a source file to the list of files to merge.

Parameters

source:String: Full path and file name of source document.

Exceptions

FileNotFoundException:: If the file doesn't exist

addSource	back to summary
public void addSource(File source) throws FileNotFoundException Add a source file to the list of files to merge. Parameters source:File File representing source document Exceptions FileNotFoundException: If the file doesn't exist

addSource

back to summary

public void addSource(File source) throws FileNotFoundException

Add a source file to the list of files to merge.

Parameters

source:File: File representing source document

Exceptions

FileNotFoundException:: If the file doesn't exist

addSource back to summary

addSource	back to summary
public void addSource(RandomAccessRead source) Add a source to the list of documents to merge. Parameters source:RandomAccessRead RandomAccessRead representing source document. To pass an InputStream, wrap it into a `RandomAccessReadBuffer`.

public void addSource(RandomAccessRead source)

Add a source to the list of documents to merge.

Parameters

source:RandomAccessRead: RandomAccessRead representing source document. To pass an InputStream, wrap it into a RandomAccessReadBuffer.

addSources	back to summary
public void addSources(List<RandomAccessRead> sourcesList) Add a list of sources to the list of documents to merge. Parameters sourcesList:List<RandomAccessRead> List of RandomAccessRead objects representing source documents

addSources

back to summary

public void addSources(List<RandomAccessRead> sourcesList)

Add a list of sources to the list of documents to merge.

Parameters

sourcesList:List<RandomAccessRead>: List of RandomAccessRead objects representing source documents

appendDocument	back to summary
public void appendDocument(PDDocument destination, PDDocument source) throws IOException append all pages from source to destination. Parameters destination:PDDocument the document to receive the pages source:PDDocument the document originating the new pages Exceptions IOException: If there is an error accessing data from either document.

appendDocument

back to summary

public void appendDocument(PDDocument destination, PDDocument source) throws IOException

append all pages from source to destination.

Parameters

destination:PDDocument: the document to receive the pages
source:PDDocument: the document originating the new pages

Exceptions

IOException:: If there is an error accessing data from either document.

getAcroFormMergeMode back to summary

getAcroFormMergeMode	back to summary
public PDFMergerUtility.AcroFormMergeMode getAcroFormMergeMode() Get the merge mode to be used for merging AcroForms between documents `AcroFormMergeMode` Returns:PDFMergerUtility.AcroFormMergeMode the current AcroFormMergeMode

public PDFMergerUtility.AcroFormMergeMode getAcroFormMergeMode()

Get the merge mode to be used for merging AcroForms between documents AcroFormMergeMode

Returns:PDFMergerUtility.AcroFormMergeMode: the current AcroFormMergeMode

getDestinationDocumentInformation back to summary

getDestinationDocumentInformation	back to summary
public PDDocumentInformation getDestinationDocumentInformation() Get the destination document information that is to be set in `mergeDocuments(org.apache.pdfbox.io.RandomAccessStreamCache.StreamCacheCreateFunction)`. The default is null, which means that it is ignored. Returns:PDDocumentInformation The destination document information.

public PDDocumentInformation getDestinationDocumentInformation()

Get the destination document information that is to be set in mergeDocuments(org.apache.pdfbox.io.RandomAccessStreamCache.StreamCacheCreateFunction). The default is null, which means that it is ignored.

Returns:PDDocumentInformation: The destination document information.

getDestinationFileName	back to summary
public String getDestinationFileName() Get the name of the destination file. Returns:String Returns the destination.

getDestinationFileName

back to summary

public String getDestinationFileName()

Get the name of the destination file.

Returns:String: Returns the destination.

getDestinationMetadata back to summary

public PDMetadata getDestinationMetadata()

Set the destination metadata that is to be set in mergeDocuments(org.apache.pdfbox.io.RandomAccessStreamCache.StreamCacheCreateFunction). The default is null, which means that it is ignored.

Returns:PDMetadata: The destination metadata.

getDestinationStream	back to summary
public OutputStream getDestinationStream() Get the destination OutputStream. Returns:OutputStream Returns the destination OutputStream.

getDestinationStream

back to summary

public OutputStream getDestinationStream()

Get the destination OutputStream.

Returns:OutputStream: Returns the destination OutputStream.

getDocumentMergeMode back to summary

getDocumentMergeMode	back to summary
public PDFMergerUtility.DocumentMergeMode getDocumentMergeMode() Get the merge mode to be used for merging documents `DocumentMergeMode` Returns:PDFMergerUtility.DocumentMergeMode the current DocumentMergeMode

public PDFMergerUtility.DocumentMergeMode getDocumentMergeMode()

Get the merge mode to be used for merging documents DocumentMergeMode

Returns:PDFMergerUtility.DocumentMergeMode: the current DocumentMergeMode

getIDTreeAsMap	back to summary
pack-priv static Map<String, PDStructureElement> getIDTreeAsMap(PDNameTreeNode<PDStructureElement> idTree) throws IOException

getNumberTreeAsMap	back to summary
pack-priv static Map<Integer, COSObjectable> getNumberTreeAsMap(PDNumberTreeNode tree) throws IOException

hasOnlyDocumentsOrParts	back to summary
private boolean hasOnlyDocumentsOrParts(COSArray kLevelOneArray)

isDynamicXfa	back to summary
private boolean isDynamicXfa(PDAcroForm acroForm) Test for dynamic XFA content. Parameters acroForm:PDAcroForm the AcroForm Returns:boolean true if there is a dynamic XFA form.

isDynamicXfa

back to summary

private boolean isDynamicXfa(PDAcroForm acroForm)

Test for dynamic XFA content.

Parameters

acroForm:PDAcroForm: the AcroForm

Returns:boolean

true if there is a dynamic XFA form.

isIgnoreAcroFormErrors	back to summary
public boolean isIgnoreAcroFormErrors() Indicates if acroform errors are ignored or not. Returns:boolean true if acroform errors are ignored

isIgnoreAcroFormErrors

back to summary

public boolean isIgnoreAcroFormErrors()

Indicates if acroform errors are ignored or not.

Returns:boolean: true if acroform errors are ignored

legacyMergeDocuments back to summary

legacyMergeDocuments	back to summary
private void legacyMergeDocuments(RandomAccessStreamCache.StreamCacheCreateFunction streamCacheCreateFunction, CompressParameters compressParameters) throws IOException Merge the list of source documents, saving the result in the destination file. Parameters streamCacheCreateFunction:RandomAccessStreamCache.StreamCacheCreateFunction a function to create an instance of a stream cache; in case of `null` unrestricted main memory is used Exceptions IOException: If there is an error saving the document.

private void legacyMergeDocuments(RandomAccessStreamCache.StreamCacheCreateFunction streamCacheCreateFunction, CompressParameters compressParameters) throws IOException

Merge the list of source documents, saving the result in the destination file.

Parameters

streamCacheCreateFunction:RandomAccessStreamCache.StreamCacheCreateFunction: a function to create an instance of a stream cache; in case of null unrestricted main memory is used

Exceptions

IOException:: If there is an error saving the document.

mergeAcroForm	back to summary
private void mergeAcroForm(PDFCloneUtility cloner, PDDocumentCatalog destCatalog, PDDocumentCatalog srcCatalog) throws IOException

mergeDocuments back to summary

mergeDocuments	back to summary
public void mergeDocuments(RandomAccessStreamCache.StreamCacheCreateFunction streamCacheCreateFunction) throws 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 use `appendDocument(org.apache.pdfbox.pdmodel.PDDocument, org.apache.pdfbox.pdmodel.PDDocument)`. Parameters streamCacheCreateFunction:RandomAccessStreamCache.StreamCacheCreateFunction a function to create an instance of a stream cache; in case of `null` unrestricted main memory is used Exceptions IOException: If there is an error saving the document.

public void mergeDocuments(RandomAccessStreamCache.StreamCacheCreateFunction streamCacheCreateFunction) throws 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 use appendDocument(org.apache.pdfbox.pdmodel.PDDocument, org.apache.pdfbox.pdmodel.PDDocument).

Parameters

streamCacheCreateFunction:RandomAccessStreamCache.StreamCacheCreateFunction: a function to create an instance of a stream cache; in case of null unrestricted main memory is used

Exceptions

IOException:: If there is an error saving the document.

mergeDocuments back to summary

mergeDocuments	back to summary
public void mergeDocuments(RandomAccessStreamCache.StreamCacheCreateFunction streamCacheCreateFunction, CompressParameters compressParameters) throws 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 use `appendDocument(org.apache.pdfbox.pdmodel.PDDocument, org.apache.pdfbox.pdmodel.PDDocument)`. Parameters streamCacheCreateFunction:RandomAccessStreamCache.StreamCacheCreateFunction a function to create an instance of a stream cache; in case of `null` unrestricted main memory is used compressParameters:CompressParameters defines if compressed object streams are enabled Exceptions IOException: If there is an error saving the document.

public void mergeDocuments(RandomAccessStreamCache.StreamCacheCreateFunction streamCacheCreateFunction, CompressParameters compressParameters) throws IOException

Parameters

streamCacheCreateFunction:RandomAccessStreamCache.StreamCacheCreateFunction: a function to create an instance of a stream cache; in case of null unrestricted main memory is used
compressParameters:CompressParameters: defines if compressed object streams are enabled

Exceptions

IOException:: If there is an error saving the document.

mergeIDTree	back to summary
private void mergeIDTree(PDFCloneUtility cloner, PDStructureTreeRoot srcStructTree, PDStructureTreeRoot destStructTree) throws IOException

mergeInto	back to summary
private void mergeInto(COSDictionary src, COSDictionary dst, Set<COSName> exclude) This will add all of the dictionaries keys/values to this dictionary, but only if they are not in an exclusion list and if they don't already exist. If a key already exists in this dictionary then nothing is changed. Parameters src:COSDictionary The source dictionary to get the keys/values from. dst:COSDictionary The destination dictionary to merge the keys/values into. exclude:Set<COSName> Names of keys that shall be skipped.

mergeInto

back to summary

private void mergeInto(COSDictionary src, COSDictionary dst, Set<COSName> exclude)

This will add all of the dictionaries keys/values to this dictionary, but only if they are not in an exclusion list and if they don't already exist. If a key already exists in this dictionary then nothing is changed.

Parameters

src:COSDictionary: The source dictionary to get the keys/values from.
dst:COSDictionary: The destination dictionary to merge the keys/values into.
exclude:Set<COSName>: Names of keys that shall be skipped.

mergeKEntries	back to summary
private void mergeKEntries(PDFCloneUtility cloner, PDStructureTreeRoot srcStructTree, PDStructureTreeRoot destStructTree) throws IOException

mergeLanguage	back to summary
private void mergeLanguage(PDDocumentCatalog destCatalog, PDDocumentCatalog srcCatalog)

mergeMarkInfo	back to summary
private void mergeMarkInfo(PDDocumentCatalog destCatalog, PDDocumentCatalog srcCatalog)

mergeOutputIntents	back to summary
private void mergeOutputIntents(PDFCloneUtility cloner, PDDocumentCatalog srcCatalog, PDDocumentCatalog destCatalog) throws IOException

mergeRoleMap	back to summary
private void mergeRoleMap(PDStructureTreeRoot srcStructTree, PDStructureTreeRoot destStructTree)

mergeViewerPreferences	back to summary
private void mergeViewerPreferences(PDDocumentCatalog destCatalog, PDDocumentCatalog srcCatalog)

optimizedMergeDocuments	back to summary
private void optimizedMergeDocuments(RandomAccessStreamCache.StreamCacheCreateFunction streamCacheCreateFunction, CompressParameters compressParameters) throws IOException

setAcroFormMergeMode back to summary

setAcroFormMergeMode	back to summary
public void setAcroFormMergeMode(PDFMergerUtility.AcroFormMergeMode theAcroFormMergeMode) Set the merge mode to be used for merging AcroForms between documents `AcroFormMergeMode` Parameters theAcroFormMergeMode:PDFMergerUtility.AcroFormMergeMode AcroFormMergeMode to be used

public void setAcroFormMergeMode(PDFMergerUtility.AcroFormMergeMode theAcroFormMergeMode)

Set the merge mode to be used for merging AcroForms between documents AcroFormMergeMode

Parameters

theAcroFormMergeMode:PDFMergerUtility.AcroFormMergeMode: AcroFormMergeMode to be used

setDestinationDocumentInformation back to summary

setDestinationDocumentInformation	back to summary
public void setDestinationDocumentInformation(PDDocumentInformation info) Set the destination document information that is to be set in `mergeDocuments(org.apache.pdfbox.io.RandomAccessStreamCache.StreamCacheCreateFunction)`. The default is null, which means that it is ignored. Parameters info:PDDocumentInformation The destination document information.

public void setDestinationDocumentInformation(PDDocumentInformation info)

Set the destination document information that is to be set in mergeDocuments(org.apache.pdfbox.io.RandomAccessStreamCache.StreamCacheCreateFunction). The default is null, which means that it is ignored.

Parameters

info:PDDocumentInformation: The destination document information.

setDestinationFileName	back to summary
public void setDestinationFileName(String destination) Set the name of the destination file. Parameters destination:String The destination to set.

setDestinationFileName

back to summary

public void setDestinationFileName(String destination)

Set the name of the destination file.

Parameters

destination:String: The destination to set.

setDestinationMetadata back to summary

public void setDestinationMetadata(PDMetadata meta)

Set the destination metadata that is to be set in mergeDocuments(org.apache.pdfbox.io.RandomAccessStreamCache.StreamCacheCreateFunction). The default is null, which means that it is ignored.

Parameters

meta:PDMetadata: The destination metadata.

setDestinationStream

back to summary

public void setDestinationStream(OutputStream destStream)

Set the destination OutputStream.

Parameters

destStream:OutputStream: The destination to set.

setDocumentMergeMode back to summary

public void setDocumentMergeMode(PDFMergerUtility.DocumentMergeMode theDocumentMergeMode)

Set the merge mode to be used for merging documents DocumentMergeMode

Parameters

theDocumentMergeMode:PDFMergerUtility.DocumentMergeMode: DocumentMergeMode to be used

setIgnoreAcroFormErrors

back to summary

public void setIgnoreAcroFormErrors(boolean ignoreAcroFormErrorsValue)

Set to true to ignore acroform errors.

Parameters

ignoreAcroFormErrorsValue:boolean: true if acroform errors should be ignored

updatePageReferences	back to summary
private void updatePageReferences(PDFCloneUtility cloner, Map<Integer, COSObjectable> numberTreeAsMap, Map<COSDictionary, COSDictionary> objMapping) throws IOException Update the Pg and Obj references to the new (merged) page.

updatePageReferences

back to summary

private void updatePageReferences(PDFCloneUtility cloner, COSDictionary parentTreeEntry, Map<COSDictionary, COSDictionary> objMapping) throws IOException

Update the Pg and Obj references to the new (merged) page.

Parameters

objMapping:Map<COSDictionary, COSDictionary>: mapping between old and new references

updatePageReferences	back to summary
private void updatePageReferences(PDFCloneUtility cloner, COSArray parentTreeEntry, Map<COSDictionary, COSDictionary> objMapping) throws IOException

updateParentEntry

back to summary

private void updateParentEntry(COSArray kArray, COSDictionary newParent, COSName newStructureType)

Update the P reference to the new parent dictionary.

Parameters

kArray:COSArray: the kids array
newParent:COSDictionary: the new parent
newStructureType:COSName: the new structure type in /S or null so it doesn't get replaced

updateStructParentEntries

back to summary

private void updateStructParentEntries(PDPage page, int structParentOffset) throws IOException

Update the StructParents and StructParent values in a PDPage.

Parameters

page:PDPage: the new page
structParentOffset:int: the offset which should be applied

org.apache.pdfbox.multipdf back to summary

public final Enum PDFMergerUtility.AcroFormMergeMode

Class Inheritance

extends Enum<PDFMergerUtility.AcroFormMergeMode>

java.lang.Object
java.lang.Enum
org.apache.pdfbox.multipdf.PDFMergerUtility.AcroFormMergeMode

The mode to use when merging AcroForm between documents:

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.
AcroFormMergeMode#PDFBOX_LEGACY_MODE fields with the same fully qualified name will be renamed and treated as independent. This mode was used in versions of PDFBox up to 2.x.

Field Summary

Modifier and Type	Field and Description
public static final PDFMergerUtility.AcroFormMergeMode	JOIN_FORM_FIELDS_MODE
public static final PDFMergerUtility.AcroFormMergeMode	PDFBOX_LEGACY_MODE

Constructor Summary

Access	Constructor and Description
private	AcroFormMergeMode()

Method Summary

Modifier and Type	Method and Description
public static PDFMergerUtility.AcroFormMergeMode	valueOf(String name)
public static PDFMergerUtility.AcroFormMergeMode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

JOIN_FORM_FIELDS_MODE	back to summary
public static final PDFMergerUtility.AcroFormMergeMode JOIN_FORM_FIELDS_MODE

PDFBOX_LEGACY_MODE	back to summary
public static final PDFMergerUtility.AcroFormMergeMode PDFBOX_LEGACY_MODE

Constructor Detail

AcroFormMergeMode	back to summary
private AcroFormMergeMode()

Method Detail

valueOf	back to summary
public static PDFMergerUtility.AcroFormMergeMode valueOf(String name)

values	back to summary
public static PDFMergerUtility.AcroFormMergeMode[] values()

org.apache.pdfbox.multipdf back to summary

public final Enum PDFMergerUtility.DocumentMergeMode

Class Inheritance

extends Enum<PDFMergerUtility.DocumentMergeMode>

java.lang.Object
java.lang.Enum
org.apache.pdfbox.multipdf.PDFMergerUtility.DocumentMergeMode

The mode to use when merging documents:

DocumentMergeMode#OPTIMIZE_RESOURCES_MODE Optimizes resource handling such as closing documents early. Not all document elements are merged compared to the PDFBOX_LEGACY_MODE. Currently supported are:
- Page content and resources
DocumentMergeMode#PDFBOX_LEGACY_MODE Keeps all files open until the merge has been completed. This is currently necessary to merge documents containing a Structure Tree.

Field Summary

Modifier and Type	Field and Description
public static final PDFMergerUtility.DocumentMergeMode	OPTIMIZE_RESOURCES_MODE
public static final PDFMergerUtility.DocumentMergeMode	PDFBOX_LEGACY_MODE

Constructor Summary

Access	Constructor and Description
private	DocumentMergeMode()

Method Summary

Modifier and Type	Method and Description
public static PDFMergerUtility.DocumentMergeMode	valueOf(String name)
public static PDFMergerUtility.DocumentMergeMode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

OPTIMIZE_RESOURCES_MODE	back to summary
public static final PDFMergerUtility.DocumentMergeMode OPTIMIZE_RESOURCES_MODE

PDFBOX_LEGACY_MODE	back to summary
public static final PDFMergerUtility.DocumentMergeMode PDFBOX_LEGACY_MODE

Constructor Detail

DocumentMergeMode	back to summary
private DocumentMergeMode()

Method Detail

valueOf	back to summary
public static PDFMergerUtility.DocumentMergeMode valueOf(String name)

values	back to summary
public static PDFMergerUtility.DocumentMergeMode[] values()

public Class PDFMergerUtility

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum PDFMergerUtility.AcroFormMergeMode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum PDFMergerUtility.DocumentMergeMode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail