You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by bu...@apache.org on 2015/03/30 07:53:23 UTC
svn commit: r945586 [16/47] - in /websites/staging/pdfbox/trunk/content: ./
docs/2.0.0-SNAPSHOT/javadocs/
docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/contentstream/
docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/contentstream/class-use/
docs/2.0.0-S...
Modified: websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdfparser/PDFParser.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdfparser/PDFParser.html (original)
+++ websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdfparser/PDFParser.html Mon Mar 30 05:53:07 2015
@@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="de">
<head>
-<!-- Generated by javadoc (version 1.7.0_55) on Sun Jan 04 20:50:33 CET 2015 -->
+<!-- Generated by javadoc (version 1.7.0_55) on Mon Mar 30 07:21:56 CEST 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>PDFParser (Apache PDFBox 2.0.0-SNAPSHOT API)</title>
-<meta name="date" content="2015-01-04">
+<meta name="date" content="2015-03-30">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -63,13 +63,13 @@
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
-<li><a href="#field_summary">Field</a> | </li>
+<li><a href="#fields_inherited_from_class_org.apache.pdfbox.pdfparser.COSParser">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
-<li><a href="#field_detail">Field</a> | </li>
+<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
@@ -91,26 +91,28 @@
<li><a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html" title="class in org.apache.pdfbox.pdfparser">org.apache.pdfbox.pdfparser.BaseParser</a></li>
<li>
<ul class="inheritance">
+<li><a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html" title="class in org.apache.pdfbox.pdfparser">org.apache.pdfbox.pdfparser.COSParser</a></li>
+<li>
+<ul class="inheritance">
<li>org.apache.pdfbox.pdfparser.PDFParser</li>
</ul>
</li>
</ul>
</li>
</ul>
+</li>
+</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
-<dt>Direct Known Subclasses:</dt>
-<dd><a href="../../../../org/apache/pdfbox/pdfparser/NonSequentialPDFParser.html" title="class in org.apache.pdfbox.pdfparser">NonSequentialPDFParser</a></dd>
+<dt>All Implemented Interfaces:</dt>
+<dd><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">PDFParser</span>
-extends <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html" title="class in org.apache.pdfbox.pdfparser">BaseParser</a></pre>
-<div class="block">This class will handle the parsing of the PDF document.</div>
-<dl><dt><span class="strong">Author:</span></dt>
- <dd>Ben Litchfield</dd></dl>
+extends <a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html" title="class in org.apache.pdfbox.pdfparser">COSParser</a></pre>
</li>
</ul>
</div>
@@ -123,42 +125,19 @@ extends <a href="../../../../org/apache/
<!-- -->
</a>
<h3>Field Summary</h3>
-<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
-<caption><span>Fields</span><span class="tabEnd"> </span></caption>
-<tr>
-<th class="colFirst" scope="col">Modifier and Type</th>
-<th class="colLast" scope="col">Field and Description</th>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>static boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#FORCE_PARSING">FORCE_PARSING</a></strong></code>
-<div class="block">Default value of the <a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#forceParsing"><code>forceParsing</code></a> flag.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>protected boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#forceParsing">forceParsing</a></strong></code>
-<div class="block">Flag to skip malformed or otherwise unparseable input where possible.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>protected boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#isFDFDocment">isFDFDocment</a></strong></code> </td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>protected <a href="../../../../org/apache/pdfbox/pdfparser/XrefTrailerResolver.html" title="class in org.apache.pdfbox.pdfparser">XrefTrailerResolver</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#xrefTrailerResolver">xrefTrailerResolver</a></strong></code>
-<div class="block">Collects all Xref/trailer objects and resolves them into single
- object using startxref reference.</div>
-</td>
-</tr>
-</table>
+<ul class="blockList">
+<li class="blockList"><a name="fields_inherited_from_class_org.apache.pdfbox.pdfparser.COSParser">
+<!-- -->
+</a>
+<h3>Fields inherited from class org.apache.pdfbox.pdfparser.<a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html" title="class in org.apache.pdfbox.pdfparser">COSParser</a></h3>
+<code><a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#EOF_MARKER">EOF_MARKER</a>, <a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#fileLen">fileLen</a>, <a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#initialParseDone">initialParseDone</a>, <a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#OBJ_MARKER">OBJ_MARKER</a>, <a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#securityHandler">securityHandler</a>, <a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#SYSPROP_EOFLOOKUPRANGE">SYSPROP_EOFLOOKUPRANGE</a>, <a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#SYSPROP_PARSEMINIMAL">SYSPROP_PARSEMINIMAL</a>, <a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#TMP_FILE_PREFIX">TMP_FILE_PREFIX</a>, <a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#xrefTrailerResolver">xrefTrailerResolver</a></code></li>
+</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.pdfbox.pdfparser.BaseParser">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.pdfbox.pdfparser.<a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html" title="class in org.apache.pdfbox.pdfparser">BaseParser</a></h3>
-<code><a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#DEF">DEF</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#document">document</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#ENDOBJ">ENDOBJ</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#ENDSTREAM">ENDSTREAM</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#pdfSource">pdfSource</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#PROP_PUSHBACK_SIZE">PROP_PUSHBACK_SIZE</a></code></li>
+<code><a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#ASCII_CR">ASCII_CR</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#ASCII_LF">ASCII_LF</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#DEF">DEF</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#document">document</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#ENDOBJ">ENDOBJ</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#ENDOBJ_STRING">ENDOBJ_STRING</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#ENDSTREAM">ENDSTREAM</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#ENDSTREAM_STRING">ENDSTREAM_STRING</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#ISO_8859_1">ISO_8859_1</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#pdfSource">pdfSource</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#PROP_PUSHBACK_SI
ZE">PROP_PUSHBACK_SIZE</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#STREAM_STRING">STREAM_STRING</a></code></li>
</ul>
</li>
</ul>
@@ -174,133 +153,148 @@ extends <a href="../../../../org/apache/
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
-<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#PDFParser(java.io.InputStream)">PDFParser</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input)</code>
-<div class="block">Constructor.</div>
+<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#PDFParser(java.io.File)">PDFParser</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</code>
+<div class="block">Constructs parser for given file using given buffer for temporary
+ storage.</div>
</td>
</tr>
<tr class="rowColor">
-<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#PDFParser(java.io.InputStream, boolean)">PDFParser</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input,
- boolean force)</code>
-<div class="block">Constructor to allow control over RandomAccessFile.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#PDFParser(java.io.InputStream, boolean, boolean)">PDFParser</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input,
- boolean force,
+<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#PDFParser(java.io.File, boolean)">PDFParser</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file,
boolean useScratchFiles)</code>
-<div class="block">Constructor to allow control over RandomAccessFile.</div>
+<div class="block">Constructs parser for given file using given buffer for temporary
+ storage.</div>
</td>
</tr>
-</table>
-</li>
-</ul>
-<!-- ========== METHOD SUMMARY =========== -->
-<ul class="blockList">
-<li class="blockList"><a name="method_summary">
-<!-- -->
-</a>
-<h3>Method Summary</h3>
-<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
-<caption><span>Methods</span><span class="tabEnd"> </span></caption>
-<tr>
-<th class="colFirst" scope="col">Modifier and Type</th>
-<th class="colLast" scope="col">Method and Description</th>
-</tr>
<tr class="altColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#clearResources()">clearResources</a></strong>()</code>
-<div class="block">Release all used resources.</div>
+<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#PDFParser(java.io.File, java.lang.String)">PDFParser</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> decryptionPassword)</code>
+<div class="block">Constructs parser for given file using given buffer for temporary storage.</div>
</td>
</tr>
<tr class="rowColor">
-<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/cos/COSDocument.html" title="class in org.apache.pdfbox.cos">COSDocument</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#getDocument()">getDocument</a></strong>()</code>
-<div class="block">This will get the document that was parsed.</div>
+<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#PDFParser(java.io.File, java.lang.String, boolean)">PDFParser</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> decryptionPassword,
+ boolean useScratchFiles)</code>
+<div class="block">Constructs parser for given file using given buffer for temporary storage.</div>
</td>
</tr>
<tr class="altColor">
-<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/pdmodel/fdf/FDFDocument.html" title="class in org.apache.pdfbox.pdmodel.fdf">FDFDocument</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#getFDFDocument()">getFDFDocument</a></strong>()</code>
-<div class="block">This will get the FDF document that was parsed.</div>
+<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#PDFParser(java.io.File, java.lang.String, java.io.InputStream, java.lang.String)">PDFParser</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> decryptionPassword,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> keyStore,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> alias)</code>
+<div class="block">Constructs parser for given file using given buffer for temporary storage.</div>
</td>
</tr>
<tr class="rowColor">
-<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/pdmodel/PDDocument.html" title="class in org.apache.pdfbox.pdmodel">PDDocument</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#getPDDocument()">getPDDocument</a></strong>()</code>
-<div class="block">This will get the PD document that was parsed.</div>
+<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#PDFParser(java.io.File, java.lang.String, java.io.InputStream, java.lang.String, boolean)">PDFParser</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> decryptionPassword,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> keyStore,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> alias,
+ boolean useScratchFiles)</code>
+<div class="block">Constructs parser for given file using given buffer for temporary storage.</div>
</td>
</tr>
<tr class="altColor">
-<td class="colFirst"><code>protected boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#isContinueOnError(java.lang.Exception)">isContinueOnError</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a> e)</code>
-<div class="block">Returns true if parsing should be continued.</div>
+<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#PDFParser(java.io.InputStream)">PDFParser</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input)</code>
+<div class="block">Constructor.</div>
</td>
</tr>
<tr class="rowColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#parse()">parse</a></strong>()</code>
-<div class="block">This will parse the stream and populate the COSDocument object.</div>
+<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#PDFParser(java.io.InputStream, boolean)">PDFParser</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input,
+ boolean useScratchFiles)</code>
+<div class="block">Constructor.</div>
</td>
</tr>
<tr class="altColor">
-<td class="colFirst"><code>protected void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#parseHeader()">parseHeader</a></strong>()</code> </td>
+<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#PDFParser(java.io.InputStream, java.lang.String)">PDFParser</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> decryptionPassword)</code>
+<div class="block">Constructor.</div>
+</td>
</tr>
<tr class="rowColor">
-<td class="colFirst"><code>protected boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#parseStartXref()">parseStartXref</a></strong>()</code>
-<div class="block">This will parse the startxref section from the stream.</div>
+<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#PDFParser(java.io.InputStream, java.lang.String, boolean)">PDFParser</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> decryptionPassword,
+ boolean useScratchFiles)</code>
+<div class="block">Constructor.</div>
</td>
</tr>
<tr class="altColor">
-<td class="colFirst"><code>protected boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#parseTrailer()">parseTrailer</a></strong>()</code>
-<div class="block">This will parse the trailer from the stream and add it to the state.</div>
+<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#PDFParser(java.io.InputStream, java.lang.String, java.io.InputStream, java.lang.String)">PDFParser</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> decryptionPassword,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> keyStore,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> alias)</code>
+<div class="block">Constructor.</div>
</td>
</tr>
<tr class="rowColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#parseXrefStream(org.apache.pdfbox.cos.COSStream, long)">parseXrefStream</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSStream.html" title="class in org.apache.pdfbox.cos">COSStream</a> stream,
- long objByteOffset)</code>
-<div class="block">Fills XRefTrailerResolver with data of given stream.</div>
+<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#PDFParser(java.io.InputStream, java.lang.String, java.io.InputStream, java.lang.String, boolean)">PDFParser</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> decryptionPassword,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> keyStore,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> alias,
+ boolean useScratchFiles)</code>
+<div class="block">Constructor.</div>
</td>
</tr>
<tr class="altColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#parseXrefStream(org.apache.pdfbox.cos.COSStream, long, boolean)">parseXrefStream</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSStream.html" title="class in org.apache.pdfbox.cos">COSStream</a> stream,
- long objByteOffset,
- boolean isStandalone)</code>
-<div class="block">Fills XRefTrailerResolver with data of given stream.</div>
+<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#PDFParser(java.lang.String)">PDFParser</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filename)</code>
+<div class="block">Constructs parser for given file using memory buffer.</div>
</td>
</tr>
<tr class="rowColor">
-<td class="colFirst"><code>protected boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#parseXrefTable(long)">parseXrefTable</a></strong>(long startByteOffset)</code>
-<div class="block">This will parse the xref table from the stream and add it to the state
- The XrefTable contents are ignored.</div>
+<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#PDFParser(java.lang.String, boolean)">PDFParser</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filename,
+ boolean useScratchFiles)</code>
+<div class="block">Constructs parser for given file using memory buffer.</div>
</td>
</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span>Methods</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
<tr class="altColor">
-<td class="colFirst"><code>protected void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#readVersionInTrailer(org.apache.pdfbox.cos.COSDictionary)">readVersionInTrailer</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> parsedTrailer)</code>
-<div class="block">The document catalog can also have a /Version parameter which overrides the version specified
- in the header if, and only if it is greater.</div>
+<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/pdmodel/PDDocument.html" title="class in org.apache.pdfbox.pdmodel">PDDocument</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#getPDDocument()">getPDDocument</a></strong>()</code>
+<div class="block">This will get the PD document that was parsed.</div>
</td>
</tr>
<tr class="rowColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#initialParse()">initialParse</a></strong>()</code>
+<div class="block">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.</div>
+</td>
+</tr>
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#setTempDirectory(java.io.File)">setTempDirectory</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> tmpDir)</code>
-<div class="block">This is the directory where pdfbox will create a temporary file
- for storing pdf document stream in.</div>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#parse()">parse</a></strong>()</code>
+<div class="block">This will parse the stream and populate the COSDocument object.</div>
</td>
</tr>
</table>
<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_org.apache.pdfbox.pdfparser.COSParser">
+<!-- -->
+</a>
+<h3>Methods inherited from class org.apache.pdfbox.pdfparser.<a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html" title="class in org.apache.pdfbox.pdfparser">COSParser</a></h3>
+<code><a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#getDocument()">getDocument</a>, <a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#getStartxrefOffset()">getStartxrefOffset</a>, <a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#isLenient()">isLenient</a>, <a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#lastIndexOf(char[], byte[], int)">lastIndexOf</a>, <a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#parseCOSStream(org.apache.pdfbox.cos.COSDictionary)">parseCOSStream</a>, <a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#parseDictObjects(org.apache.pdfbox.cos.COSDictionary, org.apache.pdfbox.cos.COSName...)">parseDictObjects</a>, <a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#parseFDFHeader()">parseFDFHeader</a>, <a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#parseObjectDynamically(org.apache.pdfbox.cos.COSObject, boolean)">parseObjectDynamically</a>, <a hre
f="../../../../org/apache/pdfbox/pdfparser/COSParser.html#parseObjectDynamically(long, int, boolean)">parseObjectDynamically</a>, <a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#parsePDFHeader()">parsePDFHeader</a>, <a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#parseXref(long)">parseXref</a>, <a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#parseXrefTable(long)">parseXrefTable</a>, <a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#rebuildTrailer()">rebuildTrailer</a>, <a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#setEOFLookupRange(int)">setEOFLookupRange</a>, <a href="../../../../org/apache/pdfbox/pdfparser/COSParser.html#setLenient(boolean)">setLenient</a></code></li>
+</ul>
+<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.pdfbox.pdfparser.BaseParser">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.pdfbox.pdfparser.<a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html" title="class in org.apache.pdfbox.pdfparser">BaseParser</a></h3>
-<code><a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#createCOSStream(org.apache.pdfbox.cos.COSDictionary)">createCOSStream</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isClosing()">isClosing</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isClosing(int)">isClosing</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isEndOfName(char)">isEndOfName</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isEOL()">isEOL</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isEOL(int)">isEOL</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isWhitespace()">isWhitespace</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isWhitespace(int)">isWhitespace</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseBoolean()">parseBoolean</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseCOSArray()">parseC
OSArray</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseCOSDictionary()">parseCOSDictionary</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseCOSName()">parseCOSName</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseCOSStream(org.apache.pdfbox.cos.COSDictionary)">parseCOSStream</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseCOSString()">parseCOSString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseCOSString(boolean)">parseCOSString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseDirObject()">parseDirObject</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseObjectKey(boolean)">parseObjectKey</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readExpectedChar(char)">readExpectedChar</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readExpectedString(java.lang.Strin
g)">readExpectedString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readGenerationNumber()">readGenerationNumber</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readInt()">readInt</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readLine()">readLine</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readLong()">readLong</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readObjectNumber()">readObjectNumber</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readString()">readString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readString(int)">readString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readStringNumber()">readStringNumber</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readUntilEndStream(java.io.OutputStream)">readUntilEndStream</a>, <a href="../../../../org/apache/pdfbox/pdfpar
ser/BaseParser.html#setDocument(org.apache.pdfbox.cos.COSDocument)">setDocument</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#skipSpaces()">skipSpaces</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#skipToNextObj()">skipToNextObj</a></code></li>
+<code><a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#close()">close</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#createCOSStream(org.apache.pdfbox.cos.COSDictionary)">createCOSStream</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isClosing()">isClosing</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isClosing(int)">isClosing</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isDigit()">isDigit</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isDigit(int)">isDigit</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isEndOfName(char)">isEndOfName</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isEOL()">isEOL</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isEOL(int)">isEOL</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isSpace()">isSpace</a>, <a href="../../../../org/apache/p
dfbox/pdfparser/BaseParser.html#isSpace(int)">isSpace</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isString(byte[])">isString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isString(char[])">isString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isWhitespace()">isWhitespace</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isWhitespace(int)">isWhitespace</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseBoolean()">parseBoolean</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseCOSArray()">parseCOSArray</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseCOSDictionary()">parseCOSDictionary</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseCOSName()">parseCOSName</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseCOSString()">parseCOSString</a>, <a href="../../../../org/apach
e/pdfbox/pdfparser/BaseParser.html#parseDirObject()">parseDirObject</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseObjectKey(boolean)">parseObjectKey</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readExpectedChar(char)">readExpectedChar</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readExpectedString(char[], boolean)">readExpectedString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readExpectedString(java.lang.String)">readExpectedString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readGenerationNumber()">readGenerationNumber</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readInt()">readInt</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readLine()">readLine</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readLong()">readLong</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html
#readObjectNumber()">readObjectNumber</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readString()">readString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readString(int)">readString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readStringNumber()">readStringNumber</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readUntilEndStream(java.io.OutputStream)">readUntilEndStream</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#skipSpaces()">skipSpaces</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#skipToNextObj()">skipToNextObj</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
@@ -317,320 +311,284 @@ extends <a href="../../../../org/apache/
<div class="details">
<ul class="blockList">
<li class="blockList">
-<!-- ============ FIELD DETAIL =========== -->
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
-<li class="blockList"><a name="field_detail">
+<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
-<h3>Field Detail</h3>
-<a name="isFDFDocment">
+<h3>Constructor Detail</h3>
+<a name="PDFParser(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>isFDFDocment</h4>
-<pre>protected boolean isFDFDocment</pre>
+<h4>PDFParser</h4>
+<pre>public PDFParser(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filename)
+ throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Constructs parser for given file using memory buffer.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filename</code> - the filename of the pdf to be parsed</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If something went wrong.</dd></dl>
</li>
</ul>
-<a name="FORCE_PARSING">
+<a name="PDFParser(java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>FORCE_PARSING</h4>
-<pre>public static final boolean FORCE_PARSING</pre>
-<div class="block">Default value of the <a href="../../../../org/apache/pdfbox/pdfparser/PDFParser.html#forceParsing"><code>forceParsing</code></a> flag.</div>
+<h4>PDFParser</h4>
+<pre>public PDFParser(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filename,
+ boolean useScratchFiles)
+ throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Constructs parser for given file using memory buffer.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filename</code> - the filename of the pdf to be parsed.</dd><dd><code>useScratchFiles</code> - use a buffer for temporary storage.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If something went wrong.</dd></dl>
</li>
</ul>
-<a name="xrefTrailerResolver">
+<a name="PDFParser(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>xrefTrailerResolver</h4>
-<pre>protected <a href="../../../../org/apache/pdfbox/pdfparser/XrefTrailerResolver.html" title="class in org.apache.pdfbox.pdfparser">XrefTrailerResolver</a> xrefTrailerResolver</pre>
-<div class="block">Collects all Xref/trailer objects and resolves them into single
- object using startxref reference.</div>
-</li>
-</ul>
-<a name="forceParsing">
-<!-- -->
-</a>
-<ul class="blockListLast">
-<li class="blockList">
-<h4>forceParsing</h4>
-<pre>protected final boolean forceParsing</pre>
-<div class="block">Flag to skip malformed or otherwise unparseable input where possible.</div>
-</li>
-</ul>
+<h4>PDFParser</h4>
+<pre>public PDFParser(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)
+ throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Constructs parser for given file using given buffer for temporary
+ storage.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - the pdf to be parsed</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If something went wrong.</dd></dl>
</li>
</ul>
-<!-- ========= CONSTRUCTOR DETAIL ======== -->
-<ul class="blockList">
-<li class="blockList"><a name="constructor_detail">
-<!-- -->
-</a>
-<h3>Constructor Detail</h3>
-<a name="PDFParser(java.io.InputStream)">
+<a name="PDFParser(java.io.File, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PDFParser</h4>
-<pre>public PDFParser(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input)
+<pre>public PDFParser(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file,
+ boolean useScratchFiles)
throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<div class="block">Constructor.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code> - The input stream that contains the PDF document.</dd>
+<div class="block">Constructs parser for given file using given buffer for temporary
+ storage.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - the pdf to be parsed</dd><dd><code>useScratchFiles</code> - use a buffer for temporary storage.</dd>
<dt><span class="strong">Throws:</span></dt>
-<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If there is an error initializing the stream.</dd></dl>
+<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If something went wrong.</dd></dl>
</li>
</ul>
-<a name="PDFParser(java.io.InputStream, boolean)">
+<a name="PDFParser(java.io.File, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PDFParser</h4>
-<pre>public PDFParser(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input,
- boolean force)
+<pre>public PDFParser(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> decryptionPassword)
throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<div class="block">Constructor to allow control over RandomAccessFile.
- Also enables parser to skip corrupt objects to try and force parsing</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code> - The input stream that contains the PDF document.</dd><dd><code>force</code> - When true, the parser will skip corrupt pdf objects and
- will continue parsing at the next object in the file</dd>
+<div class="block">Constructs parser for given file using given buffer for temporary storage.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - the pdf to be parsed</dd><dd><code>decryptionPassword</code> - password to be used for decryption</dd>
<dt><span class="strong">Throws:</span></dt>
-<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If there is an error initializing the stream.</dd></dl>
+<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If something went wrong.</dd></dl>
</li>
</ul>
-<a name="PDFParser(java.io.InputStream, boolean, boolean)">
+<a name="PDFParser(java.io.File, java.lang.String, boolean)">
<!-- -->
</a>
-<ul class="blockListLast">
+<ul class="blockList">
<li class="blockList">
<h4>PDFParser</h4>
-<pre>public PDFParser(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input,
- boolean force,
+<pre>public PDFParser(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> decryptionPassword,
boolean useScratchFiles)
throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<div class="block">Constructor to allow control over RandomAccessFile.
- Also enables parser to skip corrupt objects to try and force parsing</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code> - The input stream that contains the PDF document.</dd><dd><code>force</code> - When true, the parser will skip corrupt pdf objects and
- will continue parsing at the next object in the file</dd><dd><code>useScratchFiles</code> - enables the usage of a scratch file if set to true</dd>
+<div class="block">Constructs parser for given file using given buffer for temporary storage.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - the pdf to be parsed.</dd><dd><code>decryptionPassword</code> - password to be used for decryption.</dd><dd><code>useScratchFiles</code> - use a buffer for temporary storage.</dd>
<dt><span class="strong">Throws:</span></dt>
-<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If there is an error initializing the stream.</dd></dl>
+<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If something went wrong.</dd></dl>
</li>
</ul>
-</li>
-</ul>
-<!-- ============ METHOD DETAIL ========== -->
-<ul class="blockList">
-<li class="blockList"><a name="method_detail">
-<!-- -->
-</a>
-<h3>Method Detail</h3>
-<a name="setTempDirectory(java.io.File)">
+<a name="PDFParser(java.io.File, java.lang.String, java.io.InputStream, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>setTempDirectory</h4>
-<pre>public void setTempDirectory(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> tmpDir)</pre>
-<div class="block">This is the directory where pdfbox will create a temporary file
- for storing pdf document stream in. By default this directory will
- be the value of the system property java.io.tmpdir.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tmpDir</code> - The directory to create scratch files needed to store
- pdf document streams.</dd></dl>
-</li>
-</ul>
-<a name="isContinueOnError(java.lang.Exception)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>isContinueOnError</h4>
-<pre>protected boolean isContinueOnError(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a> e)</pre>
-<div class="block">Returns true if parsing should be continued. By default, forceParsing is returned.
- This can be overridden to add application specific handling (for example to stop
- parsing when the number of exceptions thrown exceed a certain number).</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - The exception if vailable. Can be null if there is no exception available</dd>
-<dt><span class="strong">Returns:</span></dt><dd>true if parsing could be continued, otherwise false</dd></dl>
+<h4>PDFParser</h4>
+<pre>public PDFParser(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> decryptionPassword,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> keyStore,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> alias)
+ throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Constructs parser for given file using given buffer for temporary storage.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - the pdf to be parsed.</dd><dd><code>decryptionPassword</code> - password to be used for decryption.</dd><dd><code>keyStore</code> - key store to be used for decryption when using public key security</dd><dd><code>alias</code> - alias to be used for decryption when using public key security</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If something went wrong.</dd></dl>
</li>
</ul>
-<a name="parse()">
+<a name="PDFParser(java.io.File, java.lang.String, java.io.InputStream, java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>parse</h4>
-<pre>public void parse()
- throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<div class="block">This will parse the stream and populate the COSDocument object. This will close
- the stream when it is done parsing.</div>
-<dl><dt><span class="strong">Throws:</span></dt>
-<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If there is an error reading from the stream or corrupt data
- is found.</dd></dl>
+<h4>PDFParser</h4>
+<pre>public PDFParser(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> decryptionPassword,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> keyStore,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> alias,
+ boolean useScratchFiles)
+ throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Constructs parser for given file using given buffer for temporary storage.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - the pdf to be parsed.</dd><dd><code>decryptionPassword</code> - password to be used for decryption.</dd><dd><code>keyStore</code> - key store to be used for decryption when using public key security</dd><dd><code>alias</code> - alias to be used for decryption when using public key security</dd><dd><code>useScratchFiles</code> - use a buffer for temporary storage.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If something went wrong.</dd></dl>
</li>
</ul>
-<a name="parseHeader()">
+<a name="PDFParser(java.io.InputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>parseHeader</h4>
-<pre>protected void parseHeader()
- throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<dl><dt><span class="strong">Throws:</span></dt>
-<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
+<h4>PDFParser</h4>
+<pre>public PDFParser(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input)
+ throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Constructor.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code> - input stream representing the pdf.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If something went wrong.</dd></dl>
</li>
</ul>
-<a name="getDocument()">
+<a name="PDFParser(java.io.InputStream, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>getDocument</h4>
-<pre>public <a href="../../../../org/apache/pdfbox/cos/COSDocument.html" title="class in org.apache.pdfbox.cos">COSDocument</a> getDocument()
- throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<div class="block">This will get the document that was parsed. parse() must be called before this is called.
- When you are done with this document you must call close() on it to release
- resources.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>The document that was parsed.</dd>
+<h4>PDFParser</h4>
+<pre>public PDFParser(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input,
+ boolean useScratchFiles)
+ throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Constructor.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code> - input stream representing the pdf.</dd><dd><code>useScratchFiles</code> - use a buffer for temporary storage.</dd>
<dt><span class="strong">Throws:</span></dt>
-<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If there is an error getting the document.</dd></dl>
+<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If something went wrong.</dd></dl>
</li>
</ul>
-<a name="getPDDocument()">
+<a name="PDFParser(java.io.InputStream, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>getPDDocument</h4>
-<pre>public <a href="../../../../org/apache/pdfbox/pdmodel/PDDocument.html" title="class in org.apache.pdfbox.pdmodel">PDDocument</a> getPDDocument()
- throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<div class="block">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.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>The document at the PD layer.</dd>
+<h4>PDFParser</h4>
+<pre>public PDFParser(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> decryptionPassword)
+ throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Constructor.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code> - input stream representing the pdf.</dd><dd><code>decryptionPassword</code> - password to be used for decryption.</dd>
<dt><span class="strong">Throws:</span></dt>
-<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If there is an error getting the document.</dd></dl>
+<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If something went wrong.</dd></dl>
</li>
</ul>
-<a name="getFDFDocument()">
+<a name="PDFParser(java.io.InputStream, java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>getFDFDocument</h4>
-<pre>public <a href="../../../../org/apache/pdfbox/pdmodel/fdf/FDFDocument.html" title="class in org.apache.pdfbox.pdmodel.fdf">FDFDocument</a> getFDFDocument()
- throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<div class="block">This will get the FDF document that was parsed. When you are done with
- this document you must call close() on it to release resources.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>The document at the PD layer.</dd>
+<h4>PDFParser</h4>
+<pre>public PDFParser(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> decryptionPassword,
+ boolean useScratchFiles)
+ throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Constructor.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code> - input stream representing the pdf.</dd><dd><code>decryptionPassword</code> - password to be used for decryption.</dd><dd><code>useScratchFiles</code> - use a buffer for temporary storage.</dd>
<dt><span class="strong">Throws:</span></dt>
-<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If there is an error getting the document.</dd></dl>
+<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If something went wrong.</dd></dl>
</li>
</ul>
-<a name="parseStartXref()">
+<a name="PDFParser(java.io.InputStream, java.lang.String, java.io.InputStream, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>parseStartXref</h4>
-<pre>protected boolean parseStartXref()
- throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<div class="block">This will parse the startxref section from the stream.
- The startxref value is ignored.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>false on parsing error</dd>
+<h4>PDFParser</h4>
+<pre>public PDFParser(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> decryptionPassword,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> keyStore,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> alias)
+ throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Constructor.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code> - input stream representing the pdf.</dd><dd><code>decryptionPassword</code> - password to be used for decryption.</dd><dd><code>keyStore</code> - key store to be used for decryption when using public key security</dd><dd><code>alias</code> - alias to be used for decryption when using public key security</dd>
<dt><span class="strong">Throws:</span></dt>
-<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an IO error occurs.</dd></dl>
+<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If something went wrong.</dd></dl>
</li>
</ul>
-<a name="parseXrefTable(long)">
+<a name="PDFParser(java.io.InputStream, java.lang.String, java.io.InputStream, java.lang.String, boolean)">
<!-- -->
</a>
-<ul class="blockList">
+<ul class="blockListLast">
<li class="blockList">
-<h4>parseXrefTable</h4>
-<pre>protected boolean parseXrefTable(long startByteOffset)
- throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<div class="block">This will parse the xref table from the stream and add it to the state
- The XrefTable contents are ignored.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>startByteOffset</code> - the offset to start at</dd>
-<dt><span class="strong">Returns:</span></dt><dd>false on parsing error</dd>
+<h4>PDFParser</h4>
+<pre>public PDFParser(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> input,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> decryptionPassword,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> keyStore,
+ <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> alias,
+ boolean useScratchFiles)
+ throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Constructor.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code> - input stream representing the pdf.</dd><dd><code>decryptionPassword</code> - password to be used for decryption.</dd><dd><code>keyStore</code> - key store to be used for decryption when using public key security</dd><dd><code>alias</code> - alias to be used for decryption when using public key security</dd><dd><code>useScratchFiles</code> - use a buffer for temporary storage.</dd>
<dt><span class="strong">Throws:</span></dt>
-<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an IO error occurs.</dd></dl>
+<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If something went wrong.</dd></dl>
</li>
</ul>
-<a name="parseTrailer()">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>parseTrailer</h4>
-<pre>protected boolean parseTrailer()
- throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<div class="block">This will parse the trailer from the stream and add it to the state.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>false on parsing error</dd>
-<dt><span class="strong">Throws:</span></dt>
-<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an IO error occurs.</dd></dl>
</li>
</ul>
-<a name="readVersionInTrailer(org.apache.pdfbox.cos.COSDictionary)">
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
<!-- -->
</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>readVersionInTrailer</h4>
-<pre>protected void readVersionInTrailer(<a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> parsedTrailer)</pre>
-<div class="block">The document catalog can also have a /Version parameter which overrides the version specified
- in the header if, and only if it is greater.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parsedTrailer</code> - the parsed catalog in the trailer</dd></dl>
-</li>
-</ul>
-<a name="parseXrefStream(org.apache.pdfbox.cos.COSStream, long)">
+<h3>Method Detail</h3>
+<a name="getPDDocument()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>parseXrefStream</h4>
-<pre>public void parseXrefStream(<a href="../../../../org/apache/pdfbox/cos/COSStream.html" title="class in org.apache.pdfbox.cos">COSStream</a> stream,
- long objByteOffset)
- throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<div class="block">Fills XRefTrailerResolver with data of given stream.
- Stream must be of type XRef.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - the stream to be read</dd><dd><code>objByteOffset</code> - the offset to start at</dd>
+<h4>getPDDocument</h4>
+<pre>public <a href="../../../../org/apache/pdfbox/pdmodel/PDDocument.html" title="class in org.apache.pdfbox.pdmodel">PDDocument</a> getPDDocument()
+ throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">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.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The document at the PD layer.</dd>
<dt><span class="strong">Throws:</span></dt>
-<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if there is an error parsing the stream</dd></dl>
+<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If there is an error getting the document.</dd></dl>
</li>
</ul>
-<a name="parseXrefStream(org.apache.pdfbox.cos.COSStream, long, boolean)">
+<a name="initialParse()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>parseXrefStream</h4>
-<pre>public void parseXrefStream(<a href="../../../../org/apache/pdfbox/cos/COSStream.html" title="class in org.apache.pdfbox.cos">COSStream</a> stream,
- long objByteOffset,
- boolean isStandalone)
+<h4>initialParse</h4>
+<pre>protected void initialParse()
throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<div class="block">Fills XRefTrailerResolver with data of given stream.
- Stream must be of type XRef.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - the stream to be read</dd><dd><code>objByteOffset</code> - the offset to start at</dd><dd><code>isStandalone</code> - should be set to true if the stream is not part of a hybrid xref table</dd>
-<dt><span class="strong">Throws:</span></dt>
-<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if there is an error parsing the stream</dd></dl>
+<div class="block">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.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If something went wrong.</dd></dl>
</li>
</ul>
-<a name="clearResources()">
+<a name="parse()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
-<h4>clearResources</h4>
-<pre>public void clearResources()</pre>
-<div class="block">Release all used resources.</div>
-<dl>
-<dt><strong>Overrides:</strong></dt>
-<dd><code><a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#clearResources()">clearResources</a></code> in class <code><a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html" title="class in org.apache.pdfbox.pdfparser">BaseParser</a></code></dd>
-</dl>
+<h4>parse</h4>
+<pre>public void parse()
+ throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">This will parse the stream and populate the COSDocument object. This will close
+ the stream when it is done parsing.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If there is an error reading from the stream or corrupt data
+ is found.</dd></dl>
</li>
</ul>
</li>
@@ -685,13 +643,13 @@ extends <a href="../../../../org/apache/
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
-<li><a href="#field_summary">Field</a> | </li>
+<li><a href="#fields_inherited_from_class_org.apache.pdfbox.pdfparser.COSParser">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
-<li><a href="#field_detail">Field</a> | </li>
+<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
Modified: websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdfparser/PDFStreamParser.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdfparser/PDFStreamParser.html (original)
+++ websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/pdfparser/PDFStreamParser.html Mon Mar 30 05:53:07 2015
@@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="de">
<head>
-<!-- Generated by javadoc (version 1.7.0_55) on Sun Jan 04 20:50:33 CET 2015 -->
+<!-- Generated by javadoc (version 1.7.0_55) on Mon Mar 30 07:21:56 CEST 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>PDFStreamParser (Apache PDFBox 2.0.0-SNAPSHOT API)</title>
-<meta name="date" content="2015-01-04">
+<meta name="date" content="2015-03-30">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -100,6 +100,10 @@
<div class="description">
<ul class="blockList">
<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
+</dl>
<hr>
<br>
<pre>public class <span class="strong">PDFStreamParser</span>
@@ -124,7 +128,7 @@ extends <a href="../../../../org/apache/
<!-- -->
</a>
<h3>Fields inherited from class org.apache.pdfbox.pdfparser.<a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html" title="class in org.apache.pdfbox.pdfparser">BaseParser</a></h3>
-<code><a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#DEF">DEF</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#document">document</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#ENDOBJ">ENDOBJ</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#ENDSTREAM">ENDSTREAM</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#pdfSource">pdfSource</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#PROP_PUSHBACK_SIZE">PROP_PUSHBACK_SIZE</a></code></li>
+<code><a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#ASCII_CR">ASCII_CR</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#ASCII_LF">ASCII_LF</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#DEF">DEF</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#document">document</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#ENDOBJ">ENDOBJ</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#ENDOBJ_STRING">ENDOBJ_STRING</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#ENDSTREAM">ENDSTREAM</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#ENDSTREAM_STRING">ENDSTREAM_STRING</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#ISO_8859_1">ISO_8859_1</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#pdfSource">pdfSource</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#PROP_PUSHBACK_SI
ZE">PROP_PUSHBACK_SIZE</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#STREAM_STRING">STREAM_STRING</a></code></li>
</ul>
</li>
</ul>
@@ -170,18 +174,6 @@ extends <a href="../../../../org/apache/
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFStreamParser.html#clearResources()">clearResources</a></strong>()</code>
-<div class="block">Release all used resources.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFStreamParser.html#close()">close</a></strong>()</code>
-<div class="block">This will close the underlying pdfSource object.</div>
-</td>
-</tr>
-<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/pdfparser/PDFStreamParser.html#getTokenIterator()">getTokenIterator</a></strong>()</code>
<div class="block">This will get an iterator which can be used to parse the stream
@@ -212,7 +204,7 @@ extends <a href="../../../../org/apache/
<!-- -->
</a>
<h3>Methods inherited from class org.apache.pdfbox.pdfparser.<a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html" title="class in org.apache.pdfbox.pdfparser">BaseParser</a></h3>
-<code><a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#createCOSStream(org.apache.pdfbox.cos.COSDictionary)">createCOSStream</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isClosing()">isClosing</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isClosing(int)">isClosing</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isEndOfName(char)">isEndOfName</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isEOL()">isEOL</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isEOL(int)">isEOL</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isWhitespace()">isWhitespace</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isWhitespace(int)">isWhitespace</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseBoolean()">parseBoolean</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseCOSArray()">parseC
OSArray</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseCOSDictionary()">parseCOSDictionary</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseCOSName()">parseCOSName</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseCOSStream(org.apache.pdfbox.cos.COSDictionary)">parseCOSStream</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseCOSString()">parseCOSString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseCOSString(boolean)">parseCOSString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseDirObject()">parseDirObject</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseObjectKey(boolean)">parseObjectKey</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readExpectedChar(char)">readExpectedChar</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readExpectedString(java.lang.Strin
g)">readExpectedString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readGenerationNumber()">readGenerationNumber</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readInt()">readInt</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readLine()">readLine</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readLong()">readLong</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readObjectNumber()">readObjectNumber</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readString()">readString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readString(int)">readString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readStringNumber()">readStringNumber</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readUntilEndStream(java.io.OutputStream)">readUntilEndStream</a>, <a href="../../../../org/apache/pdfbox/pdfpar
ser/BaseParser.html#setDocument(org.apache.pdfbox.cos.COSDocument)">setDocument</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#skipSpaces()">skipSpaces</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#skipToNextObj()">skipToNextObj</a></code></li>
+<code><a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#close()">close</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#createCOSStream(org.apache.pdfbox.cos.COSDictionary)">createCOSStream</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isClosing()">isClosing</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isClosing(int)">isClosing</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isDigit()">isDigit</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isDigit(int)">isDigit</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isEndOfName(char)">isEndOfName</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isEOL()">isEOL</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isEOL(int)">isEOL</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isSpace()">isSpace</a>, <a href="../../../../org/apache/p
dfbox/pdfparser/BaseParser.html#isSpace(int)">isSpace</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isString(byte[])">isString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isString(char[])">isString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isWhitespace()">isWhitespace</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#isWhitespace(int)">isWhitespace</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseBoolean()">parseBoolean</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseCOSArray()">parseCOSArray</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseCOSDictionary()">parseCOSDictionary</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseCOSName()">parseCOSName</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseCOSStream(org.apache.pdfbox.cos.COSDictionary)">parseCOSStream<
/a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseCOSString()">parseCOSString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseDirObject()">parseDirObject</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#parseObjectKey(boolean)">parseObjectKey</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readExpectedChar(char)">readExpectedChar</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readExpectedString(char[], boolean)">readExpectedString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readExpectedString(java.lang.String)">readExpectedString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readGenerationNumber()">readGenerationNumber</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readInt()">readInt</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readLine()">readLine</a>, <a href="../../..
/../org/apache/pdfbox/pdfparser/BaseParser.html#readLong()">readLong</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readObjectNumber()">readObjectNumber</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readString()">readString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readString(int)">readString</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readStringNumber()">readStringNumber</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#readUntilEndStream(java.io.OutputStream)">readUntilEndStream</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#skipSpaces()">skipSpaces</a>, <a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#skipToNextObj()">skipToNextObj</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
@@ -310,19 +302,6 @@ extends <a href="../../../../org/apache/
<dl><dt><span class="strong">Returns:</span></dt><dd>All of the tokens in the stream.</dd></dl>
</li>
</ul>
-<a name="close()">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>close</h4>
-<pre>public void close()
- throws <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<div class="block">This will close the underlying pdfSource object.</div>
-<dl><dt><span class="strong">Throws:</span></dt>
-<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If there is an error releasing resources.</dd></dl>
-</li>
-</ul>
<a name="getTokenIterator()">
<!-- -->
</a>
@@ -338,7 +317,7 @@ extends <a href="../../../../org/apache/
<a name="readOperator()">
<!-- -->
</a>
-<ul class="blockList">
+<ul class="blockListLast">
<li class="blockList">
<h4>readOperator</h4>
<pre>protected <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> readOperator()
@@ -349,20 +328,6 @@ extends <a href="../../../../org/apache/
<dd><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If there is an error reading from the stream.</dd></dl>
</li>
</ul>
-<a name="clearResources()">
-<!-- -->
-</a>
-<ul class="blockListLast">
-<li class="blockList">
-<h4>clearResources</h4>
-<pre>public void clearResources()</pre>
-<div class="block">Release all used resources.</div>
-<dl>
-<dt><strong>Overrides:</strong></dt>
-<dd><code><a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html#clearResources()">clearResources</a></code> in class <code><a href="../../../../org/apache/pdfbox/pdfparser/BaseParser.html" title="class in org.apache.pdfbox.pdfparser">BaseParser</a></code></dd>
-</dl>
-</li>
-</ul>
</li>
</ul>
</li>