pdfbox-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From msahy...@apache.org
Subject [01/51] [partial] pdfbox-docs git commit: Site checkin for project Apache PDFBox Website
Date Mon, 16 Nov 2015 19:21:00 GMT
Repository: pdfbox-docs
Updated Branches:
  refs/heads/asf-site aa929f46c -> 3ca1d144f


http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/3ca1d144/content/docs/1.8.10/javadocs/org/apache/pdfbox/io/IOUtils.html
----------------------------------------------------------------------
diff --git a/content/docs/1.8.10/javadocs/org/apache/pdfbox/io/IOUtils.html b/content/docs/1.8.10/javadocs/org/apache/pdfbox/io/IOUtils.html
new file mode 100644
index 0000000..3ce64b3
--- /dev/null
+++ b/content/docs/1.8.10/javadocs/org/apache/pdfbox/io/IOUtils.html
@@ -0,0 +1,363 @@
+<!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_55) on Wed Aug 19 15:27:38 CEST 2015 -->
+<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
+<title>IOUtils (Apache PDFBox 1.8.10 API)</title>
+<meta name="date" content="2015-08-19">
+<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="IOUtils (Apache PDFBox 1.8.10 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/IOUtils.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/io/FastByteArrayOutputStream.html" title="class
in org.apache.pdfbox.io"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/pdfbox/io/PushBackInputStream.html" title="class
in org.apache.pdfbox.io"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/pdfbox/io/IOUtils.html" target="_top">Frames</a></li>
+<li><a href="IOUtils.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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</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.io</div>
+<h2 title="Class IOUtils" class="title">Class IOUtils</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>org.apache.pdfbox.io.IOUtils</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>public class <span class="strong">IOUtils</span>
+extends <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></pre>
+<div class="block">This class contains various I/O-related methods.</div>
+<dl><dt><span class="strong">Version:</span></dt>
+  <dd>$Revision$</dd></dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========== 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">&nbsp;</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>static void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/io/IOUtils.html#closeQuietly(java.io.InputStream)">closeQuietly</a></strong>(<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>&nbsp;input)</code>
+<div class="block">Unconditionally close an <code>InputStream</code>.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/io/IOUtils.html#closeQuietly(java.io.OutputStream)">closeQuietly</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>&nbsp;output)</code>
+<div class="block">Unconditionally close an <code>OutputStream</code>.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/io/IOUtils.html#closeQuietly(java.io.Reader)">closeQuietly</a></strong>(<a
href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true"
title="class or interface in java.io">Reader</a>&nbsp;input)</code>
+<div class="block">Unconditionally close an <code>Reader</code>.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/io/IOUtils.html#closeQuietly(java.io.Writer)">closeQuietly</a></strong>(<a
href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/Writer.html?is-external=true"
title="class or interface in java.io">Writer</a>&nbsp;output)</code>
+<div class="block">Unconditionally close a <code>Writer</code>.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static long</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/io/IOUtils.html#copy(java.io.InputStream,
java.io.OutputStream)">copy</a></strong>(<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>&nbsp;input,
+    <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>&nbsp;output)</code>
+<div class="block">Copies all the contents from the given input stream to the given
output stream.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static long</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/io/IOUtils.html#populateBuffer(java.io.InputStream,
byte[])">populateBuffer</a></strong>(<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>&nbsp;in,
+              byte[]&nbsp;buffer)</code>
+<div class="block">Populates the given buffer with data read from the input stream.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static byte[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/pdfbox/io/IOUtils.html#toByteArray(java.io.InputStream)">toByteArray</a></strong>(<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>&nbsp;in)</code>
+<div class="block">Reads the input stream and returns its contents as a byte array.</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&nbsp;java.lang.<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</a></h3>
+<code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()"
title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)"
title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()"
title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()"
title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()"
title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()"
title="class or interface in java.lang">notify</a>, <a href="ht
 tp://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()"
title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()"
title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()"
title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)"
title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long,
int)" 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">
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!--   -->
+</a>
+<h3>Method Detail</h3>
+<a name="toByteArray(java.io.InputStream)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>toByteArray</h4>
+<pre>public static&nbsp;byte[]&nbsp;toByteArray(<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>&nbsp;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">Reads the input stream and returns its contents as a byte array.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code>
- the input stream to read from.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the byte array</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 I/O error
occurs</dd></dl>
+</li>
+</ul>
+<a name="copy(java.io.InputStream, java.io.OutputStream)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>copy</h4>
+<pre>public static&nbsp;long&nbsp;copy(<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>&nbsp;input,
+        <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>&nbsp;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">Copies all the contents from the given input stream to the given
output stream.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code>
- the input stream</dd><dd><code>output</code> - the output stream</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the number
of bytes that have been copied</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 I/O error
occurs</dd></dl>
+</li>
+</ul>
+<a name="populateBuffer(java.io.InputStream, byte[])">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>populateBuffer</h4>
+<pre>public static&nbsp;long&nbsp;populateBuffer(<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>&nbsp;in,
+                  byte[]&nbsp;buffer)
+                           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">Populates the given buffer with data read from the input stream.
If the data doesn't
+ fit the buffer, only the data that fits in the buffer is read. If the data is less than
+ fits in the buffer, the buffer is not completely filled.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code>
- the input stream to read from</dd><dd><code>buffer</code> - the
buffer to fill</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the number
of bytes written to the buffer</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 I/O error
occurs</dd></dl>
+</li>
+</ul>
+<a name="closeQuietly(java.io.InputStream)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>closeQuietly</h4>
+<pre>public static&nbsp;void&nbsp;closeQuietly(<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>&nbsp;input)</pre>
+<div class="block">Unconditionally close an <code>InputStream</code>.
+ <p>
+ Equivalent to <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true#close()"
title="class or interface in java.io"><code>InputStream.close()</code></a>,
except any exceptions will be ignored.
+ This is typically used in finally blocks.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code>
- the InputStream to close, may be null or already closed</dd></dl>
+</li>
+</ul>
+<a name="closeQuietly(java.io.Reader)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>closeQuietly</h4>
+<pre>public static&nbsp;void&nbsp;closeQuietly(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true"
title="class or interface in java.io">Reader</a>&nbsp;input)</pre>
+<div class="block">Unconditionally close an <code>Reader</code>.
+ <p>
+ Equivalent to <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true#close()"
title="class or interface in java.io"><code>Reader.close()</code></a>,
except any exceptions will be ignored.
+ This is typically used in finally blocks.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code>
- the Reader to close, may be null or already closed</dd></dl>
+</li>
+</ul>
+<a name="closeQuietly(java.io.Writer)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>closeQuietly</h4>
+<pre>public static&nbsp;void&nbsp;closeQuietly(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/Writer.html?is-external=true"
title="class or interface in java.io">Writer</a>&nbsp;output)</pre>
+<div class="block">Unconditionally close a <code>Writer</code>.
+ <p>
+ Equivalent to <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/Writer.html?is-external=true#close()"
title="class or interface in java.io"><code>Writer.close()</code></a>,
except any exceptions will be ignored.
+ This is typically used in finally blocks.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>output</code>
- the Writer to close, may be null or already closed</dd></dl>
+</li>
+</ul>
+<a name="closeQuietly(java.io.OutputStream)">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>closeQuietly</h4>
+<pre>public static&nbsp;void&nbsp;closeQuietly(<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>&nbsp;output)</pre>
+<div class="block">Unconditionally close an <code>OutputStream</code>.
+ <p>
+ Equivalent to <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html?is-external=true#close()"
title="class or interface in java.io"><code>OutputStream.close()</code></a>,
except any exceptions will be ignored.
+ This is typically used in finally blocks.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>output</code>
- the OutputStream to close, may be null or already closed</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/IOUtils.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/io/FastByteArrayOutputStream.html" title="class
in org.apache.pdfbox.io"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/pdfbox/io/PushBackInputStream.html" title="class
in org.apache.pdfbox.io"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/pdfbox/io/IOUtils.html" target="_top">Frames</a></li>
+<li><a href="IOUtils.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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</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 &#169; 2002-2015 <a href="http://pdfbox.apache.org">The
Apache Software Foundation</a>. All Rights Reserved.</small></p>
+</body>
+</html>
\ No newline at end of file


Mime
View raw message