org.apache.pdfbox.pdfparser

Class PDFParser

java.lang.Object

org.apache.pdfbox.pdfparser.BaseParser

org.apache.pdfbox.pdfparser.COSParser

org.apache.pdfbox.pdfparser.PDFParser

public class PDFParser
extends COSParser

Field Summary

Fields inherited from class org.apache.pdfbox.pdfparser.COSParser

EOF_MARKER, fileLen, initialParseDone, OBJ_MARKER, securityHandler, SYSPROP_EOFLOOKUPRANGE, SYSPROP_PARSEMINIMAL, TMP_FILE_PREFIX, xrefTrailerResolver

Fields inherited from class org.apache.pdfbox.pdfparser.BaseParser

A, ASCII_CR, ASCII_LF, ASCII_SPACE, B, D, DEF, document, E, ENDOBJ_STRING, ENDSTREAM_STRING, J, M, N, O, pdfSource, PROP_PUSHBACK_SIZE, R, S, STREAM_STRING, T, validationParsing

Constructor Summary

Constructors

Constructor and Description
PDFParser(RandomAccessRead source) Constructor.
PDFParser(RandomAccessRead source, boolean useScratchFiles) Constructor.
PDFParser(RandomAccessRead source, String decryptionPassword) Constructor.
PDFParser(RandomAccessRead source, String decryptionPassword, boolean useScratchFiles) Constructor.
PDFParser(RandomAccessRead source, String decryptionPassword, InputStream keyStore, String alias) Constructor.
PDFParser(RandomAccessRead source, String decryptionPassword, InputStream keyStore, String alias, boolean useScratchFiles) Constructor.
PDFParser(RandomAccessRead source, String decryptionPassword, InputStream keyStore, String alias, boolean useScratchFiles, boolean validationParsing) Constructor.

Method Summary

Modifier and Type	Method and Description
PDDocument	getPDDocument() This will get the PD document that was parsed.
protected void	initialParse() The initial parse will first parse only the trailer, the xrefstart and all xref tables to have a pointer (offset) to all the pdf's objects.
void	parse() This will parse the stream and populate the COSDocument object.

Methods inherited from class org.apache.pdfbox.pdfparser.COSParser

getDocument, getFirstTrailer, getLastTrailer, getStartxrefOffset, isLenient, isLinearized, lastIndexOf, parseCOSStream, parseDictObjects, parseFDFHeader, parseObjectDynamically, parseObjectDynamically, parsePDFHeader, parseSuspensionObjects, parseTrailerValuesDynamically, parseXref, parseXrefTable, rebuildTrailer, setEOFLookupRange, setLenient

Methods inherited from class org.apache.pdfbox.pdfparser.BaseParser

isClosing, isClosing, isDigit, isDigit, isEndOfName, isEOL, isEOL, isSpace, isSpace, isWhitespace, isWhitespace, parseBoolean, parseCOSArray, parseCOSDictionary, parseCOSName, parseCOSString, parseDirObject, readExpectedChar, readExpectedString, readExpectedString, readGenerationNumber, readInt, readLine, readLineWithoutWhitespacesSkip, readLong, readObjectNumber, readString, readString, readStringNumber, skipSpaces, skipWhiteSpaces

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PDFParser

public PDFParser(RandomAccessRead source)
          throws IOException

Constructor.

Parameters:

source - source representing the pdf.

Throws:

IOException - If something went wrong.

PDFParser

public PDFParser(RandomAccessRead source,
                 boolean useScratchFiles)
          throws IOException

Constructor.

Parameters:

source - input representing the pdf.

useScratchFiles - use a file based buffer for temporary storage.

Throws:

IOException - If something went wrong.

PDFParser

public PDFParser(RandomAccessRead source,
                 String decryptionPassword)
          throws IOException

Constructor.

Parameters:

source - input representing the pdf.

decryptionPassword - password to be used for decryption.

Throws:

IOException - If something went wrong.

PDFParser

public PDFParser(RandomAccessRead source,
                 String decryptionPassword,
                 boolean useScratchFiles)
          throws IOException

Constructor.

Parameters:

source - input representing the pdf.

decryptionPassword - password to be used for decryption.

useScratchFiles - use a file based buffer for temporary storage.

Throws:

IOException - If something went wrong.

PDFParser

public PDFParser(RandomAccessRead source,
                 String decryptionPassword,
                 InputStream keyStore,
                 String alias)
          throws IOException

Constructor.

Parameters:

source - input representing the pdf.

decryptionPassword - password to be used for decryption.

keyStore - key store to be used for decryption when using public key security

alias - alias to be used for decryption when using public key security

Throws:

IOException - If something went wrong.

PDFParser

public PDFParser(RandomAccessRead source,
                 String decryptionPassword,
                 InputStream keyStore,
                 String alias,
                 boolean useScratchFiles)
          throws IOException

Constructor.

Parameters:

source - input representing the pdf.

decryptionPassword - password to be used for decryption.

keyStore - key store to be used for decryption when using public key security

alias - alias to be used for decryption when using public key security

useScratchFiles - use a buffer for temporary storage.

Throws:

IOException - If something went wrong.

PDFParser

public PDFParser(RandomAccessRead source,
                 String decryptionPassword,
                 InputStream keyStore,
                 String alias,
                 boolean useScratchFiles,
                 boolean validationParsing)
          throws IOException

Constructor.

Parameters:

source - input representing the pdf.

decryptionPassword - password to be used for decryption.

keyStore - key store to be used for decryption when using public key security

alias - alias to be used for decryption when using public key security

useScratchFiles - use a buffer for temporary storage.

validationParsing - true if need to use validation parser

Throws:

IOException - If something went wrong.

Method Detail

getPDDocument

public PDDocument getPDDocument()
                         throws IOException

This will get the PD document that was parsed. When you are done with this document you must call close() on it to release resources.

Returns:

The document at the PD layer.

Throws:

IOException - If there is an error getting the document.

initialParse

protected void initialParse()
                     throws IOException

The initial parse will first parse only the trailer, the xrefstart and all xref tables to have a pointer (offset) to all the pdf's objects. It can handle linearized pdfs, which will have an xref at the end pointing to an xref at the beginning of the file. Last the root object is parsed.

Throws:

IOException - If something went wrong.

parse

public void parse()
           throws IOException

This will parse the stream and populate the COSDocument object. This will close the stream when it is done parsing.

Throws:

IOException - If there is an error reading from the stream or corrupt data is found.