You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ms...@apache.org on 2015/11/16 20:21:31 UTC
[32/51] [partial] pdfbox-docs git commit: Site checkin for project
Apache PDFBox Website
http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/3ca1d144/content/docs/1.8.10/javadocs/org/apache/pdfbox/cos/COSDocument.html
----------------------------------------------------------------------
diff --git a/content/docs/1.8.10/javadocs/org/apache/pdfbox/cos/COSDocument.html b/content/docs/1.8.10/javadocs/org/apache/pdfbox/cos/COSDocument.html
new file mode 100644
index 0000000..e4c4c1f
--- /dev/null
+++ b/content/docs/1.8.10/javadocs/org/apache/pdfbox/cos/COSDocument.html
@@ -0,0 +1,1094 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="de">
+<head>
+<!-- Generated by javadoc (version 1.7.0_55) on Wed Aug 19 15:27:37 CEST 2015 -->
+<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
+<title>COSDocument (Apache PDFBox 1.8.10 API)</title>
+<meta name="date" content="2015-08-19">
+<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="COSDocument (Apache PDFBox 1.8.10 API)";
+ }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar_top">
+<!-- -->
+</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/COSDocument.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../index-all.html">Index</a></li>
+<li><a href="../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../org/apache/pdfbox/cos/COSDictionaryLateBinding.html" title="class in org.apache.pdfbox.cos"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/pdfbox/cos/COSFloat.html" title="class in org.apache.pdfbox.cos"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/pdfbox/cos/COSDocument.html" target="_top">Frames</a></li>
+<li><a href="COSDocument.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li>Field | </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>Field | </li>
+<li><a href="#constructor_detail">Constr</a> | </li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">org.apache.pdfbox.cos</div>
+<h2 title="Class COSDocument" class="title">Class COSDocument</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
+<li>
+<ul class="inheritance">
+<li><a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">org.apache.pdfbox.cos.COSBase</a></li>
+<li>
+<ul class="inheritance">
+<li>org.apache.pdfbox.cos.COSDocument</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd><a href="http://download.oracle.com/javase/1.5.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.5.0/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="../../../../org/apache/pdfbox/pdmodel/common/COSObjectable.html" title="interface in org.apache.pdfbox.pdmodel.common">COSObjectable</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="strong">COSDocument</span>
+extends <a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a>
+implements <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></pre>
+<div class="block">This is the in-memory representation of the PDF document. You need to call
+ close() on this object when you are done using it!!</div>
+<dl><dt><span class="strong">Author:</span></dt>
+ <dd><a href="ben@benlitchfield.com">Ben Litchfield</a></dd></dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor_summary">
+<!-- -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#COSDocument()">COSDocument</a></strong>()</code>
+<div class="block">Constructor.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#COSDocument(java.io.File)">COSDocument</a></strong>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> scratchDir)</code>
+<div class="block">Constructor that will create a create a scratch file in the
+ following directory.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#COSDocument(java.io.File, boolean)">COSDocument</a></strong>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> scratchDir,
+ boolean forceParsingValue)</code>
+<div class="block">Constructor that will use a temporary file in the given directory
+ for storage of the PDF streams.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#COSDocument(org.apache.pdfbox.io.RandomAccess)">COSDocument</a></strong>(<a href="../../../../org/apache/pdfbox/io/RandomAccess.html" title="interface in org.apache.pdfbox.io">RandomAccess</a> file)</code>
+<div class="block">Constructor that will use the following random access file for storage
+ of the PDF streams.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#COSDocument(org.apache.pdfbox.io.RandomAccess, boolean)">COSDocument</a></strong>(<a href="../../../../org/apache/pdfbox/io/RandomAccess.html" title="interface in org.apache.pdfbox.io">RandomAccess</a> scratchFileValue,
+ boolean forceParsingValue)</code>
+<div class="block">Constructor that will use the given random access file for storage
+ of the PDF streams.</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><a href="http://download.oracle.com/javase/1.5.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/cos/COSDocument.html#accept(org.apache.pdfbox.cos.ICOSVisitor)">accept</a></strong>(<a href="../../../../org/apache/pdfbox/cos/ICOSVisitor.html" title="interface in org.apache.pdfbox.cos">ICOSVisitor</a> visitor)</code>
+<div class="block">visitor pattern double dispatch method.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#addXRefTable(java.util.Map)">addXRefTable</a></strong>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../org/apache/pdfbox/persistence/util/COSObjectKey.html" title="class in org.apache.pdfbox.persistence.util">COSObjectKey</a>,<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>> xrefTableValues)</code>
+<div class="block">Populate XRef HashMap with given values.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#close()">close</a></strong>()</code>
+<div class="block">This will close all storage and delete the tmp files.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/cos/COSStream.html" title="class in org.apache.pdfbox.cos">COSStream</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#createCOSStream()">createCOSStream</a></strong>()</code>
+<div class="block">Create a new COSStream using the underlying scratch file.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/cos/COSStream.html" title="class in org.apache.pdfbox.cos">COSStream</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#createCOSStream(org.apache.pdfbox.cos.COSDictionary)">createCOSStream</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> dictionary)</code>
+<div class="block">Create a new COSStream using the underlying scratch file.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#dereferenceObjectStreams()">dereferenceObjectStreams</a></strong>()</code>
+<div class="block">This method will search the list of objects for types of ObjStm.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#finalize()">finalize</a></strong>()</code>
+<div class="block">Warn the user in the finalizer if he didn't close the PDF document.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/cos/COSObject.html" title="class in org.apache.pdfbox.cos">COSObject</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#getCatalog()">getCatalog</a></strong>()</code>
+<div class="block">This will get the document catalog.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/cos/COSArray.html" title="class in org.apache.pdfbox.cos">COSArray</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#getDocumentID()">getDocumentID</a></strong>()</code>
+<div class="block">This will get the document ID.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#getEncryptionDictionary()">getEncryptionDictionary</a></strong>()</code>
+<div class="block">This will get the encryption dictionary if the document is encrypted or null
+ if the document is not encrypted.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#getHeaderString()">getHeaderString</a></strong>()</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/cos/COSObject.html" title="class in org.apache.pdfbox.cos">COSObject</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#getObjectByType(org.apache.pdfbox.cos.COSName)">getObjectByType</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> type)</code>
+<div class="block">This will get the first dictionary object by type.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/cos/COSObject.html" title="class in org.apache.pdfbox.cos">COSObject</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#getObjectByType(java.lang.String)">getObjectByType</a></strong>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type)</code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>use <a href="../../../../org/apache/pdfbox/cos/COSDocument.html#getObjectByType(org.apache.pdfbox.cos.COSName)"><code>getObjectByType(COSName)</code></a> instead</i></div>
+</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/cos/COSObject.html" title="class in org.apache.pdfbox.cos">COSObject</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#getObjectFromPool(org.apache.pdfbox.persistence.util.COSObjectKey)">getObjectFromPool</a></strong>(<a href="../../../../org/apache/pdfbox/persistence/util/COSObjectKey.html" title="class in org.apache.pdfbox.persistence.util">COSObjectKey</a> key)</code>
+<div class="block">This will get an object from the pool.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/pdfbox/cos/COSObject.html" title="class in org.apache.pdfbox.cos">COSObject</a>></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#getObjects()">getObjects</a></strong>()</code>
+<div class="block">This will get a list of all available objects.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/pdfbox/cos/COSObject.html" title="class in org.apache.pdfbox.cos">COSObject</a>></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#getObjectsByType(org.apache.pdfbox.cos.COSName)">getObjectsByType</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> type)</code>
+<div class="block">This will get a dictionary object by type.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/pdfbox/cos/COSObject.html" title="class in org.apache.pdfbox.cos">COSObject</a>></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#getObjectsByType(java.lang.String)">getObjectsByType</a></strong>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type)</code>
+<div class="block">This will get all dictionary objects by type.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/io/RandomAccess.html" title="interface in org.apache.pdfbox.io">RandomAccess</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#getScratchFile()">getScratchFile</a></strong>()</code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>direct access to the scratch file will be removed</i></div>
+</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a>></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#getSignatureDictionaries()">getSignatureDictionaries</a></strong>()</code>
+<div class="block">This will return a list of signature dictionaries as COSDictionary.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a>></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#getSignatureFields(boolean)">getSignatureFields</a></strong>(boolean onlyEmptyFields)</code>
+<div class="block">This will return a list of signature fields.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/pdmodel/interactive/digitalsignature/SignatureInterface.html" title="interface in org.apache.pdfbox.pdmodel.interactive.digitalsignature">SignatureInterface</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#getSignatureInterface()">getSignatureInterface</a></strong>()</code>
+<div class="block">This will return the signature interface.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>long</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#getStartXref()">getStartXref</a></strong>()</code>
+<div class="block">Return the startXref Position of the parsed document.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#getTrailer()">getTrailer</a></strong>()</code>
+<div class="block">This will get the document trailer.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>float</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#getVersion()">getVersion</a></strong>()</code>
+<div class="block">This will get the version of this PDF document.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../org/apache/pdfbox/persistence/util/COSObjectKey.html" title="class in org.apache.pdfbox.persistence.util">COSObjectKey</a>,<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#getXrefTable()">getXrefTable</a></strong>()</code>
+<div class="block">Returns the xrefTable which is a mapping of ObjectKeys
+ to byte offsets in the file.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#isDecrypted()">isDecrypted</a></strong>()</code>
+<div class="block">Indicates if a encrypted pdf is already decrypted after parsing.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#isEncrypted()">isEncrypted</a></strong>()</code>
+<div class="block">This will tell if this is an encrypted document.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#isXRefStream()">isXRefStream</a></strong>()</code>
+<div class="block">Determines it the trailer is a XRef stream or not.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#print()">print</a></strong>()</code>
+<div class="block">This will print contents to stdout.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/cos/COSObject.html" title="class in org.apache.pdfbox.cos">COSObject</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#removeObject(org.apache.pdfbox.persistence.util.COSObjectKey)">removeObject</a></strong>(<a href="../../../../org/apache/pdfbox/persistence/util/COSObjectKey.html" title="class in org.apache.pdfbox.persistence.util">COSObjectKey</a> key)</code>
+<div class="block">Removes an object from the object pool.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#setDecrypted()">setDecrypted</a></strong>()</code>
+<div class="block">Signals that the document is decrypted completely.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#setDocumentID(org.apache.pdfbox.cos.COSArray)">setDocumentID</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSArray.html" title="class in org.apache.pdfbox.cos">COSArray</a> id)</code>
+<div class="block">This will set the document ID.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#setEncryptionDictionary(org.apache.pdfbox.cos.COSDictionary)">setEncryptionDictionary</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> encDictionary)</code>
+<div class="block">This will set the encryption dictionary, this should only be called when
+ encrypting the document.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#setHeaderString(java.lang.String)">setHeaderString</a></strong>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> header)</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#setSignatureInterface(org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureInterface)">setSignatureInterface</a></strong>(<a href="../../../../org/apache/pdfbox/pdmodel/interactive/digitalsignature/SignatureInterface.html" title="interface in org.apache.pdfbox.pdmodel.interactive.digitalsignature">SignatureInterface</a> sigInterface)</code>
+<div class="block">Set the signature interface to the given value.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#setStartXref(long)">setStartXref</a></strong>(long startXrefValue)</code>
+<div class="block">This method set the startxref value of the document.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#setTrailer(org.apache.pdfbox.cos.COSDictionary)">setTrailer</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> newTrailer)</code>
+<div class="block">// MIT added, maybe this should not be supported as trailer is a persistence construct.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#setVersion(float)">setVersion</a></strong>(float versionValue)</code>
+<div class="block">This will set the version of this PDF document.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#setWarnMissingClose(boolean)">setWarnMissingClose</a></strong>(boolean warn)</code>
+<div class="block">Controls whether this instance shall issue a warning if the PDF document wasn't closed
+ properly through a call to the <a href="../../../../org/apache/pdfbox/cos/COSDocument.html#close()"><code>close()</code></a> method.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_org.apache.pdfbox.cos.COSBase">
+<!-- -->
+</a>
+<h3>Methods inherited from class org.apache.pdfbox.cos.<a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a></h3>
+<code><a href="../../../../org/apache/pdfbox/cos/COSBase.html#getCOSObject()">getCOSObject</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#getFilterManager()">getFilterManager</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#isDirect()">isDirect</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#isNeedToBeUpdate()">isNeedToBeUpdate</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#setDirect(boolean)">setDirect</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#setNeedToBeUpdate(boolean)">setNeedToBeUpdate</a></code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
+<!-- -->
+</a>
+<h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
+<code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="
http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor_detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="COSDocument(org.apache.pdfbox.io.RandomAccess, boolean)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>COSDocument</h4>
+<pre>public COSDocument(<a href="../../../../org/apache/pdfbox/io/RandomAccess.html" title="interface in org.apache.pdfbox.io">RandomAccess</a> scratchFileValue,
+ boolean forceParsingValue)</pre>
+<div class="block">Constructor that will use the given random access file for storage
+ of the PDF streams. The client of this method is responsible for
+ deleting the storage if necessary that this file will write to. The
+ close method will close the file though.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>scratchFileValue</code> - the random access file to use for storage</dd><dd><code>forceParsingValue</code> - flag to skip malformed or otherwise unparseable
+ document content where possible</dd></dl>
+</li>
+</ul>
+<a name="COSDocument(java.io.File, boolean)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>COSDocument</h4>
+<pre>public COSDocument(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> scratchDir,
+ boolean forceParsingValue)
+ throws <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Constructor that will use a temporary file in the given directory
+ for storage of the PDF streams. The temporary file is automatically
+ removed when this document gets closed.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>scratchDir</code> - directory for the temporary file,
+ or <code>null</code> to use the system default</dd><dd><code>forceParsingValue</code> - flag to skip malformed or otherwise unparseable
+ document content where possible</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.5.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="COSDocument()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>COSDocument</h4>
+<pre>public COSDocument()</pre>
+<div class="block">Constructor. Uses memory to store stream.</div>
+</li>
+</ul>
+<a name="COSDocument(java.io.File)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>COSDocument</h4>
+<pre>public COSDocument(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> scratchDir)
+ throws <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Constructor that will create a create a scratch file in the
+ following directory.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>scratchDir</code> - The directory to store a scratch file.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.5.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 creating the tmp file.</dd></dl>
+</li>
+</ul>
+<a name="COSDocument(org.apache.pdfbox.io.RandomAccess)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>COSDocument</h4>
+<pre>public COSDocument(<a href="../../../../org/apache/pdfbox/io/RandomAccess.html" title="interface in org.apache.pdfbox.io">RandomAccess</a> file)</pre>
+<div class="block">Constructor that will use the following random access file for storage
+ of the PDF streams. The client of this method is responsible for deleting
+ the storage if necessary that this file will write to. The close method
+ will close the file though.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - The random access file to use for storage.</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="getScratchFile()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getScratchFile</h4>
+<pre>public <a href="../../../../org/apache/pdfbox/io/RandomAccess.html" title="interface in org.apache.pdfbox.io">RandomAccess</a> getScratchFile()</pre>
+<div class="block"><span class="strong">Deprecated.</span> <i>direct access to the scratch file will be removed</i></div>
+<div class="block">This will get the scratch file for this document.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The scratch file.</dd></dl>
+</li>
+</ul>
+<a name="createCOSStream()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>createCOSStream</h4>
+<pre>public <a href="../../../../org/apache/pdfbox/cos/COSStream.html" title="class in org.apache.pdfbox.cos">COSStream</a> createCOSStream()</pre>
+<div class="block">Create a new COSStream using the underlying scratch file.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the new COSStream</dd></dl>
+</li>
+</ul>
+<a name="createCOSStream(org.apache.pdfbox.cos.COSDictionary)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>createCOSStream</h4>
+<pre>public <a href="../../../../org/apache/pdfbox/cos/COSStream.html" title="class in org.apache.pdfbox.cos">COSStream</a> createCOSStream(<a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> dictionary)</pre>
+<div class="block">Create a new COSStream using the underlying scratch file.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dictionary</code> - the corresponding dictionary</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the new COSStream</dd></dl>
+</li>
+</ul>
+<a name="getObjectByType(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getObjectByType</h4>
+<pre>public <a href="../../../../org/apache/pdfbox/cos/COSObject.html" title="class in org.apache.pdfbox.cos">COSObject</a> getObjectByType(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type)
+ throws <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block"><span class="strong">Deprecated.</span> <i>use <a href="../../../../org/apache/pdfbox/cos/COSDocument.html#getObjectByType(org.apache.pdfbox.cos.COSName)"><code>getObjectByType(COSName)</code></a> instead</i></div>
+<div class="block">This will get the first dictionary object by type.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - The type of the object.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>This will return an object with the specified type.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.5.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 object</dd></dl>
+</li>
+</ul>
+<a name="getObjectByType(org.apache.pdfbox.cos.COSName)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getObjectByType</h4>
+<pre>public <a href="../../../../org/apache/pdfbox/cos/COSObject.html" title="class in org.apache.pdfbox.cos">COSObject</a> getObjectByType(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> type)
+ throws <a href="http://download.oracle.com/javase/1.5.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 first dictionary object by type.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - The type of the object.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>This will return an object with the specified type.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.5.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 object</dd></dl>
+</li>
+</ul>
+<a name="getObjectsByType(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getObjectsByType</h4>
+<pre>public <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/pdfbox/cos/COSObject.html" title="class in org.apache.pdfbox.cos">COSObject</a>> getObjectsByType(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type)
+ throws <a href="http://download.oracle.com/javase/1.5.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 all dictionary objects by type.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - The type of the object.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>This will return an object with the specified type.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.5.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 object</dd></dl>
+</li>
+</ul>
+<a name="getObjectsByType(org.apache.pdfbox.cos.COSName)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getObjectsByType</h4>
+<pre>public <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/pdfbox/cos/COSObject.html" title="class in org.apache.pdfbox.cos">COSObject</a>> getObjectsByType(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> type)
+ throws <a href="http://download.oracle.com/javase/1.5.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 a dictionary object by type.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - The type of the object.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>This will return an object with the specified type.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.5.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 object</dd></dl>
+</li>
+</ul>
+<a name="print()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>print</h4>
+<pre>public void print()</pre>
+<div class="block">This will print contents to stdout.</div>
+</li>
+</ul>
+<a name="setVersion(float)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setVersion</h4>
+<pre>public void setVersion(float versionValue)</pre>
+<div class="block">This will set the version of this PDF document.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>versionValue</code> - The version of the PDF document.</dd></dl>
+</li>
+</ul>
+<a name="getVersion()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getVersion</h4>
+<pre>public float getVersion()</pre>
+<div class="block">This will get the version of this PDF document.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>This documents version.</dd></dl>
+</li>
+</ul>
+<a name="setDecrypted()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setDecrypted</h4>
+<pre>public void setDecrypted()</pre>
+<div class="block">Signals that the document is decrypted completely.
+ Needed e.g. by <a href="../../../../org/apache/pdfbox/pdfparser/NonSequentialPDFParser.html" title="class in org.apache.pdfbox.pdfparser"><code>NonSequentialPDFParser</code></a> to circumvent
+ additional decryption later on.</div>
+</li>
+</ul>
+<a name="isDecrypted()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isDecrypted</h4>
+<pre>public boolean isDecrypted()</pre>
+<div class="block">Indicates if a encrypted pdf is already decrypted after parsing.
+ Does make sense only if the <a href="../../../../org/apache/pdfbox/pdfparser/NonSequentialPDFParser.html" title="class in org.apache.pdfbox.pdfparser"><code>NonSequentialPDFParser</code></a> is used.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>true indicates that the pdf is decrypted.</dd></dl>
+</li>
+</ul>
+<a name="isEncrypted()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isEncrypted</h4>
+<pre>public boolean isEncrypted()</pre>
+<div class="block">This will tell if this is an encrypted document.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>true If this document is encrypted.</dd></dl>
+</li>
+</ul>
+<a name="getEncryptionDictionary()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getEncryptionDictionary</h4>
+<pre>public <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> getEncryptionDictionary()</pre>
+<div class="block">This will get the encryption dictionary if the document is encrypted or null
+ if the document is not encrypted.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The encryption dictionary.</dd></dl>
+</li>
+</ul>
+<a name="getSignatureInterface()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getSignatureInterface</h4>
+<pre>public <a href="../../../../org/apache/pdfbox/pdmodel/interactive/digitalsignature/SignatureInterface.html" title="interface in org.apache.pdfbox.pdmodel.interactive.digitalsignature">SignatureInterface</a> getSignatureInterface()</pre>
+<div class="block">This will return the signature interface.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the signature interface</dd></dl>
+</li>
+</ul>
+<a name="setEncryptionDictionary(org.apache.pdfbox.cos.COSDictionary)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setEncryptionDictionary</h4>
+<pre>public void setEncryptionDictionary(<a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> encDictionary)</pre>
+<div class="block">This will set the encryption dictionary, this should only be called when
+ encrypting the document.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>encDictionary</code> - The encryption dictionary.</dd></dl>
+</li>
+</ul>
+<a name="getSignatureDictionaries()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getSignatureDictionaries</h4>
+<pre>public <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a>> getSignatureDictionaries()
+ throws <a href="http://download.oracle.com/javase/1.5.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 return a list of signature dictionaries as COSDictionary.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>list of signature dictionaries as COSDictionary</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if no document catalog can be found</dd></dl>
+</li>
+</ul>
+<a name="getSignatureFields(boolean)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getSignatureFields</h4>
+<pre>public <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a>> getSignatureFields(boolean onlyEmptyFields)
+ throws <a href="http://download.oracle.com/javase/1.5.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 return a list of signature fields.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>onlyEmptyFields</code> - only empty signature fields will be returned</dd>
+<dt><span class="strong">Returns:</span></dt><dd>list of signature dictionaries as COSDictionary</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if no document catalog can be found</dd></dl>
+</li>
+</ul>
+<a name="getDocumentID()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getDocumentID</h4>
+<pre>public <a href="../../../../org/apache/pdfbox/cos/COSArray.html" title="class in org.apache.pdfbox.cos">COSArray</a> getDocumentID()</pre>
+<div class="block">This will get the document ID.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The document id.</dd></dl>
+</li>
+</ul>
+<a name="setDocumentID(org.apache.pdfbox.cos.COSArray)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setDocumentID</h4>
+<pre>public void setDocumentID(<a href="../../../../org/apache/pdfbox/cos/COSArray.html" title="class in org.apache.pdfbox.cos">COSArray</a> id)</pre>
+<div class="block">This will set the document ID.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The document id.</dd></dl>
+</li>
+</ul>
+<a name="setSignatureInterface(org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureInterface)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setSignatureInterface</h4>
+<pre>public void setSignatureInterface(<a href="../../../../org/apache/pdfbox/pdmodel/interactive/digitalsignature/SignatureInterface.html" title="interface in org.apache.pdfbox.pdmodel.interactive.digitalsignature">SignatureInterface</a> sigInterface)</pre>
+<div class="block">Set the signature interface to the given value.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sigInterface</code> - the signature interface</dd></dl>
+</li>
+</ul>
+<a name="getCatalog()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getCatalog</h4>
+<pre>public <a href="../../../../org/apache/pdfbox/cos/COSObject.html" title="class in org.apache.pdfbox.cos">COSObject</a> getCatalog()
+ throws <a href="http://download.oracle.com/javase/1.5.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 catalog.
+
+ Maybe this should move to an object at PDFEdit level</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>catalog is the root of all document activities</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If no catalog can be found.</dd></dl>
+</li>
+</ul>
+<a name="getObjects()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getObjects</h4>
+<pre>public <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/pdfbox/cos/COSObject.html" title="class in org.apache.pdfbox.cos">COSObject</a>> getObjects()</pre>
+<div class="block">This will get a list of all available objects.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>A list of all objects.</dd></dl>
+</li>
+</ul>
+<a name="getTrailer()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getTrailer</h4>
+<pre>public <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> getTrailer()</pre>
+<div class="block">This will get the document trailer.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the document trailer dict</dd></dl>
+</li>
+</ul>
+<a name="setTrailer(org.apache.pdfbox.cos.COSDictionary)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setTrailer</h4>
+<pre>public void setTrailer(<a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> newTrailer)</pre>
+<div class="block">// MIT added, maybe this should not be supported as trailer is a persistence construct.
+ This will set the document trailer.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newTrailer</code> - the document trailer dictionary</dd></dl>
+</li>
+</ul>
+<a name="accept(org.apache.pdfbox.cos.ICOSVisitor)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>accept</h4>
+<pre>public <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> accept(<a href="../../../../org/apache/pdfbox/cos/ICOSVisitor.html" title="interface in org.apache.pdfbox.cos">ICOSVisitor</a> visitor)
+ throws <a href="../../../../org/apache/pdfbox/exceptions/COSVisitorException.html" title="class in org.apache.pdfbox.exceptions">COSVisitorException</a></pre>
+<div class="block">visitor pattern double dispatch method.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../org/apache/pdfbox/cos/COSBase.html#accept(org.apache.pdfbox.cos.ICOSVisitor)">accept</a></code> in class <code><a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>visitor</code> - The object to notify when visiting this object.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>any object, depending on the visitor implementation, or null</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../org/apache/pdfbox/exceptions/COSVisitorException.html" title="class in org.apache.pdfbox.exceptions">COSVisitorException</a></code> - If an error occurs while visiting this object.</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.5.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 all storage and delete the tmp files.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/Closeable.html?is-external=true#close()" title="class or interface in java.io">close</a></code> in interface <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang">close</a></code> in interface <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.5.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 close resources.</dd></dl>
+</li>
+</ul>
+<a name="finalize()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>finalize</h4>
+<pre>protected void finalize()
+ throws <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Warn the user in the finalizer if he didn't close the PDF document. The method also
+ closes the document just in case, to avoid abandoned temporary files. It's still a good
+ idea for the user to close the PDF document at the earliest possible to conserve resources.</div>
+<dl>
+<dt><strong>Overrides:</strong></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a></code> in class <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an error occurs while closing the temporary files</dd></dl>
+</li>
+</ul>
+<a name="setWarnMissingClose(boolean)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setWarnMissingClose</h4>
+<pre>public void setWarnMissingClose(boolean warn)</pre>
+<div class="block">Controls whether this instance shall issue a warning if the PDF document wasn't closed
+ properly through a call to the <a href="../../../../org/apache/pdfbox/cos/COSDocument.html#close()"><code>close()</code></a> method. If the PDF document is held in
+ a cache governed by soft references it is impossible to reliably close the document
+ before the warning is raised. By default, the warning is enabled.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>warn</code> - true enables the warning, false disables it.</dd></dl>
+</li>
+</ul>
+<a name="getHeaderString()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getHeaderString</h4>
+<pre>public <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getHeaderString()</pre>
+<dl><dt><span class="strong">Returns:</span></dt><dd>Returns the headerString.</dd></dl>
+</li>
+</ul>
+<a name="setHeaderString(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setHeaderString</h4>
+<pre>public void setHeaderString(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> header)</pre>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>header</code> - The headerString to set.</dd></dl>
+</li>
+</ul>
+<a name="dereferenceObjectStreams()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>dereferenceObjectStreams</h4>
+<pre>public void dereferenceObjectStreams()
+ throws <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">This method will search the list of objects for types of ObjStm. If it finds
+ them then it will parse out all of the objects from the stream that is contains.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.5.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>
+</li>
+</ul>
+<a name="getObjectFromPool(org.apache.pdfbox.persistence.util.COSObjectKey)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getObjectFromPool</h4>
+<pre>public <a href="../../../../org/apache/pdfbox/cos/COSObject.html" title="class in org.apache.pdfbox.cos">COSObject</a> getObjectFromPool(<a href="../../../../org/apache/pdfbox/persistence/util/COSObjectKey.html" title="class in org.apache.pdfbox.persistence.util">COSObjectKey</a> key)
+ throws <a href="http://download.oracle.com/javase/1.5.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 an object from the pool.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - The object key.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>The object in the pool or a new one if it has not been parsed yet.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://download.oracle.com/javase/1.5.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 proxy object.</dd></dl>
+</li>
+</ul>
+<a name="removeObject(org.apache.pdfbox.persistence.util.COSObjectKey)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>removeObject</h4>
+<pre>public <a href="../../../../org/apache/pdfbox/cos/COSObject.html" title="class in org.apache.pdfbox.cos">COSObject</a> removeObject(<a href="../../../../org/apache/pdfbox/persistence/util/COSObjectKey.html" title="class in org.apache.pdfbox.persistence.util">COSObjectKey</a> key)</pre>
+<div class="block">Removes an object from the object pool.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the object key</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the object that was removed or null if the object was not found</dd></dl>
+</li>
+</ul>
+<a name="addXRefTable(java.util.Map)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addXRefTable</h4>
+<pre>public void addXRefTable(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../org/apache/pdfbox/persistence/util/COSObjectKey.html" title="class in org.apache.pdfbox.persistence.util">COSObjectKey</a>,<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>> xrefTableValues)</pre>
+<div class="block">Populate XRef HashMap with given values.
+ Each entry maps ObjectKeys to byte offsets in the file.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xrefTableValues</code> - xref table entries to be added</dd></dl>
+</li>
+</ul>
+<a name="getXrefTable()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getXrefTable</h4>
+<pre>public <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../org/apache/pdfbox/persistence/util/COSObjectKey.html" title="class in org.apache.pdfbox.persistence.util">COSObjectKey</a>,<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>> getXrefTable()</pre>
+<div class="block">Returns the xrefTable which is a mapping of ObjectKeys
+ to byte offsets in the file.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>mapping of ObjectsKeys to byte offsets</dd></dl>
+</li>
+</ul>
+<a name="setStartXref(long)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setStartXref</h4>
+<pre>public void setStartXref(long startXrefValue)</pre>
+<div class="block">This method set the startxref value of the document. This will only
+ be needed for incremental updates.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>startXrefValue</code> - the value for startXref</dd></dl>
+</li>
+</ul>
+<a name="getStartXref()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getStartXref</h4>
+<pre>public long getStartXref()</pre>
+<div class="block">Return the startXref Position of the parsed document. This will only be needed for incremental updates.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a long with the old position of the startxref</dd></dl>
+</li>
+</ul>
+<a name="isXRefStream()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>isXRefStream</h4>
+<pre>public boolean isXRefStream()</pre>
+<div class="block">Determines it the trailer is a XRef stream or not.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>true if the trailer is a XRef stream</dd></dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar_bottom">
+<!-- -->
+</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/COSDocument.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../index-all.html">Index</a></li>
+<li><a href="../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../org/apache/pdfbox/cos/COSDictionaryLateBinding.html" title="class in org.apache.pdfbox.cos"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/pdfbox/cos/COSFloat.html" title="class in org.apache.pdfbox.cos"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/pdfbox/cos/COSDocument.html" target="_top">Frames</a></li>
+<li><a href="COSDocument.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li>Field | </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>Field | </li>
+<li><a href="#constructor_detail">Constr</a> | </li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<p class="legalCopy"><small>Copyright © 2002-2015 <a href="http://pdfbox.apache.org">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
+</body>
+</html>
\ No newline at end of file