http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/37d0891c/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSNull.html ---------------------------------------------------------------------- diff --git a/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSNull.html b/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSNull.html new file mode 100644 index 0000000..9d314de --- /dev/null +++ b/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSNull.html @@ -0,0 +1,331 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="de"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Sat Mar 26 09:48:31 CET 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>COSNull (Apache PDFBox 1.8.11 API)</title> +<meta name="date" content="2016-03-26"> +<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="COSNull (Apache PDFBox 1.8.11 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/COSNull.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/COSName.html" title="class in org.apache.pdfbox.cos"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pdfbox/cos/COSNumber.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/COSNull.html" target="_top">Frames</a></li> +<li><a href="COSNull.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>Constr | </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>Constr | </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 COSNull" class="title">Class COSNull</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">org.apache.pdfbox.cos.COSBase</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.pdfbox.cos.COSNull</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/pdmodel/common/COSObjectable.html" title="interface in org.apache.pdfbox.pdmodel.common">COSObjectable</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">COSNull</span> +extends <a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a></pre> +<div class="block">This class represents a null PDF object.</div> +<dl><dt><span class="strong">Version:</span></dt> + <dd>$Revision: 1.13 $</dd> +<dt><span class="strong">Author:</span></dt> + <dd><a href="mailto:b...@benlitchfield.com";>Ben Litchfield</a></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>static <a href="../../../../org/apache/pdfbox/cos/COSNull.html" title="class in org.apache.pdfbox.cos">COSNull</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSNull.html#NULL">NULL</a></strong></code> +<div class="block">The one null object in the system.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSNull.html#NULL_BYTES">NULL_BYTES</a></strong></code> +<div class="block">The null token.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSNull.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/COSNull.html#writePDF(java.io.OutputStream)">writePDF</a></strong>(<a href="http://download.oracle.com/javase/1.5.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> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.pdfbox.cos.COSBase"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.pdfbox.cos.<a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a></h3> +<code><a href="../../../../org/apache/pdfbox/cos/COSBase.html#getCOSObject()">getCOSObject</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#getFilterManager()">getFilterManager</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#isDirect()">isDirect</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#isNeedToBeUpdate()">isNeedToBeUpdate</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#setDirect(boolean)">setDirect</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#setNeedToBeUpdate(boolean)">setNeedToBeUpdate</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="ht tp://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long,%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="NULL_BYTES"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NULL_BYTES</h4> +<pre>public static final byte[] NULL_BYTES</pre> +<div class="block">The null token.</div> +</li> +</ul> +<a name="NULL"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>NULL</h4> +<pre>public static final <a href="../../../../org/apache/pdfbox/cos/COSNull.html" title="class in org.apache.pdfbox.cos">COSNull</a> NULL</pre> +<div class="block">The one null object in the system.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="accept(org.apache.pdfbox.cos.ICOSVisitor)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>accept</h4> +<pre>public <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> accept(<a href="../../../../org/apache/pdfbox/cos/ICOSVisitor.html" title="interface in org.apache.pdfbox.cos">ICOSVisitor</a> visitor) + throws <a href="../../../../org/apache/pdfbox/exceptions/COSVisitorException.html" title="class in org.apache.pdfbox.exceptions">COSVisitorException</a></pre> +<div class="block">visitor pattern double dispatch method.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/pdfbox/cos/COSBase.html#accept(org.apache.pdfbox.cos.ICOSVisitor)">accept</a></code> in class <code><a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>visitor</code> - The object to notify when visiting this object.</dd> +<dt><span class="strong">Returns:</span></dt><dd>any object, depending on the visitor implementation, or null</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/pdfbox/exceptions/COSVisitorException.html" title="class in org.apache.pdfbox.exceptions">COSVisitorException</a></code> - If an error occurs while visiting this object.</dd></dl> +</li> +</ul> +<a name="writePDF(java.io.OutputStream)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>writePDF</h4> +<pre>public void writePDF(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html?is-external=true"; title="class or interface in java.io">OutputStream</a> output) + throws <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">This will output this string as a PDF object.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>output</code> - The stream to write to.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - If there is an error writing to the stream.</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/COSNull.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/COSName.html" title="class in org.apache.pdfbox.cos"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pdfbox/cos/COSNumber.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/COSNull.html" target="_top">Frames</a></li> +<li><a href="COSNull.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </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>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2002-2016 <a href="http://pdfbox.apache.org";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/37d0891c/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSNumber.html ---------------------------------------------------------------------- diff --git a/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSNumber.html b/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSNumber.html new file mode 100644 index 0000000..777a089 --- /dev/null +++ b/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSNumber.html @@ -0,0 +1,418 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="de"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Sat Mar 26 09:48:31 CET 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>COSNumber (Apache PDFBox 1.8.11 API)</title> +<meta name="date" content="2016-03-26"> +<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="COSNumber (Apache PDFBox 1.8.11 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/COSNumber.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/COSNull.html" title="class in org.apache.pdfbox.cos"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pdfbox/cos/COSObject.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/COSNumber.html" target="_top">Frames</a></li> +<li><a href="COSNumber.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 COSNumber" class="title">Class COSNumber</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">org.apache.pdfbox.cos.COSBase</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.pdfbox.cos.COSNumber</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/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/COSFloat.html" title="class in org.apache.pdfbox.cos">COSFloat</a>, <a href="../../../../org/apache/pdfbox/cos/COSInteger.html" title="class in org.apache.pdfbox.cos">COSInteger</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">COSNumber</span> +extends <a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a></pre> +<div class="block">This class represents an abstract number in a PDF document.</div> +<dl><dt><span class="strong">Version:</span></dt> + <dd>$Revision: 1.10 $</dd> +<dt><span class="strong">Author:</span></dt> + <dd><a href="mailto:b...@benlitchfield.com";>Ben Litchfield</a></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>static <a href="../../../../org/apache/pdfbox/cos/COSInteger.html" title="class in org.apache.pdfbox.cos">COSInteger</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSNumber.html#ONE">ONE</a></strong></code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Use the <a href="../../../../org/apache/pdfbox/cos/COSInteger.html#ONE"><code>COSInteger.ONE</code></a> constant instead</i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/pdfbox/cos/COSInteger.html" title="class in org.apache.pdfbox.cos">COSInteger</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSNumber.html#ZERO">ZERO</a></strong></code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Use the <a href="../../../../org/apache/pdfbox/cos/COSInteger.html#ZERO"><code>COSInteger.ZERO</code></a> constant instead</i></div> +</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/COSNumber.html#COSNumber()">COSNumber</a></strong>()</code> </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>abstract double</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSNumber.html#doubleValue()">doubleValue</a></strong>()</code> +<div class="block">This will get the double value of this number.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract float</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSNumber.html#floatValue()">floatValue</a></strong>()</code> +<div class="block">This will get the float value of this number.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/pdfbox/cos/COSNumber.html" title="class in org.apache.pdfbox.cos">COSNumber</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSNumber.html#get(java.lang.String)">get</a></strong>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> number)</code> +<div class="block">This factory method will get the appropriate number object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSNumber.html#intValue()">intValue</a></strong>()</code> +<div class="block">This will get the integer value of this number.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSNumber.html#longValue()">longValue</a></strong>()</code> +<div class="block">This will get the long value of this number.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.pdfbox.cos.COSBase"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.pdfbox.cos.<a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a></h3> +<code><a href="../../../../org/apache/pdfbox/cos/COSBase.html#accept(org.apache.pdfbox.cos.ICOSVisitor)">accept</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#getCOSObject()">getCOSObject</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#getFilterManager()">getFilterManager</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#isDirect()">isDirect</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#isNeedToBeUpdate()">isNeedToBeUpdate</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#setDirect(boolean)">setDirect</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#setNeedToBeUpdate(boolean)">setNeedToBeUpdate</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="ht tp://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long,%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="ZERO"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ZERO</h4> +<pre>public static final <a href="../../../../org/apache/pdfbox/cos/COSInteger.html" title="class in org.apache.pdfbox.cos">COSInteger</a> ZERO</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>Use the <a href="../../../../org/apache/pdfbox/cos/COSInteger.html#ZERO"><code>COSInteger.ZERO</code></a> constant instead</i></div> +</li> +</ul> +<a name="ONE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ONE</h4> +<pre>public static final <a href="../../../../org/apache/pdfbox/cos/COSInteger.html" title="class in org.apache.pdfbox.cos">COSInteger</a> ONE</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>Use the <a href="../../../../org/apache/pdfbox/cos/COSInteger.html#ONE"><code>COSInteger.ONE</code></a> constant instead</i></div> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="COSNumber()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>COSNumber</h4> +<pre>public COSNumber()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="floatValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>floatValue</h4> +<pre>public abstract float floatValue()</pre> +<div class="block">This will get the float value of this number.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The float value of this object.</dd></dl> +</li> +</ul> +<a name="doubleValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>doubleValue</h4> +<pre>public abstract double doubleValue()</pre> +<div class="block">This will get the double value of this number.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The double value of this number.</dd></dl> +</li> +</ul> +<a name="intValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>intValue</h4> +<pre>public abstract int intValue()</pre> +<div class="block">This will get the integer value of this number.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The integer value of this number.</dd></dl> +</li> +</ul> +<a name="longValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>longValue</h4> +<pre>public abstract long longValue()</pre> +<div class="block">This will get the long value of this number.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The long value of this number.</dd></dl> +</li> +</ul> +<a name="get(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <a href="../../../../org/apache/pdfbox/cos/COSNumber.html" title="class in org.apache.pdfbox.cos">COSNumber</a> get(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> number) + throws <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">This factory method will get the appropriate number object.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>number</code> - The string representation of the number.</dd> +<dt><span class="strong">Returns:</span></dt><dd>A number object, either float or int.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - If the string is not a number.</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/COSNumber.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/COSNull.html" title="class in org.apache.pdfbox.cos"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pdfbox/cos/COSObject.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/COSNumber.html" target="_top">Frames</a></li> +<li><a href="COSNumber.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><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_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2002-2016 <a href="http://pdfbox.apache.org";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/37d0891c/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSObject.html ---------------------------------------------------------------------- diff --git a/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSObject.html b/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSObject.html new file mode 100644 index 0000000..881914a --- /dev/null +++ b/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSObject.html @@ -0,0 +1,457 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="de"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Sat Mar 26 09:48:31 CET 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>COSObject (Apache PDFBox 1.8.11 API)</title> +<meta name="date" content="2016-03-26"> +<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="COSObject (Apache PDFBox 1.8.11 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/COSObject.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/COSNumber.html" title="class in org.apache.pdfbox.cos"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pdfbox/cos/COSStream.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/COSObject.html" target="_top">Frames</a></li> +<li><a href="COSObject.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.pdfbox.cos</div> +<h2 title="Class COSObject" class="title">Class COSObject</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">org.apache.pdfbox.cos.COSBase</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.pdfbox.cos.COSObject</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/pdmodel/common/COSObjectable.html" title="interface in org.apache.pdfbox.pdmodel.common">COSObjectable</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">COSObject</span> +extends <a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a></pre> +<div class="block">This class represents a PDF object.</div> +<dl><dt><span class="strong">Version:</span></dt> + <dd>$Revision: 1.37 $</dd> +<dt><span class="strong">Author:</span></dt> + <dd><a href="mailto:b...@benlitchfield.com";>Ben Litchfield</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSObject.html#COSObject(org.apache.pdfbox.cos.COSBase)">COSObject</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a> object)</code> +<div class="block">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.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSObject.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><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/COSObject.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 the dictionary object in this object that has the name key and + if it is a pdfobjref then it will dereference that and return it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/cos/COSInteger.html" title="class in org.apache.pdfbox.cos">COSInteger</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSObject.html#getGenerationNumber()">getGenerationNumber</a></strong>()</code> +<div class="block">Getter for property generationNumber.</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/COSObject.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 get the dictionary object in this object that has the name key.</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/COSObject.html#getObject()">getObject</a></strong>()</code> +<div class="block">This will get the object that this object encapsulates.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/cos/COSInteger.html" title="class in org.apache.pdfbox.cos">COSInteger</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSObject.html#getObjectNumber()">getObjectNumber</a></strong>()</code> +<div class="block">Getter for property objectNumber.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSObject.html#setGenerationNumber(org.apache.pdfbox.cos.COSInteger)">setGenerationNumber</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSInteger.html" title="class in org.apache.pdfbox.cos">COSInteger</a> generationNumberValue)</code> +<div class="block">Setter for property generationNumber.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSObject.html#setObject(org.apache.pdfbox.cos.COSBase)">setObject</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a> object)</code> +<div class="block">This will set the object that this object encapsulates.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSObject.html#setObjectNumber(org.apache.pdfbox.cos.COSInteger)">setObjectNumber</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSInteger.html" title="class in org.apache.pdfbox.cos">COSInteger</a> objectNum)</code> +<div class="block">Setter for property objectNumber.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSObject.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#getFilterManager()">getFilterManager</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#isDirect()">isDirect</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#isNeedToBeUpdate()">isNeedToBeUpdate</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#setDirect(boolean)">setDirect</a>, <a href="../../../../org/apache/pdfbox/cos/COSBase.html#setNeedToBeUpdate(boolean)">setNeedToBeUpdate</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="ht tp://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long,%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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="COSObject(org.apache.pdfbox.cos.COSBase)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>COSObject</h4> +<pre>public COSObject(<a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a> object) + throws <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Constructor.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>object</code> - The object that this encapsulates.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - If there is an error with the object passed in.</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="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 the dictionary object in this object that has the name key and + if it is a pdfobjref then it will dereference that and return it.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - The key to the value that we are searching for.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The pdf object that matches the key.</dd></dl> +</li> +</ul> +<a name="getItem(org.apache.pdfbox.cos.COSName)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getItem</h4> +<pre>public <a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a> getItem(<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 the dictionary object in this object that has the name key.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - The key to the value that we are searching for.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The pdf object that matches the key.</dd></dl> +</li> +</ul> +<a name="getObject()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getObject</h4> +<pre>public <a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a> getObject()</pre> +<div class="block">This will get the object that this object encapsulates.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The encapsulated object.</dd></dl> +</li> +</ul> +<a name="setObject(org.apache.pdfbox.cos.COSBase)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setObject</h4> +<pre>public void setObject(<a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a> object) + throws <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">This will set the object that this object encapsulates.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>object</code> - The new object to encapsulate.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - If there is an error setting the updated object.</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="getObjectNumber()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getObjectNumber</h4> +<pre>public <a href="../../../../org/apache/pdfbox/cos/COSInteger.html" title="class in org.apache.pdfbox.cos">COSInteger</a> getObjectNumber()</pre> +<div class="block">Getter for property objectNumber.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Value of property objectNumber.</dd></dl> +</li> +</ul> +<a name="setObjectNumber(org.apache.pdfbox.cos.COSInteger)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setObjectNumber</h4> +<pre>public void setObjectNumber(<a href="../../../../org/apache/pdfbox/cos/COSInteger.html" title="class in org.apache.pdfbox.cos">COSInteger</a> objectNum)</pre> +<div class="block">Setter for property objectNumber.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>objectNum</code> - New value of property objectNumber.</dd></dl> +</li> +</ul> +<a name="getGenerationNumber()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getGenerationNumber</h4> +<pre>public <a href="../../../../org/apache/pdfbox/cos/COSInteger.html" title="class in org.apache.pdfbox.cos">COSInteger</a> getGenerationNumber()</pre> +<div class="block">Getter for property generationNumber.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Value of property generationNumber.</dd></dl> +</li> +</ul> +<a name="setGenerationNumber(org.apache.pdfbox.cos.COSInteger)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setGenerationNumber</h4> +<pre>public void setGenerationNumber(<a href="../../../../org/apache/pdfbox/cos/COSInteger.html" title="class in org.apache.pdfbox.cos">COSInteger</a> generationNumberValue)</pre> +<div class="block">Setter for property generationNumber.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>generationNumberValue</code> - New value of property generationNumber.</dd></dl> +</li> +</ul> +<a name="accept(org.apache.pdfbox.cos.ICOSVisitor)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>accept</h4> +<pre>public <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> accept(<a href="../../../../org/apache/pdfbox/cos/ICOSVisitor.html" title="interface in org.apache.pdfbox.cos">ICOSVisitor</a> visitor) + throws <a href="../../../../org/apache/pdfbox/exceptions/COSVisitorException.html" title="class in org.apache.pdfbox.exceptions">COSVisitorException</a></pre> +<div class="block">visitor pattern double dispatch method.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/pdfbox/cos/COSBase.html#accept(org.apache.pdfbox.cos.ICOSVisitor)">accept</a></code> in class <code><a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>visitor</code> - The object to notify when visiting this object.</dd> +<dt><span class="strong">Returns:</span></dt><dd>any object, depending on the visitor implementation, or null</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/pdfbox/exceptions/COSVisitorException.html" title="class in org.apache.pdfbox.exceptions">COSVisitorException</a></code> - If an error occurs while visiting this object.</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/COSObject.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/COSNumber.html" title="class in org.apache.pdfbox.cos"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pdfbox/cos/COSStream.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/COSObject.html" target="_top">Frames</a></li> +<li><a href="COSObject.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2002-2016 <a href="http://pdfbox.apache.org";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
