http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/37d0891c/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSStream.html ---------------------------------------------------------------------- diff --git a/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSStream.html b/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSStream.html new file mode 100644 index 0000000..62f761b --- /dev/null +++ b/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSStream.html @@ -0,0 +1,629 @@ +<!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>COSStream (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="COSStream (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/COSStream.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/COSObject.html" title="class in org.apache.pdfbox.cos"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pdfbox/cos/COSString.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/COSStream.html" target="_top">Frames</a></li> +<li><a href="COSStream.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="#fields_inherited_from_class_org.apache.pdfbox.cos.COSDictionary">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>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 COSStream" class="title">Class COSStream</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><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">org.apache.pdfbox.cos.COSDictionary</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.pdfbox.cos.COSStream</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/Closeable.html?is-external=true"; title="class or interface in java.io">Closeable</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a>, <a href="../../../../org/apache/pdfbox/pdmodel/common/COSObjectable.html" title="interface in org.apache.pdfbox.pdmodel.common">COSObjectable</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../org/apache/pdfbox/pdmodel/common/COSStreamArray.html" title="class in org.apache.pdfbox.pdmodel.common">COSStreamArray</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">COSStream</span> +extends <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> +implements <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/Closeable.html?is-external=true"; title="class or interface in java.io">Closeable</a></pre> +<div class="block">This class represents a stream object in a PDF document.</div> +<dl><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> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.pdfbox.cos.COSDictionary"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.pdfbox.cos.<a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a></h3> +<code><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#items">items</a></code></li> +</ul> +</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/COSStream.html#COSStream(org.apache.pdfbox.cos.COSDictionary,%20org.apache.pdfbox.io.RandomAccess)">COSStream</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> dictionary, + <a href="../../../../org/apache/pdfbox/io/RandomAccess.html" title="interface in org.apache.pdfbox.io">RandomAccess</a> storage)</code> +<div class="block">Constructor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSStream.html#COSStream(org.apache.pdfbox.io.RandomAccess)">COSStream</a></strong>(<a href="../../../../org/apache/pdfbox/io/RandomAccess.html" title="interface in org.apache.pdfbox.io">RandomAccess</a> storage)</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/COSStream.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/COSStream.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSStream.html#createFilteredStream()">createFilteredStream</a></strong>()</code> +<div class="block">This will create a new stream for which filtered byte should be + written to.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSStream.html#createFilteredStream(org.apache.pdfbox.cos.COSBase)">createFilteredStream</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a> expectedLength)</code> +<div class="block">This will create a new stream for which filtered byte should be + written to.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSStream.html#createUnfilteredStream()">createUnfilteredStream</a></strong>()</code> +<div class="block">This will create an output stream that can be written to.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSStream.html#getFilteredLength()">getFilteredLength</a></strong>()</code> +<div class="block">This will get the length of the encoded stream.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSStream.html#getFilteredLengthWritten()">getFilteredLengthWritten</a></strong>()</code> +<div class="block">This will get the length of the data written in the encoded stream.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSStream.html#getFilteredStream()">getFilteredStream</a></strong>()</code> +<div class="block">This will get the stream with all of the filters applied.</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/COSStream.html#getFilters()">getFilters</a></strong>()</code> +<div class="block">This will return the filters to apply to the byte stream.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/pdfbox/io/RandomAccess.html" title="interface in org.apache.pdfbox.io">RandomAccess</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSStream.html#getScratchFile()">getScratchFile</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>the direct access to the scratch file will be removed.</i></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="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/COSStream.html#getStreamTokens()">getStreamTokens</a></strong>()</code> +<div class="block">This will get all the tokens in the stream.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSStream.html#getUnfilteredStream()">getUnfilteredStream</a></strong>()</code> +<div class="block">This will get the logical content stream with none of the filters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSStream.html#replaceWithStream(org.apache.pdfbox.cos.COSStream)">replaceWithStream</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSStream.html" title="class in org.apache.pdfbox.cos">COSStream</a> stream)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>will be removed</i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSStream.html#setFilteredLength(long)">setFilteredLength</a></strong>(long length)</code> +<div class="block">This will set the expected length of the encoded stream.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSStream.html#setFilters(org.apache.pdfbox.cos.COSBase)">setFilters</a></strong>(<a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a> filters)</code> +<div class="block">set the filters to be applied to the stream.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.pdfbox.cos.COSDictionary"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.pdfbox.cos.<a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a></h3> +<code><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#addAll(org.apache.pdfbox.cos.COSDictionary)">addAll</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#clear()">clear</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#containsKey(org.apache.pdfbox.cos.COSName)">containsKey</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#containsKey(java.lang.String)">containsKey</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#containsValue(java.lang.Object)">containsValue</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#entrySet()">entrySet</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getBoolean(org.apache.pdfbox.cos.COSName,%20boolean)">getBoolean</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getBoolean(org.apache.pdfbox.cos.COSName,%20org.apache.pdfbox.cos.COSName,%20boolean)">getBoolean</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.h tml#getBoolean(java.lang.String,%20boolean)">getBoolean</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getDate(org.apache.pdfbox.cos.COSName)">getDate</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getDate(org.apache.pdfbox.cos.COSName,%20java.util.Calendar)">getDate</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getDate(java.lang.String)">getDate</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getDate(java.lang.String,%20java.util.Calendar)">getDate</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getDictionaryObject(org.apache.pdfbox.cos.COSName)">getDictionaryObject</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getDictionaryObject(org.apache.pdfbox.cos.COSName,%20org.apache.pdfbox.cos.COSName)">getDictionaryObject</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getDictionaryObject(java.lang.String)">getDictionaryObject</a>, <a href="../../../../ org/apache/pdfbox/cos/COSDictionary.html#getDictionaryObject(java.lang.String[])">getDictionaryObject</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getDictionaryObject(java.lang.String,%20java.lang.String)">getDictionaryObject</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getEmbeddedDate(java.lang.String,%20org.apache.pdfbox.cos.COSName)">getEmbeddedDate</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getEmbeddedDate(java.lang.String,%20org.apache.pdfbox.cos.COSName,%20java.util.Calendar)">getEmbeddedDate</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getEmbeddedDate(java.lang.String,%20java.lang.String)">getEmbeddedDate</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getEmbeddedDate(java.lang.String,%20java.lang.String,%20java.util.Calendar)">getEmbeddedDate</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getEmbeddedInt(java.lang.String,%20org.apache.pdfbox.cos.COS Name)">getEmbeddedInt</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getEmbeddedInt(java.lang.String,%20org.apache.pdfbox.cos.COSName,%20int)">getEmbeddedInt</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getEmbeddedInt(java.lang.String,%20java.lang.String)">getEmbeddedInt</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getEmbeddedInt(java.lang.String,%20java.lang.String,%20int)">getEmbeddedInt</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getEmbeddedString(java.lang.String,%20org.apache.pdfbox.cos.COSName)">getEmbeddedString</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getEmbeddedString(java.lang.String,%20org.apache.pdfbox.cos.COSName,%20java.lang.String)">getEmbeddedString</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getEmbeddedString(java.lang.String,%20java.lang.String)">getEmbeddedString</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#g etEmbeddedString(java.lang.String,%20java.lang.String,%20java.lang.String)">getEmbeddedString</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getFloat(org.apache.pdfbox.cos.COSName)">getFloat</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getFloat(org.apache.pdfbox.cos.COSName,%20float)">getFloat</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getFloat(java.lang.String)">getFloat</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getFloat(java.lang.String,%20float)">getFloat</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getInt(org.apache.pdfbox.cos.COSName)">getInt</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getInt(org.apache.pdfbox.cos.COSName,%20org.apache.pdfbox.cos.COSName)">getInt</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getInt(org.apache.pdfbox.cos.COSName,%20org.apache.pdfbox.cos.COSName,%20int)">getInt</a>, <a href="../../../../org/a pache/pdfbox/cos/COSDictionary.html#getInt(org.apache.pdfbox.cos.COSName,%20int)">getInt</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getInt(java.lang.String)">getInt</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getInt(java.lang.String[],%20int)">getInt</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getInt(java.lang.String,%20int)">getInt</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getItem(org.apache.pdfbox.cos.COSName)">getItem</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getItem(java.lang.String)">getItem</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getKeyForValue(java.lang.Object)">getKeyForValue</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getLong(org.apache.pdfbox.cos.COSName)">getLong</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getLong(org.apache.pdfbox.cos.COSName,%20long)">getLong</a>, <a href="../../. ./../org/apache/pdfbox/cos/COSDictionary.html#getLong(java.lang.String)">getLong</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getLong(java.lang.String[],%20long)">getLong</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getLong(java.lang.String,%20long)">getLong</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getNameAsString(org.apache.pdfbox.cos.COSName)">getNameAsString</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getNameAsString(org.apache.pdfbox.cos.COSName,%20java.lang.String)">getNameAsString</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getNameAsString(java.lang.String)">getNameAsString</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getNameAsString(java.lang.String,%20java.lang.String)">getNameAsString</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getObjectFromPath(java.lang.String)">getObjectFromPath</a>, <a href="../../../../org/apac he/pdfbox/cos/COSDictionary.html#getString(org.apache.pdfbox.cos.COSName)">getString</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getString(org.apache.pdfbox.cos.COSName,%20java.lang.String)">getString</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getString(java.lang.String)">getString</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getString(java.lang.String,%20java.lang.String)">getString</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#getValues()">getValues</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#keyList()">keyList</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#keySet()">keySet</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#mergeInto(org.apache.pdfbox.cos.COSDictionary)">mergeInto</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#removeItem(org.apache.pdfbox.cos.COSName)">removeItem</a>, <a href="../../../../org/apach e/pdfbox/cos/COSDictionary.html#setBoolean(org.apache.pdfbox.cos.COSName,%20boolean)">setBoolean</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setBoolean(java.lang.String,%20boolean)">setBoolean</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setDate(org.apache.pdfbox.cos.COSName,%20java.util.Calendar)">setDate</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setDate(java.lang.String,%20java.util.Calendar)">setDate</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setEmbeddedDate(java.lang.String,%20org.apache.pdfbox.cos.COSName,%20java.util.Calendar)">setEmbeddedDate</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setEmbeddedDate(java.lang.String,%20java.lang.String,%20java.util.Calendar)">setEmbeddedDate</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setEmbeddedInt(java.lang.String,%20org.apache.pdfbox.cos.COSName,%20int)">setEmbeddedInt</a>, <a href="../../../../org/a pache/pdfbox/cos/COSDictionary.html#setEmbeddedInt(java.lang.String,%20java.lang.String,%20int)">setEmbeddedInt</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setEmbeddedString(java.lang.String,%20org.apache.pdfbox.cos.COSName,%20java.lang.String)">setEmbeddedString</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setEmbeddedString(java.lang.String,%20java.lang.String,%20java.lang.String)">setEmbeddedString</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setFloat(org.apache.pdfbox.cos.COSName,%20float)">setFloat</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setFloat(java.lang.String,%20float)">setFloat</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setInt(org.apache.pdfbox.cos.COSName,%20int)">setInt</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setInt(java.lang.String,%20int)">setInt</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setItem(org.apa che.pdfbox.cos.COSName,%20org.apache.pdfbox.cos.COSBase)">setItem</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setItem(org.apache.pdfbox.cos.COSName,%20org.apache.pdfbox.pdmodel.common.COSObjectable)">setItem</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setItem(java.lang.String,%20org.apache.pdfbox.cos.COSBase)">setItem</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setItem(java.lang.String,%20org.apache.pdfbox.pdmodel.common.COSObjectable)">setItem</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setLong(org.apache.pdfbox.cos.COSName,%20long)">setLong</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setLong(java.lang.String,%20long)">setLong</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setName(org.apache.pdfbox.cos.COSName,%20java.lang.String)">setName</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setName(java.lang.String,%20java.lang.String )">setName</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setString(org.apache.pdfbox.cos.COSName,%20java.lang.String)">setString</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#setString(java.lang.String,%20java.lang.String)">setString</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#size()">size</a>, <a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#toString()">toString</a></code></li> +</ul> +<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="COSStream(org.apache.pdfbox.io.RandomAccess)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COSStream</h4> +<pre>public COSStream(<a href="../../../../org/apache/pdfbox/io/RandomAccess.html" title="interface in org.apache.pdfbox.io">RandomAccess</a> storage)</pre> +<div class="block">Constructor. Creates a new stream with an empty dictionary.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storage</code> - The intermediate storage for the stream.</dd></dl> +</li> +</ul> +<a name="COSStream(org.apache.pdfbox.cos.COSDictionary, org.apache.pdfbox.io.RandomAccess)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>COSStream</h4> +<pre>public COSStream(<a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</a> dictionary, + <a href="../../../../org/apache/pdfbox/io/RandomAccess.html" title="interface in org.apache.pdfbox.io">RandomAccess</a> storage)</pre> +<div class="block">Constructor.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dictionary</code> - The dictionary that is associated with this stream.</dd><dd><code>storage</code> - The intermediate storage for the stream.</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="replaceWithStream(org.apache.pdfbox.cos.COSStream)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>replaceWithStream</h4> +<pre>public void replaceWithStream(<a href="../../../../org/apache/pdfbox/cos/COSStream.html" title="class in org.apache.pdfbox.cos">COSStream</a> stream)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>will be removed</i></div> +<div class="block">This will replace this object with the data from the new object. This + is used to easily maintain referential integrity when changing references + to new objects.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - The stream that have the new values in it.</dd></dl> +</li> +</ul> +<a name="getScratchFile()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getScratchFile</h4> +<pre>public <a href="../../../../org/apache/pdfbox/io/RandomAccess.html" title="interface in org.apache.pdfbox.io">RandomAccess</a> getScratchFile()</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>the direct access to the scratch file will be removed.</i></div> +<div class="block">This will get the scratch file associated with this stream.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The scratch file where this stream is being stored.</dd></dl> +</li> +</ul> +<a name="getStreamTokens()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStreamTokens</h4> +<pre>public <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="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>> getStreamTokens() + throws <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">This will get all the tokens in the stream.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>All of the tokens in the stream.</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 parsing the stream.</dd></dl> +</li> +</ul> +<a name="getFilteredStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilteredStream</h4> +<pre>public <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a> getFilteredStream() + throws <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">This will get the stream with all of the filters applied.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the bytes of the physical (endoced) stream</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> - when encoding/decoding causes an exception</dd></dl> +</li> +</ul> +<a name="getFilteredLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilteredLength</h4> +<pre>public long getFilteredLength() + throws <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">This will get the length of the encoded stream.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the length of the encoded stream as long</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></dd></dl> +</li> +</ul> +<a name="setFilteredLength(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFilteredLength</h4> +<pre>public void setFilteredLength(long length)</pre> +<div class="block">This will set the expected length of the encoded stream. Call this method + if the previously set expected length is wrong, to avoid further trouble.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>length</code> - the expected length of the encoded stream.</dd></dl> +</li> +</ul> +<a name="getFilteredLengthWritten()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilteredLengthWritten</h4> +<pre>public long getFilteredLengthWritten() + throws <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">This will get the length of the data written in the encoded stream.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the length of the data written in the encoded stream as long</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></dd></dl> +</li> +</ul> +<a name="getUnfilteredStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUnfilteredStream</h4> +<pre>public <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a> getUnfilteredStream() + throws <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">This will get the logical content stream with none of the filters.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the bytes of the logical (decoded) stream</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> - when encoding/decoding causes an exception</dd></dl> +</li> +</ul> +<a name="accept(org.apache.pdfbox.cos.ICOSVisitor)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>accept</h4> +<pre>public <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> accept(<a href="../../../../org/apache/pdfbox/cos/ICOSVisitor.html" title="interface in org.apache.pdfbox.cos">ICOSVisitor</a> visitor) + throws <a href="../../../../org/apache/pdfbox/exceptions/COSVisitorException.html" title="class in org.apache.pdfbox.exceptions">COSVisitorException</a></pre> +<div class="block">visitor pattern double dispatch method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html#accept(org.apache.pdfbox.cos.ICOSVisitor)">accept</a></code> in class <code><a href="../../../../org/apache/pdfbox/cos/COSDictionary.html" title="class in org.apache.pdfbox.cos">COSDictionary</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="getFilters()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilters</h4> +<pre>public <a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a> getFilters()</pre> +<div class="block">This will return the filters to apply to the byte stream. + The method will return + - null if no filters are to be applied + - a COSName if one filter is to be applied + - a COSArray containing COSNames if multiple filters are to be applied</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the COSBase object representing the filters</dd></dl> +</li> +</ul> +<a name="createFilteredStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createFilteredStream</h4> +<pre>public <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> createFilteredStream() + 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 create a new stream for which filtered byte should be + written to. You probably don't want this but want to use the + createUnfilteredStream, which is used to write raw bytes to.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>A stream that can be written 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 creating the stream.</dd></dl> +</li> +</ul> +<a name="createFilteredStream(org.apache.pdfbox.cos.COSBase)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createFilteredStream</h4> +<pre>public <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> createFilteredStream(<a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a> expectedLength) + 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 create a new stream for which filtered byte should be + written to. You probably don't want this but want to use the + createUnfilteredStream, which is used to write raw bytes to.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>expectedLength</code> - An entry where a length is expected.</dd> +<dt><span class="strong">Returns:</span></dt><dd>A stream that can be written 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 creating the stream.</dd></dl> +</li> +</ul> +<a name="setFilters(org.apache.pdfbox.cos.COSBase)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFilters</h4> +<pre>public void setFilters(<a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a> filters) + 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">set the filters to be applied to the stream.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filters</code> - The filters to set on this stream.</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 clearing the old filters.</dd></dl> +</li> +</ul> +<a name="createUnfilteredStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createUnfilteredStream</h4> +<pre>public <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> createUnfilteredStream() + 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 create an output stream that can be written to.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>An output stream which raw data bytes should be written 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 creating the stream.</dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/Closeable.html?is-external=true#close()" title="class or interface in java.io">close</a></code> in interface <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/Closeable.html?is-external=true"; title="class or interface in java.io">Closeable</a></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang">close</a></code> in interface <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a></code></dd> +</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/COSStream.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/COSObject.html" title="class in org.apache.pdfbox.cos"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pdfbox/cos/COSString.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/COSStream.html" target="_top">Frames</a></li> +<li><a href="COSStream.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="#fields_inherited_from_class_org.apache.pdfbox.cos.COSDictionary">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>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>
http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/37d0891c/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSString.html ---------------------------------------------------------------------- diff --git a/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSString.html b/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSString.html new file mode 100644 index 0000000..983220b --- /dev/null +++ b/content/docs/1.8.11/javadocs/org/apache/pdfbox/cos/COSString.html @@ -0,0 +1,786 @@ +<!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>COSString (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="COSString (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/COSString.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/COSStream.html" title="class in org.apache.pdfbox.cos"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pdfbox/cos/COSUnread.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/COSString.html" target="_top">Frames</a></li> +<li><a href="COSString.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 COSString" class="title">Class COSString</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.COSString</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">COSString</span> +extends <a href="../../../../org/apache/pdfbox/cos/COSBase.html" title="class in org.apache.pdfbox.cos">COSBase</a></pre> +<div class="block">This represents a string object in a PDF document.</div> +<dl><dt><span class="strong">Version:</span></dt> + <dd>$Revision: 1.30 $</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 byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSString.html#BS_ESCAPE">BS_ESCAPE</a></strong></code> +<div class="block">BS escape characters.</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/COSString.html#CR_ESCAPE">CR_ESCAPE</a></strong></code> +<div class="block">CR escape characters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSString.html#ESCAPE">ESCAPE</a></strong></code> +<div class="block">the escape character in strings.</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/COSString.html#FF_ESCAPE">FF_ESCAPE</a></strong></code> +<div class="block">FF escape characters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSString.html#HEX_STRING_CLOSE">HEX_STRING_CLOSE</a></strong></code> +<div class="block">One of the close string tokens.</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/COSString.html#HEX_STRING_OPEN">HEX_STRING_OPEN</a></strong></code> +<div class="block">One of the open string tokens.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSString.html#HT_ESCAPE">HT_ESCAPE</a></strong></code> +<div class="block">HT escape characters.</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/COSString.html#LF_ESCAPE">LF_ESCAPE</a></strong></code> +<div class="block">LF escape characters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSString.html#STRING_CLOSE">STRING_CLOSE</a></strong></code> +<div class="block">One of the close string tokens.</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/COSString.html#STRING_OPEN">STRING_OPEN</a></strong></code> +<div class="block">One of the open string tokens.</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/COSString.html#COSString()">COSString</a></strong>()</code> +<div class="block">Constructor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSString.html#COSString(boolean)">COSString</a></strong>(boolean isDictionaryValue)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Not needed anymore. Use <a href="../../../../org/apache/pdfbox/cos/COSString.html#COSString()"><code>COSString()</code></a> instead. PDFBOX-1437</i></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSString.html#COSString(byte[])">COSString</a></strong>(byte[] value)</code> +<div class="block">Explicit constructor for ease of manual PDF construction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSString.html#COSString(java.lang.String)">COSString</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> value)</code> +<div class="block">Explicit constructor for ease of manual PDF construction.</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/COSString.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/COSString.html#append(byte[])">append</a></strong>(byte[] data)</code> +<div class="block">This will append a byte[] to the string.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSString.html#append(int)">append</a></strong>(int in)</code> +<div class="block">This will append a byte to the string.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/pdfbox/cos/COSString.html" title="class in org.apache.pdfbox.cos">COSString</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSString.html#createFromHexString(java.lang.String)">createFromHexString</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> hex)</code> +<div class="block">This will create a COS string from a string of hex characters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/pdfbox/cos/COSString.html" title="class in org.apache.pdfbox.cos">COSString</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSString.html#createFromHexString(java.lang.String,%20boolean)">createFromHexString</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> hex, + boolean force)</code> +<div class="block">Creates a COS string from a string of hex characters, optionally ignoring malformed input.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSString.html#equals(java.lang.Object)">equals</a></strong>(<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> obj)</code></td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSString.html#getBytes()">getBytes</a></strong>()</code> +<div class="block">This will get the bytes of the string.</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/COSString.html#getHexString()">getHexString</a></strong>()</code> +<div class="block">This will take this string and create a hex representation of the bytes that make the string.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSString.html#getString()">getString</a></strong>()</code> +<div class="block">This will get the string that this object wraps.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSString.html#hashCode()">hashCode</a></strong>()</code></td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSString.html#reset()">reset</a></strong>()</code> +<div class="block">This will reset the internal buffer.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSString.html#setForceHexForm(boolean)">setForceHexForm</a></strong>(boolean v)</code> +<div class="block">Forces the string to be written in hexadecimal form instead of literal form.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSString.html#setForceLiteralForm(boolean)">setForceLiteralForm</a></strong>(boolean v)</code> +<div class="block">Forces the string to be written in literal form instead of hexadecimal form.</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/COSString.html#toString()">toString</a></strong>()</code></td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/cos/COSString.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#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#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.orac le.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="STRING_OPEN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>STRING_OPEN</h4> +<pre>public static final byte[] STRING_OPEN</pre> +<div class="block">One of the open string tokens.</div> +</li> +</ul> +<a name="STRING_CLOSE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>STRING_CLOSE</h4> +<pre>public static final byte[] STRING_CLOSE</pre> +<div class="block">One of the close string tokens.</div> +</li> +</ul> +<a name="HEX_STRING_OPEN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HEX_STRING_OPEN</h4> +<pre>public static final byte[] HEX_STRING_OPEN</pre> +<div class="block">One of the open string tokens.</div> +</li> +</ul> +<a name="HEX_STRING_CLOSE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HEX_STRING_CLOSE</h4> +<pre>public static final byte[] HEX_STRING_CLOSE</pre> +<div class="block">One of the close string tokens.</div> +</li> +</ul> +<a name="ESCAPE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ESCAPE</h4> +<pre>public static final byte[] ESCAPE</pre> +<div class="block">the escape character in strings.</div> +</li> +</ul> +<a name="CR_ESCAPE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CR_ESCAPE</h4> +<pre>public static final byte[] CR_ESCAPE</pre> +<div class="block">CR escape characters.</div> +</li> +</ul> +<a name="LF_ESCAPE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LF_ESCAPE</h4> +<pre>public static final byte[] LF_ESCAPE</pre> +<div class="block">LF escape characters.</div> +</li> +</ul> +<a name="HT_ESCAPE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HT_ESCAPE</h4> +<pre>public static final byte[] HT_ESCAPE</pre> +<div class="block">HT escape characters.</div> +</li> +</ul> +<a name="BS_ESCAPE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BS_ESCAPE</h4> +<pre>public static final byte[] BS_ESCAPE</pre> +<div class="block">BS escape characters.</div> +</li> +</ul> +<a name="FF_ESCAPE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FF_ESCAPE</h4> +<pre>public static final byte[] FF_ESCAPE</pre> +<div class="block">FF escape characters.</div> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="COSString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COSString</h4> +<pre>public COSString()</pre> +<div class="block">Constructor.</div> +</li> +</ul> +<a name="COSString(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COSString</h4> +<pre><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public COSString(boolean isDictionaryValue)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>Not needed anymore. Use <a href="../../../../org/apache/pdfbox/cos/COSString.html#COSString()"><code>COSString()</code></a> instead. PDFBOX-1437</i></div> +<div class="block">Constructor.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>isDictionaryValue</code> - determines if this string represents a dictionary</dd></dl> +</li> +</ul> +<a name="COSString(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COSString</h4> +<pre>public COSString(<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> value)</pre> +<div class="block">Explicit constructor for ease of manual PDF construction.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The string value of the object.</dd></dl> +</li> +</ul> +<a name="COSString(byte[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>COSString</h4> +<pre>public COSString(byte[] value)</pre> +<div class="block">Explicit constructor for ease of manual PDF construction.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The string value of the object.</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="setForceLiteralForm(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setForceLiteralForm</h4> +<pre>public void setForceLiteralForm(boolean v)</pre> +<div class="block">Forces the string to be written in literal form instead of hexadecimal form.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - if v is true the string will be written in literal form, otherwise it will be written in hexa if + necessary.</dd></dl> +</li> +</ul> +<a name="setForceHexForm(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setForceHexForm</h4> +<pre>public void setForceHexForm(boolean v)</pre> +<div class="block">Forces the string to be written in hexadecimal form instead of literal form.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - if v is true the string will be written in hexadecimal form otherwise it will be written in literal if + necessary.</dd></dl> +</li> +</ul> +<a name="createFromHexString(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createFromHexString</h4> +<pre>public static <a href="../../../../org/apache/pdfbox/cos/COSString.html" title="class in org.apache.pdfbox.cos">COSString</a> createFromHexString(<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> hex) + 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 create a COS string from a string of hex characters.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>hex</code> - A hex string.</dd> +<dt><span class="strong">Returns:</span></dt><dd>A cos string with the hex characters converted to their actual bytes.</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 hex string.</dd></dl> +</li> +</ul> +<a name="createFromHexString(java.lang.String, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createFromHexString</h4> +<pre>public static <a href="../../../../org/apache/pdfbox/cos/COSString.html" title="class in org.apache.pdfbox.cos">COSString</a> createFromHexString(<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> hex, + boolean force) + 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">Creates a COS string from a string of hex characters, optionally ignoring malformed input.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>hex</code> - A hex string.</dd><dd><code>force</code> - flag to ignore malformed input</dd> +<dt><span class="strong">Returns:</span></dt><dd>A cos string with the hex characters converted to their actual bytes.</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 hex string.</dd></dl> +</li> +</ul> +<a name="getHexString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHexString</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> getHexString()</pre> +<div class="block">This will take this string and create a hex representation of the bytes that make the string.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>A hex string representing the bytes in this string.</dd></dl> +</li> +</ul> +<a name="getString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getString</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> getString()</pre> +<div class="block">This will get the string that this object wraps.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The wrapped string.</dd></dl> +</li> +</ul> +<a name="append(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>append</h4> +<pre>public void append(byte[] data) + 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 append a byte[] to the string.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - The byte[] to add to this string.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - If an IO error occurs while writing the byte.</dd></dl> +</li> +</ul> +<a name="append(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>append</h4> +<pre>public void append(int in) + 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 append a byte to the string.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - The byte to add to this string.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - If an IO error occurs while writing the byte.</dd></dl> +</li> +</ul> +<a name="reset()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reset</h4> +<pre>public void reset()</pre> +<div class="block">This will reset the internal buffer.</div> +</li> +</ul> +<a name="getBytes()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBytes</h4> +<pre>public byte[] getBytes()</pre> +<div class="block">This will get the bytes of the string.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>A byte array that represents the string.</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="writePDF(java.io.OutputStream)"> +<!-- --> +</a> +<ul class="blockList"> +<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> +<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="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(<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> obj)</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#equals(java.lang.Object)" title="class or interface in java.lang">equals</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="hashCode()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</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#hashCode()" title="class or interface in java.lang">hashCode</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> +</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/COSString.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/COSStream.html" title="class in org.apache.pdfbox.cos"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/pdfbox/cos/COSUnread.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/COSString.html" target="_top">Frames</a></li> +<li><a href="COSString.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>
