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 [8/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-SN...
Modified: websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/cos/COSDictionary.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/cos/COSDictionary.html (original)
+++ websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/cos/COSDictionary.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:55 CEST 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>COSDictionary (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>
@@ -38,7 +38,7 @@
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/pdfbox/cos/COSBoolean.html" title="class in org.apache.pdfbox.cos"><span class="strong">Prev Class</span></a></li>
-<li><a href="../../../../org/apache/pdfbox/cos/COSDictionaryLateBinding.html" title="class in org.apache.pdfbox.cos"><span class="strong">Next Class</span></a></li>
+<li><a href="../../../../org/apache/pdfbox/cos/COSDocument.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/COSDictionary.html" target="_top">Frames</a></li>
@@ -102,21 +102,20 @@
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
-<dd><a href="../../../../org/apache/pdfbox/pdmodel/common/COSObjectable.html" title="interface in org.apache.pdfbox.pdmodel.common">COSObjectable</a></dd>
+<dd><a href="../../../../org/apache/pdfbox/cos/COSUpdateInfo.html" title="interface in org.apache.pdfbox.cos">COSUpdateInfo</a>, <a href="../../../../org/apache/pdfbox/pdmodel/common/COSObjectable.html" title="interface in org.apache.pdfbox.pdmodel.common">COSObjectable</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
-<dd><a href="../../../../org/apache/pdfbox/cos/COSDictionaryLateBinding.html" title="class in org.apache.pdfbox.cos">COSDictionaryLateBinding</a>, <a href="../../../../org/apache/pdfbox/cos/COSStream.html" title="class in org.apache.pdfbox.cos">COSStream</a></dd>
+<dd><a href="../../../../org/apache/pdfbox/cos/COSStream.html" title="class in org.apache.pdfbox.cos">COSStream</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">COSDictionary</span>
-extends <a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a></pre>
+extends <a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a>
+implements <a href="../../../../org/apache/pdfbox/cos/COSUpdateInfo.html" title="interface in org.apache.pdfbox.cos">COSUpdateInfo</a></pre>
<div class="block">This class represents a dictionary where name/value pairs reside.</div>
-<dl><dt><span class="strong">Version:</span></dt>
- <dd>$Revision: 1.32 $</dd>
-<dt><span class="strong">Author:</span></dt>
- <dd><a href="ben@benlitchfield.com">Ben Litchfield</a></dd></dl>
+<dl><dt><span class="strong">Author:</span></dt>
+ <dd>Ben Litchfield</dd></dl>
</li>
</ul>
</div>
@@ -622,52 +621,58 @@ extends <a href="../../../../org/apache/
</td>
</tr>
<tr class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#isNeedToBeUpdated()">isNeedToBeUpdated</a></strong>()</code>
+<div class="block">Get the update state for the COSWriter.</div>
+</td>
+</tr>
+<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#keySet()">keySet</a></strong>()</code>
<div class="block">Returns the names of the entries in this dictionary.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#mergeInto(org.apache.pdfbox.cos.COSDictionary)">mergeInto</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> dic)</code>
<div class="block">This will add all of the dictionarys keys/values to this dictionary, but only if they don't already exist.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#removeItem(org.apache.pdfbox.cos.COSName)">removeItem</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> key)</code>
<div class="block">This will remove an item for the dictionary.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setBoolean(org.apache.pdfbox.cos.COSName, boolean)">setBoolean</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> key,
boolean value)</code>
<div class="block">This will set an item in the dictionary.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setBoolean(java.lang.String, boolean)">setBoolean</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> key,
boolean value)</code>
<div class="block">This will set an item in the dictionary.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setDate(org.apache.pdfbox.cos.COSName, java.util.Calendar)">setDate</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> key,
<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> date)</code>
<div class="block">Set the date object.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setDate(java.lang.String, java.util.Calendar)">setDate</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> key,
<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util">Calendar</a> date)</code>
<div class="block">Set the value of a date entry in the dictionary.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setEmbeddedDate(java.lang.String, org.apache.pdfbox.cos.COSName, java.util.Calendar)">setEmbeddedDate</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> embedded,
<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> key,
@@ -675,7 +680,7 @@ extends <a href="../../../../org/apache/
<div class="block">Set the date object.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setEmbeddedDate(java.lang.String, java.lang.String, java.util.Calendar)">setEmbeddedDate</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> embedded,
<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> key,
@@ -683,7 +688,7 @@ extends <a href="../../../../org/apache/
<div class="block">Set the value of a date entry in the dictionary.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setEmbeddedInt(java.lang.String, org.apache.pdfbox.cos.COSName, int)">setEmbeddedInt</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> embeddedDictionary,
<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> key,
@@ -691,7 +696,7 @@ extends <a href="../../../../org/apache/
<div class="block">This is a convenience method that will convert the value to a COSInteger object.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setEmbeddedInt(java.lang.String, java.lang.String, int)">setEmbeddedInt</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> embeddedDictionary,
<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> key,
@@ -699,7 +704,7 @@ extends <a href="../../../../org/apache/
<div class="block">This is a convenience method that will convert the value to a COSInteger object.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setEmbeddedString(java.lang.String, org.apache.pdfbox.cos.COSName, java.lang.String)">setEmbeddedString</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> embedded,
<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> key,
@@ -707,7 +712,7 @@ extends <a href="../../../../org/apache/
<div class="block">This is a convenience method that will convert the value to a COSString object.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setEmbeddedString(java.lang.String, java.lang.String, java.lang.String)">setEmbeddedString</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> embedded,
<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> key,
@@ -715,7 +720,7 @@ extends <a href="../../../../org/apache/
<div class="block">This is a convenience method that will convert the value to a COSString object.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setFlag(org.apache.pdfbox.cos.COSName, int, boolean)">setFlag</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> field,
int bitFlag,
@@ -723,90 +728,96 @@ extends <a href="../../../../org/apache/
<div class="block">Sets the given boolean value at bitPos in the flags.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setFloat(org.apache.pdfbox.cos.COSName, float)">setFloat</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> key,
float value)</code>
<div class="block">This is a convenience method that will convert the value to a COSFloat object.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setFloat(java.lang.String, float)">setFloat</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> key,
float value)</code>
<div class="block">This is a convenience method that will convert the value to a COSFloat object.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setInt(org.apache.pdfbox.cos.COSName, int)">setInt</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> key,
int value)</code>
<div class="block">This is a convenience method that will convert the value to a COSInteger object.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setInt(java.lang.String, int)">setInt</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> key,
int value)</code>
<div class="block">This is a convenience method that will convert the value to a COSInteger object.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setItem(org.apache.pdfbox.cos.COSName, org.apache.pdfbox.cos.COSBase)">setItem</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> key,
<a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a> value)</code>
<div class="block">This will set an item in the dictionary.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setItem(org.apache.pdfbox.cos.COSName, org.apache.pdfbox.pdmodel.common.COSObjectable)">setItem</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> key,
<a href="../../../../org/apache/pdfbox/pdmodel/common/COSObjectable.html" title="interface in org.apache.pdfbox.pdmodel.common">COSObjectable</a> value)</code>
<div class="block">This will set an item in the dictionary.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setItem(java.lang.String, org.apache.pdfbox.cos.COSBase)">setItem</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> key,
<a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a> value)</code>
<div class="block">This will set an item in the dictionary.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setItem(java.lang.String, org.apache.pdfbox.pdmodel.common.COSObjectable)">setItem</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> key,
<a href="../../../../org/apache/pdfbox/pdmodel/common/COSObjectable.html" title="interface in org.apache.pdfbox.pdmodel.common">COSObjectable</a> value)</code>
<div class="block">This will set an item in the dictionary.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setLong(org.apache.pdfbox.cos.COSName, long)">setLong</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> key,
long value)</code>
<div class="block">This is a convenience method that will convert the value to a COSInteger object.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setLong(java.lang.String, long)">setLong</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> key,
long value)</code>
<div class="block">This is a convenience method that will convert the value to a COSInteger object.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setName(org.apache.pdfbox.cos.COSName, java.lang.String)">setName</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> key,
<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> value)</code>
<div class="block">This is a convenience method that will convert the value to a COSName object.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setName(java.lang.String, java.lang.String)">setName</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> key,
<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> value)</code>
<div class="block">This is a convenience method that will convert the value to a COSName object.</div>
</td>
</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setNeedToBeUpdated(boolean)">setNeedToBeUpdated</a></strong>(boolean flag)</code>
+<div class="block">Set the update state of the dictionary for the COSWriter.</div>
+</td>
+</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setString(org.apache.pdfbox.cos.COSName, java.lang.String)">setString</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> key,
@@ -837,7 +848,7 @@ extends <a href="../../../../org/apache/
<!-- -->
</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#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>
+<code><a href="../../../../org/apache/pdfbox/cos/COSBase.html#getCOSObject()">getCOSObject</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#isDirect()">isDirect</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#setDirect(boolean)">setDirect</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
@@ -2057,6 +2068,36 @@ 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 visiting this object.</dd></dl>
</li>
</ul>
+<a name="isNeedToBeUpdated()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isNeedToBeUpdated</h4>
+<pre>public boolean isNeedToBeUpdated()</pre>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/pdfbox/cos/COSUpdateInfo.html#isNeedToBeUpdated()">COSUpdateInfo</a></code></strong></div>
+<div class="block">Get the update state for the COSWriter.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../org/apache/pdfbox/cos/COSUpdateInfo.html#isNeedToBeUpdated()">isNeedToBeUpdated</a></code> in interface <code><a href="../../../../org/apache/pdfbox/cos/COSUpdateInfo.html" title="interface in org.apache.pdfbox.cos">COSUpdateInfo</a></code></dd>
+<dt><span class="strong">Returns:</span></dt><dd>the update state.</dd></dl>
+</li>
+</ul>
+<a name="setNeedToBeUpdated(boolean)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setNeedToBeUpdated</h4>
+<pre>public void setNeedToBeUpdated(boolean flag)</pre>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/pdfbox/cos/COSUpdateInfo.html#setNeedToBeUpdated(boolean)">COSUpdateInfo</a></code></strong></div>
+<div class="block">Set the update state of the dictionary for the COSWriter.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../org/apache/pdfbox/cos/COSUpdateInfo.html#setNeedToBeUpdated(boolean)">setNeedToBeUpdated</a></code> in interface <code><a href="../../../../org/apache/pdfbox/cos/COSUpdateInfo.html" title="interface in org.apache.pdfbox.cos">COSUpdateInfo</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>flag</code> - the update state.</dd></dl>
+</li>
+</ul>
<a name="addAll(org.apache.pdfbox.cos.COSDictionary)">
<!-- -->
</a>
@@ -2167,7 +2208,7 @@ extends <a href="../../../../org/apache/
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/pdfbox/cos/COSBoolean.html" title="class in org.apache.pdfbox.cos"><span class="strong">Prev Class</span></a></li>
-<li><a href="../../../../org/apache/pdfbox/cos/COSDictionaryLateBinding.html" title="class in org.apache.pdfbox.cos"><span class="strong">Next Class</span></a></li>
+<li><a href="../../../../org/apache/pdfbox/cos/COSDocument.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/COSDictionary.html" target="_top">Frames</a></li>
Modified: websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/cos/COSDocument.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/cos/COSDocument.html (original)
+++ websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/cos/COSDocument.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:55 CEST 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>COSDocument (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>
@@ -37,7 +37,7 @@
</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/COSDictionary.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">
@@ -170,7 +170,7 @@ implements <a href="http://download.orac
</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.6.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.6.0/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>> xrefTableValues)</code>
+<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.6.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../org/apache/pdfbox/cos/COSObjectKey.html" title="class in org.apache.pdfbox.cos">COSObjectKey</a>,<a href="http://download.oracle.com/javase/1.6.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>
@@ -224,57 +224,47 @@ implements <a href="http://download.orac
</td>
</tr>
<tr class="altColor">
-<td class="colFirst"><code><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></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">
+<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>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#getObjectFromPool(org.apache.pdfbox.cos.COSObjectKey)">getObjectFromPool</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSObjectKey.html" title="class in org.apache.pdfbox.cos">COSObjectKey</a> key)</code>
<div class="block">This will get an object from the pool.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.6.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="altColor">
+<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.6.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="rowColor">
+<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.6.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.6.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="altColor">
+<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.6.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">
+<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.6.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>
@@ -290,11 +280,11 @@ implements <a href="http://download.orac
<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>
+<div class="block">This will get the version extracted from the header of this PDF document.</div>
</td>
</tr>
<tr class="altColor">
-<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.6.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.6.0/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>></code></td>
+<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../org/apache/pdfbox/cos/COSObjectKey.html" title="class in org.apache.pdfbox.cos">COSObjectKey</a>,<a href="http://download.oracle.com/javase/1.6.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>
@@ -302,57 +292,59 @@ implements <a href="http://download.orac
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#isClosed()">isClosed</a></strong>()</code>
+<div class="block">Returns true if this document has been closed.</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#isDecrypted()">isDecrypted</a></strong>()</code>
<div class="block">Indicates if a encrypted pdf is already decrypted after parsing.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<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">
+<tr class="altColor">
<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 if the trailer is a XRef stream or not.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<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">
+<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#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>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDocument.html#removeObject(org.apache.pdfbox.cos.COSObjectKey)">removeObject</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSObjectKey.html" title="class in org.apache.pdfbox.cos">COSObjectKey</a> key)</code>
<div class="block">Removes an object from the object pool.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<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">
+<tr class="altColor">
<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">
+<tr class="rowColor">
<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.6.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#setIsXRefStream(boolean)">setIsXRefStream</a></strong>(boolean isXRefStreamValue)</code>
@@ -361,29 +353,23 @@ implements <a href="http://download.orac
</tr>
<tr class="rowColor">
<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="altColor">
-<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="rowColor">
+<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="altColor">
+<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>
+<div class="block">This will set the header version of this PDF document.</div>
</td>
</tr>
-<tr class="rowColor">
+<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
@@ -396,7 +382,7 @@ implements <a href="http://download.orac
<!-- -->
</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#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>
+<code><a href="../../../../org/apache/pdfbox/cos/COSBase.html#getCOSObject()">getCOSObject</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#isDirect()">isDirect</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#setDirect(boolean)">setDirect</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
@@ -548,7 +534,7 @@ implements <a href="http://download.orac
<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>
+<div class="block">This will set the header 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>
@@ -559,8 +545,8 @@ implements <a href="http://download.orac
<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>
+<div class="block">This will get the version extracted from the header of this PDF document.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The header version.</dd></dl>
</li>
</ul>
<a name="setDecrypted()">
@@ -570,9 +556,7 @@ implements <a href="http://download.orac
<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>
+<div class="block">Signals that the document is decrypted completely.</div>
</li>
</ul>
<a name="isDecrypted()">
@@ -582,8 +566,7 @@ implements <a href="http://download.orac
<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>
+<div class="block">Indicates if a encrypted pdf is already decrypted after parsing.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true indicates that the pdf is decrypted.</dd></dl>
</li>
</ul>
@@ -610,17 +593,6 @@ implements <a href="http://download.orac
<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>
@@ -683,17 +655,6 @@ implements <a href="http://download.orac
<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>
@@ -780,6 +741,16 @@ implements <a href="http://download.orac
<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 close resources.</dd></dl>
</li>
</ul>
+<a name="isClosed()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isClosed</h4>
+<pre>public boolean isClosed()</pre>
+<div class="block">Returns true if this document has been closed.</div>
+</li>
+</ul>
<a name="finalize()">
<!-- -->
</a>
@@ -812,26 +783,6 @@ implements <a href="http://download.orac
<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.6.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.6.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>
@@ -846,13 +797,13 @@ implements <a href="http://download.orac
<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>
</li>
</ul>
-<a name="getObjectFromPool(org.apache.pdfbox.persistence.util.COSObjectKey)">
+<a name="getObjectFromPool(org.apache.pdfbox.cos.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)
+<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/cos/COSObjectKey.html" title="class in org.apache.pdfbox.cos">COSObjectKey</a> key)
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 an object from the pool.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - The object key.</dd>
@@ -861,13 +812,13 @@ implements <a href="http://download.orac
<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 proxy object.</dd></dl>
</li>
</ul>
-<a name="removeObject(org.apache.pdfbox.persistence.util.COSObjectKey)">
+<a name="removeObject(org.apache.pdfbox.cos.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>
+<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/cos/COSObjectKey.html" title="class in org.apache.pdfbox.cos">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>
@@ -879,7 +830,7 @@ implements <a href="http://download.orac
<ul class="blockList">
<li class="blockList">
<h4>addXRefTable</h4>
-<pre>public void addXRefTable(<a href="http://download.oracle.com/javase/1.6.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.6.0/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>> xrefTableValues)</pre>
+<pre>public void addXRefTable(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../org/apache/pdfbox/cos/COSObjectKey.html" title="class in org.apache.pdfbox.cos">COSObjectKey</a>,<a href="http://download.oracle.com/javase/1.6.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>
@@ -891,7 +842,7 @@ implements <a href="http://download.orac
<ul class="blockList">
<li class="blockList">
<h4>getXrefTable</h4>
-<pre>public <a href="http://download.oracle.com/javase/1.6.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.6.0/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>> getXrefTable()</pre>
+<pre>public <a href="http://download.oracle.com/javase/1.6.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../org/apache/pdfbox/cos/COSObjectKey.html" title="class in org.apache.pdfbox.cos">COSObjectKey</a>,<a href="http://download.oracle.com/javase/1.6.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>
@@ -968,7 +919,7 @@ implements <a href="http://download.orac
</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/COSDictionary.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">
Modified: websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/cos/COSFloat.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/cos/COSFloat.html (original)
+++ websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/cos/COSFloat.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:55 CEST 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>COSFloat (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>
@@ -115,7 +115,7 @@
extends <a href="../../../../org/apache/pdfbox/cos/COSNumber.html" title="class in org.apache.pdfbox.cos">COSNumber</a></pre>
<div class="block">This class represents a floating point number in a PDF document.</div>
<dl><dt><span class="strong">Author:</span></dt>
- <dd><a href="mailto:ben@benlitchfield.com">Ben Litchfield</a></dd></dl>
+ <dd>Ben Litchfield</dd></dl>
</li>
</ul>
</div>
@@ -212,16 +212,10 @@ extends <a href="../../../../org/apache/
</td>
</tr>
<tr class="rowColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSFloat.html#setValue(float)">setValue</a></strong>(float floatValue)</code>
-<div class="block">Set the value of the float object.</div>
-</td>
-</tr>
-<tr class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSFloat.html#toString()">toString</a></strong>()</code></td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSFloat.html#writePDF(java.io.OutputStream)">writePDF</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> output)</code>
<div class="block">This will output this string as a PDF object.</div>
@@ -240,7 +234,7 @@ extends <a href="../../../../org/apache/
<!-- -->
</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#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>
+<code><a href="../../../../org/apache/pdfbox/cos/COSBase.html#getCOSObject()">getCOSObject</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#isDirect()">isDirect</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#setDirect(boolean)">setDirect</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
@@ -296,17 +290,6 @@ extends <a href="../../../../org/apache/
<!-- -->
</a>
<h3>Method Detail</h3>
-<a name="setValue(float)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setValue</h4>
-<pre>public void setValue(float floatValue)</pre>
-<div class="block">Set the value of the float object.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>floatValue</code> - The new float value.</dd></dl>
-</li>
-</ul>
<a name="floatValue()">
<!-- -->
</a>
Modified: websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/cos/COSInteger.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/cos/COSInteger.html (original)
+++ websites/staging/pdfbox/trunk/content/docs/2.0.0-SNAPSHOT/javadocs/org/apache/pdfbox/cos/COSInteger.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:55 CEST 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>COSInteger (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>
@@ -111,13 +111,11 @@
</dl>
<hr>
<br>
-<pre>public class <span class="strong">COSInteger</span>
+<pre>public final class <span class="strong">COSInteger</span>
extends <a href="../../../../org/apache/pdfbox/cos/COSNumber.html" title="class in org.apache.pdfbox.cos">COSNumber</a></pre>
<div class="block">This class represents an integer number in a PDF document.</div>
-<dl><dt><span class="strong">Version:</span></dt>
- <dd>$Revision: 1.12 $</dd>
-<dt><span class="strong">Author:</span></dt>
- <dd><a href="mailto:ben@benlitchfield.com">Ben Litchfield</a></dd></dl>
+<dl><dt><span class="strong">Author:</span></dt>
+ <dd>Ben Litchfield</dd></dl>
</li>
</ul>
</div>
@@ -222,16 +220,10 @@ extends <a href="../../../../org/apache/
</td>
</tr>
<tr class="altColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSInteger.html#setValue(long)">setValue</a></strong>(long newValue)</code>
-<div class="block">Change the value of this reference.</div>
-</td>
-</tr>
-<tr class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSInteger.html#toString()">toString</a></strong>()</code></td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSInteger.html#writePDF(java.io.OutputStream)">writePDF</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> output)</code>
<div class="block">This will output this string as a PDF object.</div>
@@ -250,7 +242,7 @@ extends <a href="../../../../org/apache/
<!-- -->
</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#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>
+<code><a href="../../../../org/apache/pdfbox/cos/COSBase.html#getCOSObject()">getCOSObject</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#isDirect()">isDirect</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#setDirect(boolean)">setDirect</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
@@ -380,17 +372,6 @@ extends <a href="../../../../org/apache/
</dl>
</li>
</ul>
-<a name="setValue(long)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setValue</h4>
-<pre>public void setValue(long newValue)</pre>
-<div class="block">Change the value of this reference.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newValue</code> - The new value.</dd></dl>
-</li>
-</ul>
<a name="floatValue()">
<!-- -->
</a>