diff options
Diffstat (limited to 'docs/full/at/gv/egiz/pdfas/wrapper/FileDataSource.html')
| -rw-r--r-- | docs/full/at/gv/egiz/pdfas/wrapper/FileDataSource.html | 376 |
1 files changed, 376 insertions, 0 deletions
diff --git a/docs/full/at/gv/egiz/pdfas/wrapper/FileDataSource.html b/docs/full/at/gv/egiz/pdfas/wrapper/FileDataSource.html new file mode 100644 index 00000000..9b5b5f11 --- /dev/null +++ b/docs/full/at/gv/egiz/pdfas/wrapper/FileDataSource.html @@ -0,0 +1,376 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_51) on Thu Feb 20 10:19:18 CET 2014 --> +<title>FileDataSource</title> +<meta name="date" content="2014-02-20"> +<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="FileDataSource"; + } +//--> +</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="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="../../../../../at/gv/egiz/pdfas/wrapper/ByteArrayDataSource_OLD.html" title="class in at.gv.egiz.pdfas.wrapper"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../at/gv/egiz/pdfas/wrapper/LegacyMainTest.html" title="class in at.gv.egiz.pdfas.wrapper"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?at/gv/egiz/pdfas/wrapper/FileDataSource.html" target="_top">Frames</a></li> +<li><a href="FileDataSource.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">at.gv.egiz.pdfas.wrapper</div> +<h2 title="Class FileDataSource" class="title">Class FileDataSource</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>at.gv.egiz.pdfas.wrapper.FileDataSource</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../at/gv/egiz/pdfas/api/io/DataSource.html" title="interface in at.gv.egiz.pdfas.api.io">DataSource</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">FileDataSource</span> +extends java.lang.Object +implements <a href="../../../../../at/gv/egiz/pdfas/api/io/DataSource.html" title="interface in at.gv.egiz.pdfas.api.io">DataSource</a></pre> +</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="../../../../../at/gv/egiz/pdfas/wrapper/FileDataSource.html#FileDataSource(java.io.File)">FileDataSource</a></strong>(java.io.File file)</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>java.io.InputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/FileDataSource.html#createInputStream()">createInputStream</a></strong>()</code> +<div class="block">Creates a new InputStream that allows to read out the document's binary + data from the beginning.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/FileDataSource.html#getAsByteArray()">getAsByteArray</a></strong>()</code> +<div class="block">Returns the data of this DataSource as a byte array for random read only access.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/FileDataSource.html#getCharacterEncoding()">getCharacterEncoding</a></strong>()</code> +<div class="block">Returns the character encoding of the data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/FileDataSource.html#getLength()">getLength</a></strong>()</code> +<div class="block">Returns the length (number of bytes) of the stream.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../at/gv/egiz/pdfas/wrapper/FileDataSource.html#getMimeType()">getMimeType</a></strong>()</code> +<div class="block">Returns the mime type of the data.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="FileDataSource(java.io.File)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FileDataSource</h4> +<pre>public FileDataSource(java.io.File file) + throws java.io.FileNotFoundException, + java.io.IOException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.FileNotFoundException</code></dd> +<dd><code>java.io.IOException</code></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="createInputStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createInputStream</h4> +<pre>public java.io.InputStream createInputStream()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../at/gv/egiz/pdfas/api/io/DataSource.html#createInputStream()">DataSource</a></code></strong></div> +<div class="block">Creates a new InputStream that allows to read out the document's binary + data from the beginning.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/io/DataSource.html#createInputStream()">createInputStream</a></code> in interface <code><a href="../../../../../at/gv/egiz/pdfas/api/io/DataSource.html" title="interface in at.gv.egiz.pdfas.api.io">DataSource</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>Returns the InputStream with the binary data.</dd></dl> +</li> +</ul> +<a name="getLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLength</h4> +<pre>public int getLength()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../at/gv/egiz/pdfas/api/io/DataSource.html#getLength()">DataSource</a></code></strong></div> +<div class="block">Returns the length (number of bytes) of the stream.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/io/DataSource.html#getLength()">getLength</a></code> in interface <code><a href="../../../../../at/gv/egiz/pdfas/api/io/DataSource.html" title="interface in at.gv.egiz.pdfas.api.io">DataSource</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>Returns the length (number of bytes) of the stream.</dd></dl> +</li> +</ul> +<a name="getAsByteArray()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAsByteArray</h4> +<pre>public byte[] getAsByteArray()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../at/gv/egiz/pdfas/api/io/DataSource.html#getAsByteArray()">DataSource</a></code></strong></div> +<div class="block">Returns the data of this DataSource as a byte array for random read only access. + + <p> + Calling this method indicates that you need a byte array for random + <strong>read only</strong> access. The DataSource implementation should of + course cache this byte array to avoid too much memory usage. + </p> + <p> + Performance analysis has shown that the libraries internally convert the + streams to byte arrays and that file system access is very slow. + </p> + <p> + Never write to this byte array! + </p></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/io/DataSource.html#getAsByteArray()">getAsByteArray</a></code> in interface <code><a href="../../../../../at/gv/egiz/pdfas/api/io/DataSource.html" title="interface in at.gv.egiz.pdfas.api.io">DataSource</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>Returns the data of this DataSource as a byte array for random read only access.</dd></dl> +</li> +</ul> +<a name="getMimeType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMimeType</h4> +<pre>public java.lang.String getMimeType()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../at/gv/egiz/pdfas/api/io/DataSource.html#getMimeType()">DataSource</a></code></strong></div> +<div class="block">Returns the mime type of the data.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/io/DataSource.html#getMimeType()">getMimeType</a></code> in interface <code><a href="../../../../../at/gv/egiz/pdfas/api/io/DataSource.html" title="interface in at.gv.egiz.pdfas.api.io">DataSource</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>Returns the mime type of the data.</dd></dl> +</li> +</ul> +<a name="getCharacterEncoding()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getCharacterEncoding</h4> +<pre>public java.lang.String getCharacterEncoding()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../at/gv/egiz/pdfas/api/io/DataSource.html#getCharacterEncoding()">DataSource</a></code></strong></div> +<div class="block">Returns the character encoding of the data. + + <p> + This makes only sense for character based mime types. + </p></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../at/gv/egiz/pdfas/api/io/DataSource.html#getCharacterEncoding()">getCharacterEncoding</a></code> in interface <code><a href="../../../../../at/gv/egiz/pdfas/api/io/DataSource.html" title="interface in at.gv.egiz.pdfas.api.io">DataSource</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>Returns the character encoding of the data or null if no encoding + is applicable (e.g. if the data is binary).</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="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="../../../../../at/gv/egiz/pdfas/wrapper/ByteArrayDataSource_OLD.html" title="class in at.gv.egiz.pdfas.wrapper"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../at/gv/egiz/pdfas/wrapper/LegacyMainTest.html" title="class in at.gv.egiz.pdfas.wrapper"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?at/gv/egiz/pdfas/wrapper/FileDataSource.html" target="_top">Frames</a></li> +<li><a href="FileDataSource.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 ======= --> +</body> +</html> |