http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/3010c6b8/content/docs/2.0.0/javadocs/org/apache/pdfbox/cos/COSDictionary.html ---------------------------------------------------------------------- diff --git a/content/docs/2.0.0/javadocs/org/apache/pdfbox/cos/COSDictionary.html b/content/docs/2.0.0/javadocs/org/apache/pdfbox/cos/COSDictionary.html new file mode 100644 index 0000000..a8e3013 --- /dev/null +++ b/content/docs/2.0.0/javadocs/org/apache/pdfbox/cos/COSDictionary.html @@ -0,0 +1,2251 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="de"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>COSDictionary (Apache PDFBox 2.0.0 API)</title> +<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="COSDictionary (Apache PDFBox 2.0.0 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/COSDictionary.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/COSBoolean.html" title="class in org.apache.pdfbox.cos"><span class="strong">Prev 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> +<li><a href="COSDictionary.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><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><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 COSDictionary" class="title">Class COSDictionary</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">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.COSDictionary</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<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/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> +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">Author:</span></dt> + <dd>Ben Litchfield</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <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/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a>,<a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#items">items</a></strong></code> +<div class="block">The name-value pairs of this dictionary.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== 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/COSDictionary.html#COSDictionary()">COSDictionary</a></strong>()</code> +<div class="block">Constructor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#COSDictionary(org.apache.pdfbox.cos.COSDictionary)">COSDictionary</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> dict)</code> +<div class="block">Copy Constructor.</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.6.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.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/COSDictionary.html#addAll(org.apache.pdfbox.cos.COSDictionary)">addAll</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.</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/COSDictionary.html#asUnmodifiableDictionary()">asUnmodifiableDictionary</a></strong>()</code> +<div class="block">Returns an unmodifiable view of this dictionary.</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#clear()">clear</a></strong>()</code> +<div class="block">This will clear all items in the map.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#containsKey(org.apache.pdfbox.cos.COSName)">containsKey</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> name)</code> </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#containsKey(java.lang.String)">containsKey</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> name)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#containsValue(java.lang.Object)">containsValue</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</code> </td> +</tr> +<tr class="rowColor"> +<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="http://download.oracle.com/javase/1.6.0/docs/api/java/util/Map.Entry.html?is-external=true"; title="class or interface in java.util">Map.Entry</a><<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a>,<a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#entrySet()">entrySet</a></strong>()</code> +<div class="block">Returns the name-value entries in this dictionary.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getBoolean(org.apache.pdfbox.cos.COSName,%20boolean)">getBoolean</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> key, + boolean defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be a COSBoolean and convert + it to a primitive boolean.</div> +</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#getBoolean(org.apache.pdfbox.cos.COSName,%20org.apache.pdfbox.cos.COSName,%20boolean)">getBoolean</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> firstKey, + <a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> secondKey, + boolean defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be a COSBoolean and convert + it to a primitive boolean.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getBoolean(java.lang.String,%20boolean)">getBoolean</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 defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be a cos boolean and convert + it to a primitive boolean.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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#getCOSName(org.apache.pdfbox.cos.COSName)">getCOSName</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 is a convenience method that will get the dictionary object that is expected to be a name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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#getCOSName(org.apache.pdfbox.cos.COSName,%20org.apache.pdfbox.cos.COSName)">getCOSName</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/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be a name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getDate(org.apache.pdfbox.cos.COSName)">getDate</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 is a convenience method that will get the dictionary object that is expected to be a name and convert it to + a string.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getDate(org.apache.pdfbox.cos.COSName,%20java.util.Calendar)">getDate</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> defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be a date.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getDate(java.lang.String)">getDate</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)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be a name and convert it to + a string.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getDate(java.lang.String,%20java.util.Calendar)">getDate</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> defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be a date.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getDictionaryObject(org.apache.pdfbox.cos.COSName)">getDictionaryObject</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 get an object from this dictionary.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getDictionaryObject(org.apache.pdfbox.cos.COSName,%20org.apache.pdfbox.cos.COSName)">getDictionaryObject</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> firstKey, + <a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> secondKey)</code> +<div class="block">This is a special case of getDictionaryObject that takes multiple keys, it will handle the situation where + multiple keys could get the same value, ie if either CS or ColorSpace is used to get the colorspace.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getDictionaryObject(java.lang.String)">getDictionaryObject</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)</code> +<div class="block">This will get an object from this dictionary.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getDictionaryObject(java.lang.String[])">getDictionaryObject</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>[] keyList)</code> +<div class="block">This is a special case of getDictionaryObject that takes multiple keys, it will handle the situation where + multiple keys could get the same value, ie if either CS or ColorSpace is used to get the colorspace.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getEmbeddedDate(java.lang.String,%20org.apache.pdfbox.cos.COSName)">getEmbeddedDate</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)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be a name and convert it to + a string.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getEmbeddedDate(java.lang.String,%20org.apache.pdfbox.cos.COSName,%20java.util.Calendar)">getEmbeddedDate</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, + <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> defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be a date.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getEmbeddedDate(java.lang.String,%20java.lang.String)">getEmbeddedDate</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)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be a name and convert it to + a string.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getEmbeddedDate(java.lang.String,%20java.lang.String,%20java.util.Calendar)">getEmbeddedDate</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, + <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> defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be a date.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getEmbeddedInt(java.lang.String,%20org.apache.pdfbox.cos.COSName)">getEmbeddedInt</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)</code> +<div class="block">Get an integer from an embedded dictionary.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getEmbeddedInt(java.lang.String,%20org.apache.pdfbox.cos.COSName,%20int)">getEmbeddedInt</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, + int defaultValue)</code> +<div class="block">Get an integer from an embedded dictionary.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getEmbeddedInt(java.lang.String,%20java.lang.String)">getEmbeddedInt</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)</code> +<div class="block">Get an integer from an embedded dictionary.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getEmbeddedInt(java.lang.String,%20java.lang.String,%20int)">getEmbeddedInt</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, + int defaultValue)</code> +<div class="block">Get an integer from an embedded dictionary.</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/COSDictionary.html#getEmbeddedString(java.lang.String,%20org.apache.pdfbox.cos.COSName)">getEmbeddedString</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)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be a name and convert it to + a string.</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/COSDictionary.html#getEmbeddedString(java.lang.String,%20org.apache.pdfbox.cos.COSName,%20java.lang.String)">getEmbeddedString</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, + <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> defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be a name and convert it to + a string.</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/COSDictionary.html#getEmbeddedString(java.lang.String,%20java.lang.String)">getEmbeddedString</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)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be a name and convert it to + a string.</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/COSDictionary.html#getEmbeddedString(java.lang.String,%20java.lang.String,%20java.lang.String)">getEmbeddedString</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, + <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> defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be a name and convert it to + a string.</div> +</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#getFlag(org.apache.pdfbox.cos.COSName,%20int)">getFlag</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> field, + int bitFlag)</code> +<div class="block">Gets the boolean value from the flags at the given bit position.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>float</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getFloat(org.apache.pdfbox.cos.COSName)">getFloat</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 is a convenience method that will get the dictionary object that is expected to be an float. -1 is returned + if there is no value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>float</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getFloat(org.apache.pdfbox.cos.COSName,%20float)">getFloat</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> key, + float defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be an float.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>float</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getFloat(java.lang.String)">getFloat</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)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be an float. -1 is returned + if there is no value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>float</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getFloat(java.lang.String,%20float)">getFloat</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 defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be a float.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getInt(org.apache.pdfbox.cos.COSName)">getInt</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 is a convenience method that will get the dictionary object that is expected to be an int. -1 is returned if + there is no value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getInt(org.apache.pdfbox.cos.COSName,%20org.apache.pdfbox.cos.COSName)">getInt</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> firstKey, + <a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> secondKey)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be an integer.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getInt(org.apache.pdfbox.cos.COSName,%20org.apache.pdfbox.cos.COSName,%20int)">getInt</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> firstKey, + <a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> secondKey, + int defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be an integer.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getInt(org.apache.pdfbox.cos.COSName,%20int)">getInt</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> key, + int defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be an integer.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getInt(java.lang.String)">getInt</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)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be an int. -1 is returned if + there is no value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getInt(java.lang.String[],%20int)">getInt</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>[] keyList, + int defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be an integer.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getInt(java.lang.String,%20int)">getInt</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 defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be an integer.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getItem(org.apache.pdfbox.cos.COSName)">getItem</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 do a lookup into the dictionary.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getItem(java.lang.String)">getItem</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)</code> +<div class="block">This will do a lookup into the dictionary.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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#getKeyForValue(java.lang.Object)">getKeyForValue</a></strong>(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</code> +<div class="block">Search in the map for the value that matches the parameter and return the first key that maps to that value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getLong(org.apache.pdfbox.cos.COSName)">getLong</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 is a convenience method that will get the dictionary object that is expected to be an long. -1 is returned + if there is no value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getLong(org.apache.pdfbox.cos.COSName,%20long)">getLong</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> key, + long defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be an integer.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getLong(java.lang.String)">getLong</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)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be an long. -1 is returned + if there is no value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getLong(java.lang.String[],%20long)">getLong</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>[] keyList, + long defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be an long.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getLong(java.lang.String,%20long)">getLong</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 defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be an integer.</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/COSDictionary.html#getNameAsString(org.apache.pdfbox.cos.COSName)">getNameAsString</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 is a convenience method that will get the dictionary object that is expected to be a name and convert it to + a string.</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/COSDictionary.html#getNameAsString(org.apache.pdfbox.cos.COSName,%20java.lang.String)">getNameAsString</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> defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be a name and convert it to + a string.</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/COSDictionary.html#getNameAsString(java.lang.String)">getNameAsString</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)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be a name and convert it to + a string.</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/COSDictionary.html#getNameAsString(java.lang.String,%20java.lang.String)">getNameAsString</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> defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be a name and convert it to + a string.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getObjectFromPath(java.lang.String)">getObjectFromPath</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> objPath)</code> +<div class="block">Nice method, gives you every object you want Arrays works properly too.</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/COSDictionary.html#getString(org.apache.pdfbox.cos.COSName)">getString</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 is a convenience method that will get the dictionary object that is expected to be a name and convert it to + a string.</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/COSDictionary.html#getString(org.apache.pdfbox.cos.COSName,%20java.lang.String)">getString</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> defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be a name and convert it to + a string.</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/COSDictionary.html#getString(java.lang.String)">getString</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)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be a name and convert it to + a string.</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/COSDictionary.html#getString(java.lang.String,%20java.lang.String)">getString</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> defaultValue)</code> +<div class="block">This is a convenience method that will get the dictionary object that is expected to be a name and convert it to + a string.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getValues()">getValues</a></strong>()</code> +<div class="block">This will get all of the values for the dictionary.</div> +</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="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="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="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,%20boolean)">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="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,%20boolean)">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="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,%20java.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="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,%20java.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="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,%20org.apache.pdfbox.cos.COSName,%20java.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, + <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="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,%20java.lang.String,%20java.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, + <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="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,%20org.apache.pdfbox.cos.COSName,%20int)">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, + 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"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setEmbeddedInt(java.lang.String,%20java.lang.String,%20int)">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, + 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"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setEmbeddedString(java.lang.String,%20org.apache.pdfbox.cos.COSName,%20java.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, + <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 COSString 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#setEmbeddedString(java.lang.String,%20java.lang.String,%20java.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, + <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 COSString object.</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#setFlag(org.apache.pdfbox.cos.COSName,%20int,%20boolean)">setFlag</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> field, + int bitFlag, + boolean value)</code> +<div class="block">Sets the given boolean value at bitPos in the flags.</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#setFloat(org.apache.pdfbox.cos.COSName,%20float)">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="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,%20float)">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="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,%20int)">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="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,%20int)">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="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,%20org.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="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,%20org.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="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,%20org.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="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,%20org.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="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,%20long)">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="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,%20long)">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="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,%20java.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="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,%20java.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,%20java.lang.String)">setString</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 COSString 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#setString(java.lang.String,%20java.lang.String)">setString</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 COSString object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#size()">size</a></strong>()</code> +<div class="block">This will return the number of elements in this dictionary.</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/COSDictionary.html#toString()">toString</a></strong>()</code></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#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"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://download.oracle.com/javase/1.6.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.6.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.6.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/1.6.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.6.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.6.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="ht tp://download.oracle.com/javase/1.6.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.6.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.6.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.6.0/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="items"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>items</h4> +<pre>protected <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/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a>,<a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a>> items</pre> +<div class="block">The name-value pairs of this dictionary. The pairs are kept in the order they were added to the dictionary.</div> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="COSDictionary()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COSDictionary</h4> +<pre>public COSDictionary()</pre> +<div class="block">Constructor.</div> +</li> +</ul> +<a name="COSDictionary(org.apache.pdfbox.cos.COSDictionary)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>COSDictionary</h4> +<pre>public COSDictionary(<a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> dict)</pre> +<div class="block">Copy Constructor. This will make a shallow copy of this dictionary.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dict</code> - The dictionary to copy.</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="containsValue(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>containsValue</h4> +<pre>public boolean containsValue(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The value to find in the map.</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if the map contains this value.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="http://download.oracle.com/javase/1.6.0/docs/api/java/util/Map.html?is-external=true#containsValue(java.lang.Object)" title="class or interface in java.util"><code>Map.containsValue(java.lang.Object)</code></a></dd></dl> +</li> +</ul> +<a name="getKeyForValue(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKeyForValue</h4> +<pre>public <a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> getKeyForValue(<a href="http://download.oracle.com/javase/1.6.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</pre> +<div class="block">Search in the map for the value that matches the parameter and return the first key that maps to that value.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The value to search for in the map.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The key for the value in the map or null if it does not exist.</dd></dl> +</li> +</ul> +<a name="size()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>size</h4> +<pre>public int size()</pre> +<div class="block">This will return the number of elements in this dictionary.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The number of elements in the dictionary.</dd></dl> +</li> +</ul> +<a name="clear()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clear</h4> +<pre>public void clear()</pre> +<div class="block">This will clear all items in the map.</div> +</li> +</ul> +<a name="getDictionaryObject(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDictionaryObject</h4> +<pre>public <a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a> getDictionaryObject(<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)</pre> +<div class="block">This will get an object from this dictionary. If the object is a reference then it will dereference it and get it + from the document. If the object is COSNull then null will be returned.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - The key to the object that we are getting.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The object that matches the key.</dd></dl> +</li> +</ul> +<a name="getDictionaryObject(org.apache.pdfbox.cos.COSName, org.apache.pdfbox.cos.COSName)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDictionaryObject</h4> +<pre>public <a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a> getDictionaryObject(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> firstKey, + <a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> secondKey)</pre> +<div class="block">This is a special case of getDictionaryObject that takes multiple keys, it will handle the situation where + multiple keys could get the same value, ie if either CS or ColorSpace is used to get the colorspace. This will + get an object from this dictionary. If the object is a reference then it will dereference it and get it from the + document. If the object is COSNull then null will be returned.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>firstKey</code> - The first key to try.</dd><dd><code>secondKey</code> - The second key to try.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The object that matches the key.</dd></dl> +</li> +</ul> +<a name="getDictionaryObject(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDictionaryObject</h4> +<pre>public <a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a> getDictionaryObject(<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>[] keyList)</pre> +<div class="block">This is a special case of getDictionaryObject that takes multiple keys, it will handle the situation where + multiple keys could get the same value, ie if either CS or ColorSpace is used to get the colorspace. This will + get an object from this dictionary. If the object is a reference then it will dereference it and get it from the + document. If the object is COSNull then null will be returned.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>keyList</code> - The list of keys to find a value.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The object that matches the key.</dd></dl> +</li> +</ul> +<a name="getDictionaryObject(org.apache.pdfbox.cos.COSName)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDictionaryObject</h4> +<pre>public <a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a> getDictionaryObject(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> key)</pre> +<div class="block">This will get an object from this dictionary. If the object is a reference then it will dereference it and get it + from the document. If the object is COSNull then null will be returned.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - The key to the object that we are getting.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The object that matches the key.</dd></dl> +</li> +</ul> +<a name="setItem(org.apache.pdfbox.cos.COSName, org.apache.pdfbox.cos.COSBase)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setItem</h4> +<pre>public void setItem(<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)</pre> +<div class="block">This will set an item in the dictionary. If value is null then the result will be the same as removeItem( key ).</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - The key to the dictionary object.</dd><dd><code>value</code> - The value to the dictionary object.</dd></dl> +</li> +</ul> +<a name="setItem(org.apache.pdfbox.cos.COSName, org.apache.pdfbox.pdmodel.common.COSObjectable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setItem</h4> +<pre>public void setItem(<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)</pre> +<div class="block">This will set an item in the dictionary. If value is null then the result will be the same as removeItem( key ).</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - The key to the dictionary object.</dd><dd><code>value</code> - The value to the dictionary object.</dd></dl> +</li> +</ul> +<a name="setItem(java.lang.String, org.apache.pdfbox.pdmodel.common.COSObjectable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setItem</h4> +<pre>public void setItem(<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)</pre> +<div class="block">This will set an item in the dictionary. If value is null then the result will be the same as removeItem( key ).</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - The key to the dictionary object.</dd><dd><code>value</code> - The value to the dictionary object.</dd></dl> +</li> +</ul> +<a name="setBoolean(java.lang.String, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBoolean</h4> +<pre>public void setBoolean(<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)</pre> +<div class="block">This will set an item in the dictionary.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - The key to the dictionary object.</dd><dd><code>value</code> - The value to the dictionary object.</dd></dl> +</li> +</ul> +<a name="setBoolean(org.apache.pdfbox.cos.COSName, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBoolean</h4> +<pre>public void setBoolean(<a href="../../../../org/apache/pdfbox/cos/COSName.html" title="class in org.apache.pdfbox.cos">COSName</a> key, + boolean value)</pre> +<div class="block">This will set an item in the dictionary.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - The key to the dictionary object.</dd><dd><code>value</code> - The value to the dictionary object.</dd></dl> +</li> +</ul> +<a name="setItem(java.lang.String, org.apache.pdfbox.cos.COSBase)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setItem</h4> +<pre>public void setItem(<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)</pre> +<div class="block">This will set an item in the dictionary. If value is null then the result will be the same as removeItem( key ).</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - The key to the dictionary object.</dd><dd><code>value</code> - The value to the dictionary object.</dd></dl> +</li> +</ul> +<a name="setName(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>public void setName(<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)</pre> +<div class="block">This is a convenience method that will convert the value to a COSName object. If it is null then the object will + be removed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - The key to the object,</dd><dd><code>value</code> - The string value for the name.</dd></dl> +</li> +</ul> +<a name="setName(org.apache.pdfbox.cos.COSName, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>public void setName(<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)</pre> +<div class="block">This is a convenience method that will convert the value to a COSName object. If it is null then the object will + be removed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - The key to the object,</dd><dd><code>value</code> - The string value for the name.</dd></dl> +</li> +</ul> +<a name="setDate(java.lang.String, java.util.Calendar)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDate</h4> +<pre>public void setDate(<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)</pre> +<div class="block">Set the value of a date entry in the dictionary.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - The key to the date value.</dd><dd><code>date</code> - The date value.</dd></dl> +</li> +</ul> +<a name="setDate(org.apache.pdfbox.cos.COSName, java.util.Calendar)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDate</h4> +<pre>public void setDate(<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)</pre> +<div class="block">Set the date object.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - The key to the date.</dd><dd><code>date</code> - The date to set.</dd></dl> +</li> +</ul> +<a name="setEmbeddedDate(java.lang.String, java.lang.String, java.util.Calendar)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEmbeddedDate</h4> +<pre>public void setEmbeddedDate(<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, + <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)</pre> +<div class="block">Set the value of a date entry in the dictionary.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>embedded</code> - The embedded dictionary.</dd><dd><code>key</code> - The key to the date value.</dd><dd><code>date</code> - The date value.</dd></dl> +</li> +</ul> +<a name="se
<TRUNCATED>
