Package org.apache.pdfbox.pdmodel.common
Class PDMetadata
java.lang.Object
org.apache.pdfbox.pdmodel.common.PDStream
org.apache.pdfbox.pdmodel.common.PDMetadata
- All Implemented Interfaces:
COSObjectable
This class represents metadata for various objects in a PDF document.
- Author:
- Ben Litchfield
-
Constructor Summary
ConstructorsConstructorDescriptionPDMetadata
(COSStream str) Constructor.PDMetadata
(PDDocument document) This will create a new PDMetadata object.PDMetadata
(PDDocument doc, InputStream str) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionExtract the XMP metadata.void
importXMPMetadata
(byte[] xmp) Import an XMP stream into the PDF document.Methods inherited from class org.apache.pdfbox.pdmodel.common.PDStream
addCompression, createInputStream, createInputStream, createInputStream, createOutputStream, createOutputStream, getCOSObject, getDecodedStreamLength, getDecodeParms, getFile, getFileDecodeParams, getFileFilters, getFilters, getLength, getMetadata, getStream, setDecodedStreamLength, setDecodeParms, setFile, setFileDecodeParams, setFileFilters, setFilters, setMetadata, toByteArray
-
Constructor Details
-
PDMetadata
This will create a new PDMetadata object.- Parameters:
document
- The document that the stream will be part of.
-
PDMetadata
Constructor. Reads all data from the input stream and embeds it into the document, this will close the InputStream.- Parameters:
doc
- The document that will hold the stream.str
- The stream parameter.- Throws:
IOException
- If there is an error creating the stream in the document.
-
PDMetadata
Constructor.- Parameters:
str
- The stream parameter.
-
-
Method Details
-
exportXMPMetadata
Extract the XMP metadata. To persist changes back to the PDF you must call importXMPMetadata.- Returns:
- A stream to get the xmp data from.
- Throws:
IOException
- If there is an error parsing the XMP data.
-
importXMPMetadata
Import an XMP stream into the PDF document.- Parameters:
xmp
- The XMP data.- Throws:
IOException
- If there is an error generating the XML document.
-