Package org.apache.pdfbox.pdmodel.fdf
Class FDFDocument
java.lang.Object
org.apache.pdfbox.pdmodel.fdf.FDFDocument
- All Implemented Interfaces:
Closeable
,AutoCloseable
This is the in-memory representation of the FDF document. You need to call
close() on this object when you are done using it!!
- Author:
- Ben Litchfield
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor, creates a new FDF document.FDFDocument
(COSDocument doc) Constructor that uses an existing document.FDFDocument
(Document doc) This will create an FDF document from an XFDF XML document. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
This will close the underlying COSDocument object.This will get the FDF Catalog.This will get the low level document.static FDFDocument
This will load a document from a file.static FDFDocument
load
(InputStream input) This will load a document from an input stream.static FDFDocument
This will load a document from a file.static FDFDocument
This will load a document from a file.static FDFDocument
loadXFDF
(InputStream input) This will load a document from an input stream.static FDFDocument
This will load a document from a file.void
This will save this document to the filesystem.void
save
(OutputStream output) This will save the document to an output stream.void
This will save this document to the filesystem.void
This will save this document to the filesystem.void
This will save the document to an output stream and close the stream.void
This will save this document to the filesystem.void
setCatalog
(FDFCatalog cat) This will set the FDF catalog for this FDF document.void
This will write this element as an XML document.
-
Constructor Details
-
FDFDocument
Constructor, creates a new FDF document.- Throws:
IOException
- If there is an error creating this document.
-
FDFDocument
Constructor that uses an existing document. The COSDocument that is passed in must be valid.- Parameters:
doc
- The COSDocument that this document wraps.
-
FDFDocument
This will create an FDF document from an XFDF XML document.- Parameters:
doc
- The XML document that contains the XFDF data.- Throws:
IOException
- If there is an error reading from the dom.
-
-
Method Details
-
writeXML
This will write this element as an XML document.- Parameters:
output
- The stream to write the xml to.- Throws:
IOException
- If there is an error writing the XML.
-
getDocument
This will get the low level document.- Returns:
- The document that this layer sits on top of.
-
getCatalog
This will get the FDF Catalog. This is guaranteed to not return null.- Returns:
- The documents /Root dictionary
-
setCatalog
This will set the FDF catalog for this FDF document.- Parameters:
cat
- The FDF catalog.
-
load
This will load a document from a file.- Parameters:
filename
- The name of the file to load.- Returns:
- The document that was loaded.
- Throws:
IOException
- If there is an error reading from the stream.
-
load
This will load a document from a file.- Parameters:
file
- The name of the file to load.- Returns:
- The document that was loaded.
- Throws:
IOException
- If there is an error reading from the stream.
-
load
This will load a document from an input stream.- Parameters:
input
- The stream that contains the document.- Returns:
- The document that was loaded.
- Throws:
IOException
- If there is an error reading from the stream.
-
loadXFDF
This will load a document from a file.- Parameters:
filename
- The name of the file to load.- Returns:
- The document that was loaded.
- Throws:
IOException
- If there is an error reading from the stream.
-
loadXFDF
This will load a document from a file.- Parameters:
file
- The name of the file to load.- Returns:
- The document that was loaded.
- Throws:
IOException
- If there is an error reading from the stream.
-
loadXFDF
This will load a document from an input stream.- Parameters:
input
- The stream that contains the document.- Returns:
- The document that was loaded.
- Throws:
IOException
- If there is an error reading from the stream.
-
save
This will save this document to the filesystem.- Parameters:
fileName
- The file to save as.- Throws:
IOException
- If there is an error saving the document.COSVisitorException
- If an error occurs while generating the data.
-
save
This will save this document to the filesystem.- Parameters:
fileName
- The file to save as.- Throws:
IOException
- If there is an error saving the document.COSVisitorException
- If an error occurs while generating the data.
-
save
This will save the document to an output stream.- Parameters:
output
- The stream to write to.- Throws:
IOException
- If there is an error writing the document.COSVisitorException
- If an error occurs while generating the data.
-
saveXFDF
This will save this document to the filesystem.- Parameters:
fileName
- The file to save as.- Throws:
IOException
- If there is an error saving the document.COSVisitorException
- If an error occurs while generating the data.
-
saveXFDF
This will save this document to the filesystem.- Parameters:
fileName
- The file to save as.- Throws:
IOException
- If there is an error saving the document.COSVisitorException
- If an error occurs while generating the data.
-
saveXFDF
This will save the document to an output stream and close the stream.- Parameters:
output
- The stream to write to.- Throws:
IOException
- If there is an error writing the document.COSVisitorException
- If an error occurs while generating the data.
-
close
This will close the underlying COSDocument object.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
- If there is an error releasing resources.
-