Package org.apache.pdfbox.util
Class PDFCloneUtility
- java.lang.Object
-
- org.apache.pdfbox.util.PDFCloneUtility
-
public class PDFCloneUtility extends java.lang.Object
Utility class used to clone PDF objects. It keeps track of objects it has already cloned.- Version:
- $Revision$
-
-
Constructor Summary
Constructors Constructor Description PDFCloneUtility(PDDocument dest)
Creates a new instance for the given target document.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description COSBase
cloneForNewDocument(java.lang.Object base)
Deep-clones the given object for inclusion into a different PDF document identified by the destination parameter.void
cloneMerge(COSObjectable base, COSObjectable target)
Merges two objects of the same type by deep-cloning its members.PDDocument
getDestination()
Returns the destination PDF document this cloner instance is set up for.
-
-
-
Constructor Detail
-
PDFCloneUtility
public PDFCloneUtility(PDDocument dest)
Creates a new instance for the given target document.- Parameters:
dest
- the destination PDF document that will receive the clones
-
-
Method Detail
-
getDestination
public PDDocument getDestination()
Returns the destination PDF document this cloner instance is set up for.- Returns:
- the destination PDF document
-
cloneForNewDocument
public COSBase cloneForNewDocument(java.lang.Object base) throws java.io.IOException
Deep-clones the given object for inclusion into a different PDF document identified by the destination parameter.- Parameters:
base
- the initial object as the root of the deep-clone operation- Returns:
- the cloned instance of the base object
- Throws:
java.io.IOException
- if an I/O error occurs
-
cloneMerge
public void cloneMerge(COSObjectable base, COSObjectable target) throws java.io.IOException
Merges two objects of the same type by deep-cloning its members.
Base and target must be instances of the same class.- Parameters:
base
- the base object to be clonedtarget
- the merge target- Throws:
java.io.IOException
- if an I/O error occurs
-
-