You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ki...@apache.org on 2015/05/12 01:44:51 UTC

svn commit: r1678837 [7/12] - in /poi/site/publish: ./ apidocs/ apidocs/org/apache/poi/ apidocs/org/apache/poi/class-use/ apidocs/org/apache/poi/extractor/ apidocs/org/apache/poi/hdgf/ apidocs/org/apache/poi/hdgf/extractor/ apidocs/org/apache/poi/hpbf/...

Added: poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/OPOIFSDocument.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/OPOIFSDocument.html?rev=1678837&view=auto
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/OPOIFSDocument.html (added)
+++ poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/OPOIFSDocument.html Mon May 11 23:44:49 2015
@@ -0,0 +1,587 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<title>OPOIFSDocument (POI API Documentation)</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+    if (location.href.indexOf('is-external=true') == -1) {
+        parent.document.title="OPOIFSDocument (POI API Documentation)";
+    }
+//-->
+</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/OPOIFSDocument.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/poi/poifs/filesystem/Ole10NativeException.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/poi/poifs/filesystem/OPOIFSDocument.html" target="_top">Frames</a></li>
+<li><a href="OPOIFSDocument.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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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.poi.poifs.filesystem</div>
+<h2 title="Class OPOIFSDocument" class="title">Class OPOIFSDocument</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>org.apache.poi.poifs.filesystem.OPOIFSDocument</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html" title="interface in org.apache.poi.poifs.dev">POIFSViewable</a>, <a href="../../../../../org/apache/poi/poifs/filesystem/BATManaged.html" title="interface in org.apache.poi.poifs.filesystem">BATManaged</a>, <a href="../../../../../org/apache/poi/poifs/storage/BlockWritable.html" title="interface in org.apache.poi.poifs.storage">BlockWritable</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public final class <span class="strong">OPOIFSDocument</span>
+extends java.lang.Object
+implements <a href="../../../../../org/apache/poi/poifs/filesystem/BATManaged.html" title="interface in org.apache.poi.poifs.filesystem">BATManaged</a>, <a href="../../../../../org/apache/poi/poifs/storage/BlockWritable.html" title="interface in org.apache.poi.poifs.storage">BlockWritable</a>, <a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html" title="interface in org.apache.poi.poifs.dev">POIFSViewable</a></pre>
+<div class="block">This class manages a document in a old-style 
+  OPOIFS filesystem.</div>
+</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">&nbsp;</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/poi/poifs/filesystem/OPOIFSDocument.html#OPOIFSDocument(java.lang.String,%20java.io.InputStream)">OPOIFSDocument</a></strong>(java.lang.String&nbsp;name,
+              java.io.InputStream&nbsp;stream)</code>&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSDocument.html#OPOIFSDocument(java.lang.String,%20int,%20org.apache.poi.poifs.common.POIFSBigBlockSize,%20org.apache.poi.poifs.filesystem.POIFSDocumentPath,%20org.apache.poi.poifs.filesystem.POIFSWriterListener)">OPOIFSDocument</a></strong>(java.lang.String&nbsp;name,
+              int&nbsp;size,
+              <a href="../../../../../org/apache/poi/poifs/common/POIFSBigBlockSize.html" title="class in org.apache.poi.poifs.common">POIFSBigBlockSize</a>&nbsp;bigBlockSize,
+              <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSDocumentPath.html" title="class in org.apache.poi.poifs.filesystem">POIFSDocumentPath</a>&nbsp;path,
+              <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSWriterListener.html" title="interface in org.apache.poi.poifs.filesystem">POIFSWriterListener</a>&nbsp;writer)</code>
+<div class="block">Constructor</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSDocument.html#OPOIFSDocument(java.lang.String,%20int,%20org.apache.poi.poifs.filesystem.POIFSDocumentPath,%20org.apache.poi.poifs.filesystem.POIFSWriterListener)">OPOIFSDocument</a></strong>(java.lang.String&nbsp;name,
+              int&nbsp;size,
+              <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSDocumentPath.html" title="class in org.apache.poi.poifs.filesystem">POIFSDocumentPath</a>&nbsp;path,
+              <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSWriterListener.html" title="interface in org.apache.poi.poifs.filesystem">POIFSWriterListener</a>&nbsp;writer)</code>&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSDocument.html#OPOIFSDocument(java.lang.String,%20org.apache.poi.poifs.storage.ListManagedBlock[],%20int)">OPOIFSDocument</a></strong>(java.lang.String&nbsp;name,
+              <a href="../../../../../org/apache/poi/poifs/storage/ListManagedBlock.html" title="interface in org.apache.poi.poifs.storage">ListManagedBlock</a>[]&nbsp;blocks,
+              int&nbsp;length)</code>&nbsp;</td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSDocument.html#OPOIFSDocument(java.lang.String,%20org.apache.poi.poifs.common.POIFSBigBlockSize,%20java.io.InputStream)">OPOIFSDocument</a></strong>(java.lang.String&nbsp;name,
+              <a href="../../../../../org/apache/poi/poifs/common/POIFSBigBlockSize.html" title="class in org.apache.poi.poifs.common">POIFSBigBlockSize</a>&nbsp;bigBlockSize,
+              java.io.InputStream&nbsp;stream)</code>
+<div class="block">Constructor</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSDocument.html#OPOIFSDocument(java.lang.String,%20org.apache.poi.poifs.common.POIFSBigBlockSize,%20org.apache.poi.poifs.storage.ListManagedBlock[],%20int)">OPOIFSDocument</a></strong>(java.lang.String&nbsp;name,
+              <a href="../../../../../org/apache/poi/poifs/common/POIFSBigBlockSize.html" title="class in org.apache.poi.poifs.common">POIFSBigBlockSize</a>&nbsp;bigBlockSize,
+              <a href="../../../../../org/apache/poi/poifs/storage/ListManagedBlock.html" title="interface in org.apache.poi.poifs.storage">ListManagedBlock</a>[]&nbsp;blocks,
+              int&nbsp;length)</code>
+<div class="block">Constructor from small blocks</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSDocument.html#OPOIFSDocument(java.lang.String,%20org.apache.poi.poifs.storage.RawDataBlock[],%20int)">OPOIFSDocument</a></strong>(java.lang.String&nbsp;name,
+              <a href="../../../../../org/apache/poi/poifs/storage/RawDataBlock.html" title="class in org.apache.poi.poifs.storage">RawDataBlock</a>[]&nbsp;blocks,
+              int&nbsp;length)</code>
+<div class="block">Constructor from large blocks</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSDocument.html#OPOIFSDocument(java.lang.String,%20org.apache.poi.poifs.storage.SmallDocumentBlock[],%20int)">OPOIFSDocument</a></strong>(java.lang.String&nbsp;name,
+              <a href="../../../../../org/apache/poi/poifs/storage/SmallDocumentBlock.html" title="class in org.apache.poi.poifs.storage">SmallDocumentBlock</a>[]&nbsp;blocks,
+              int&nbsp;length)</code>
+<div class="block">Constructor from small blocks</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">&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>int</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSDocument.html#countBlocks()">countBlocks</a></strong>()</code>
+<div class="block">Return the number of BigBlock's this instance uses</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSDocument.html#getShortDescription()">getShortDescription</a></strong>()</code>
+<div class="block">Provides a short description of the object, to be used when a
+ POIFSViewable object has not provided its contents.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSDocument.html#getSize()">getSize</a></strong>()</code>&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/poi/poifs/storage/BlockWritable.html" title="interface in org.apache.poi.poifs.storage">BlockWritable</a>[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSDocument.html#getSmallBlocks()">getSmallBlocks</a></strong>()</code>&nbsp;</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.Object[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSDocument.html#getViewableArray()">getViewableArray</a></strong>()</code>
+<div class="block">Get an array of objects, some of which may implement POIFSViewable</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.util.Iterator&lt;java.lang.Object&gt;</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSDocument.html#getViewableIterator()">getViewableIterator</a></strong>()</code>
+<div class="block">Get an Iterator of objects, some of which may implement POIFSViewable</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSDocument.html#preferArray()">preferArray</a></strong>()</code>
+<div class="block">Give viewers a hint as to whether to call getViewableArray or
+ getViewableIterator</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSDocument.html#setStartBlock(int)">setStartBlock</a></strong>(int&nbsp;index)</code>
+<div class="block">Set the start block for this instance</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSDocument.html#writeBlocks(java.io.OutputStream)">writeBlocks</a></strong>(java.io.OutputStream&nbsp;stream)</code>
+<div class="block">Write the storage to an OutputStream</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.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="OPOIFSDocument(java.lang.String, org.apache.poi.poifs.storage.RawDataBlock[], int)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>OPOIFSDocument</h4>
+<pre>public&nbsp;OPOIFSDocument(java.lang.String&nbsp;name,
+              <a href="../../../../../org/apache/poi/poifs/storage/RawDataBlock.html" title="class in org.apache.poi.poifs.storage">RawDataBlock</a>[]&nbsp;blocks,
+              int&nbsp;length)
+               throws java.io.IOException</pre>
+<div class="block">Constructor from large blocks</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the POIFSDocument</dd><dd><code>blocks</code> - the big blocks making up the POIFSDocument</dd><dd><code>length</code> - the actual length of the POIFSDocument</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code></dd></dl>
+</li>
+</ul>
+<a name="OPOIFSDocument(java.lang.String, org.apache.poi.poifs.storage.SmallDocumentBlock[], int)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>OPOIFSDocument</h4>
+<pre>public&nbsp;OPOIFSDocument(java.lang.String&nbsp;name,
+              <a href="../../../../../org/apache/poi/poifs/storage/SmallDocumentBlock.html" title="class in org.apache.poi.poifs.storage">SmallDocumentBlock</a>[]&nbsp;blocks,
+              int&nbsp;length)</pre>
+<div class="block">Constructor from small blocks</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the POIFSDocument</dd><dd><code>blocks</code> - the small blocks making up the POIFSDocument</dd><dd><code>length</code> - the actual length of the POIFSDocument</dd></dl>
+</li>
+</ul>
+<a name="OPOIFSDocument(java.lang.String, org.apache.poi.poifs.common.POIFSBigBlockSize, org.apache.poi.poifs.storage.ListManagedBlock[], int)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>OPOIFSDocument</h4>
+<pre>public&nbsp;OPOIFSDocument(java.lang.String&nbsp;name,
+              <a href="../../../../../org/apache/poi/poifs/common/POIFSBigBlockSize.html" title="class in org.apache.poi.poifs.common">POIFSBigBlockSize</a>&nbsp;bigBlockSize,
+              <a href="../../../../../org/apache/poi/poifs/storage/ListManagedBlock.html" title="interface in org.apache.poi.poifs.storage">ListManagedBlock</a>[]&nbsp;blocks,
+              int&nbsp;length)
+               throws java.io.IOException</pre>
+<div class="block">Constructor from small blocks</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the POIFSDocument</dd><dd><code>blocks</code> - the small blocks making up the POIFSDocument</dd><dd><code>length</code> - the actual length of the POIFSDocument</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code></dd></dl>
+</li>
+</ul>
+<a name="OPOIFSDocument(java.lang.String, org.apache.poi.poifs.storage.ListManagedBlock[], int)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>OPOIFSDocument</h4>
+<pre>public&nbsp;OPOIFSDocument(java.lang.String&nbsp;name,
+              <a href="../../../../../org/apache/poi/poifs/storage/ListManagedBlock.html" title="interface in org.apache.poi.poifs.storage">ListManagedBlock</a>[]&nbsp;blocks,
+              int&nbsp;length)
+               throws java.io.IOException</pre>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code></dd></dl>
+</li>
+</ul>
+<a name="OPOIFSDocument(java.lang.String, org.apache.poi.poifs.common.POIFSBigBlockSize, java.io.InputStream)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>OPOIFSDocument</h4>
+<pre>public&nbsp;OPOIFSDocument(java.lang.String&nbsp;name,
+              <a href="../../../../../org/apache/poi/poifs/common/POIFSBigBlockSize.html" title="class in org.apache.poi.poifs.common">POIFSBigBlockSize</a>&nbsp;bigBlockSize,
+              java.io.InputStream&nbsp;stream)
+               throws java.io.IOException</pre>
+<div class="block">Constructor</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the POIFSDocument</dd><dd><code>stream</code> - the InputStream we read data from</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code></dd></dl>
+</li>
+</ul>
+<a name="OPOIFSDocument(java.lang.String, java.io.InputStream)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>OPOIFSDocument</h4>
+<pre>public&nbsp;OPOIFSDocument(java.lang.String&nbsp;name,
+              java.io.InputStream&nbsp;stream)
+               throws java.io.IOException</pre>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code></dd></dl>
+</li>
+</ul>
+<a name="OPOIFSDocument(java.lang.String, int, org.apache.poi.poifs.common.POIFSBigBlockSize, org.apache.poi.poifs.filesystem.POIFSDocumentPath, org.apache.poi.poifs.filesystem.POIFSWriterListener)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>OPOIFSDocument</h4>
+<pre>public&nbsp;OPOIFSDocument(java.lang.String&nbsp;name,
+              int&nbsp;size,
+              <a href="../../../../../org/apache/poi/poifs/common/POIFSBigBlockSize.html" title="class in org.apache.poi.poifs.common">POIFSBigBlockSize</a>&nbsp;bigBlockSize,
+              <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSDocumentPath.html" title="class in org.apache.poi.poifs.filesystem">POIFSDocumentPath</a>&nbsp;path,
+              <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSWriterListener.html" title="interface in org.apache.poi.poifs.filesystem">POIFSWriterListener</a>&nbsp;writer)</pre>
+<div class="block">Constructor</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the POIFSDocument</dd><dd><code>size</code> - the length of the POIFSDocument</dd><dd><code>path</code> - the path of the POIFSDocument</dd><dd><code>writer</code> - the writer who will eventually write the document contents</dd></dl>
+</li>
+</ul>
+<a name="OPOIFSDocument(java.lang.String, int, org.apache.poi.poifs.filesystem.POIFSDocumentPath, org.apache.poi.poifs.filesystem.POIFSWriterListener)">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>OPOIFSDocument</h4>
+<pre>public&nbsp;OPOIFSDocument(java.lang.String&nbsp;name,
+              int&nbsp;size,
+              <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSDocumentPath.html" title="class in org.apache.poi.poifs.filesystem">POIFSDocumentPath</a>&nbsp;path,
+              <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSWriterListener.html" title="interface in org.apache.poi.poifs.filesystem">POIFSWriterListener</a>&nbsp;writer)</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!--   -->
+</a>
+<h3>Method Detail</h3>
+<a name="getSmallBlocks()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getSmallBlocks</h4>
+<pre>public&nbsp;<a href="../../../../../org/apache/poi/poifs/storage/BlockWritable.html" title="interface in org.apache.poi.poifs.storage">BlockWritable</a>[]&nbsp;getSmallBlocks()</pre>
+<dl><dt><span class="strong">Returns:</span></dt><dd>array of SmallDocumentBlocks; may be empty, cannot be null</dd></dl>
+</li>
+</ul>
+<a name="getSize()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getSize</h4>
+<pre>public&nbsp;int&nbsp;getSize()</pre>
+<dl><dt><span class="strong">Returns:</span></dt><dd>size of the document</dd></dl>
+</li>
+</ul>
+<a name="writeBlocks(java.io.OutputStream)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>writeBlocks</h4>
+<pre>public&nbsp;void&nbsp;writeBlocks(java.io.OutputStream&nbsp;stream)
+                 throws java.io.IOException</pre>
+<div class="block">Write the storage to an OutputStream</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../org/apache/poi/poifs/storage/BlockWritable.html#writeBlocks(java.io.OutputStream)">writeBlocks</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/poifs/storage/BlockWritable.html" title="interface in org.apache.poi.poifs.storage">BlockWritable</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - the OutputStream to which the stored data should be written</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - on problems writing to the specified
+            stream</dd></dl>
+</li>
+</ul>
+<a name="countBlocks()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>countBlocks</h4>
+<pre>public&nbsp;int&nbsp;countBlocks()</pre>
+<div class="block">Return the number of BigBlock's this instance uses</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../org/apache/poi/poifs/filesystem/BATManaged.html#countBlocks()">countBlocks</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/poifs/filesystem/BATManaged.html" title="interface in org.apache.poi.poifs.filesystem">BATManaged</a></code></dd>
+<dt><span class="strong">Returns:</span></dt><dd>count of BigBlock instances</dd></dl>
+</li>
+</ul>
+<a name="setStartBlock(int)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setStartBlock</h4>
+<pre>public&nbsp;void&nbsp;setStartBlock(int&nbsp;index)</pre>
+<div class="block">Set the start block for this instance</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../org/apache/poi/poifs/filesystem/BATManaged.html#setStartBlock(int)">setStartBlock</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/poifs/filesystem/BATManaged.html" title="interface in org.apache.poi.poifs.filesystem">BATManaged</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index into the array of blocks making up the filesystem</dd></dl>
+</li>
+</ul>
+<a name="getViewableArray()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getViewableArray</h4>
+<pre>public&nbsp;java.lang.Object[]&nbsp;getViewableArray()</pre>
+<div class="block">Get an array of objects, some of which may implement POIFSViewable</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html#getViewableArray()">getViewableArray</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html" title="interface in org.apache.poi.poifs.dev">POIFSViewable</a></code></dd>
+<dt><span class="strong">Returns:</span></dt><dd>an array of Object; may not be null, but may be empty</dd></dl>
+</li>
+</ul>
+<a name="getViewableIterator()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getViewableIterator</h4>
+<pre>public&nbsp;java.util.Iterator&lt;java.lang.Object&gt;&nbsp;getViewableIterator()</pre>
+<div class="block">Get an Iterator of objects, some of which may implement POIFSViewable</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html#getViewableIterator()">getViewableIterator</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html" title="interface in org.apache.poi.poifs.dev">POIFSViewable</a></code></dd>
+<dt><span class="strong">Returns:</span></dt><dd>an Iterator; may not be null, but may have an empty back end
+                 store</dd></dl>
+</li>
+</ul>
+<a name="preferArray()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>preferArray</h4>
+<pre>public&nbsp;boolean&nbsp;preferArray()</pre>
+<div class="block">Give viewers a hint as to whether to call getViewableArray or
+ getViewableIterator</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html#preferArray()">preferArray</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html" title="interface in org.apache.poi.poifs.dev">POIFSViewable</a></code></dd>
+<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if a viewer should call getViewableArray,
+                 <code>false</code> if a viewer should call getViewableIterator</dd></dl>
+</li>
+</ul>
+<a name="getShortDescription()">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>getShortDescription</h4>
+<pre>public&nbsp;java.lang.String&nbsp;getShortDescription()</pre>
+<div class="block">Provides a short description of the object, to be used when a
+ POIFSViewable object has not provided its contents.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html#getShortDescription()">getShortDescription</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html" title="interface in org.apache.poi.poifs.dev">POIFSViewable</a></code></dd>
+<dt><span class="strong">Returns:</span></dt><dd>short description</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/OPOIFSDocument.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/poi/poifs/filesystem/Ole10NativeException.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/poi/poifs/filesystem/OPOIFSDocument.html" target="_top">Frames</a></li>
+<li><a href="OPOIFSDocument.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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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>
+                <i>Copyright 2015 The Apache Software Foundation or
+        its licensors, as applicable.</i>
+            </small></p>
+</body>
+</html>

Added: poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html?rev=1678837&view=auto
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html (added)
+++ poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html Mon May 11 23:44:49 2015
@@ -0,0 +1,649 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<title>OPOIFSFileSystem (POI API Documentation)</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+    if (location.href.indexOf('is-external=true') == -1) {
+        parent.document.title="OPOIFSFileSystem (POI API Documentation)";
+    }
+//-->
+</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/OPOIFSFileSystem.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/poi/poifs/filesystem/OPOIFSDocument.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSDocumentPath.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html" target="_top">Frames</a></li>
+<li><a href="OPOIFSFileSystem.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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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.poi.poifs.filesystem</div>
+<h2 title="Class OPOIFSFileSystem" class="title">Class OPOIFSFileSystem</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>org.apache.poi.poifs.filesystem.OPOIFSFileSystem</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html" title="interface in org.apache.poi.poifs.dev">POIFSViewable</a></dd>
+</dl>
+<dl>
+<dt>Direct Known Subclasses:</dt>
+<dd><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">POIFSFileSystem</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="strong">OPOIFSFileSystem</span>
+extends java.lang.Object
+implements <a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html" title="interface in org.apache.poi.poifs.dev">POIFSViewable</a></pre>
+<div class="block"><p>This is the main class of the POIFS system; it manages the entire
+ life cycle of the filesystem.</p>
+ <p>This is the older version, which uses more memory, and doesn't
+  support in-place writes.</p></div>
+</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">&nbsp;</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/poi/poifs/filesystem/OPOIFSFileSystem.html#OPOIFSFileSystem()">OPOIFSFileSystem</a></strong>()</code>
+<div class="block">Constructor, intended for writing</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#OPOIFSFileSystem(java.io.InputStream)">OPOIFSFileSystem</a></strong>(java.io.InputStream&nbsp;stream)</code>
+<div class="block">Create a OPOIFSFileSystem from an <tt>InputStream</tt>.</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">&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>protected void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#closeInputStream(java.io.InputStream,%20boolean)">closeInputStream</a></strong>(java.io.InputStream&nbsp;stream,
+                boolean&nbsp;success)</code>&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/poi/poifs/filesystem/DirectoryEntry.html" title="interface in org.apache.poi.poifs.filesystem">DirectoryEntry</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#createDirectory(java.lang.String)">createDirectory</a></strong>(java.lang.String&nbsp;name)</code>
+<div class="block">create a new DirectoryEntry in the root directory</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/poi/poifs/filesystem/DocumentEntry.html" title="interface in org.apache.poi.poifs.filesystem">DocumentEntry</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#createDocument(java.io.InputStream,%20java.lang.String)">createDocument</a></strong>(java.io.InputStream&nbsp;stream,
+              java.lang.String&nbsp;name)</code>
+<div class="block">Create a new document to be added to the root directory</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/poi/poifs/filesystem/DocumentEntry.html" title="interface in org.apache.poi.poifs.filesystem">DocumentEntry</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#createDocument(java.lang.String,%20int,%20org.apache.poi.poifs.filesystem.POIFSWriterListener)">createDocument</a></strong>(java.lang.String&nbsp;name,
+              int&nbsp;size,
+              <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSWriterListener.html" title="interface in org.apache.poi.poifs.filesystem">POIFSWriterListener</a>&nbsp;writer)</code>
+<div class="block">create a new DocumentEntry in the root entry; the data will be
+ provided later</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/poi/poifs/filesystem/DocumentInputStream.html" title="class in org.apache.poi.poifs.filesystem">DocumentInputStream</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#createDocumentInputStream(java.lang.String)">createDocumentInputStream</a></strong>(java.lang.String&nbsp;documentName)</code>
+<div class="block">open a document in the root entry's list of entries</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static java.io.InputStream</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#createNonClosingInputStream(java.io.InputStream)">createNonClosingInputStream</a></strong>(java.io.InputStream&nbsp;is)</code>
+<div class="block">Convenience method for clients that want to avoid the auto-close behaviour of the constructor.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#getBigBlockSize()">getBigBlockSize</a></strong>()</code>&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/poi/poifs/common/POIFSBigBlockSize.html" title="class in org.apache.poi.poifs.common">POIFSBigBlockSize</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#getBigBlockSizeDetails()">getBigBlockSizeDetails</a></strong>()</code>&nbsp;</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/poi/poifs/filesystem/DirectoryNode.html" title="class in org.apache.poi.poifs.filesystem">DirectoryNode</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#getRoot()">getRoot</a></strong>()</code>
+<div class="block">get the root entry</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#getShortDescription()">getShortDescription</a></strong>()</code>
+<div class="block">Provides a short description of the object, to be used when a
+ POIFSViewable object has not provided its contents.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.Object[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#getViewableArray()">getViewableArray</a></strong>()</code>
+<div class="block">Get an array of objects, some of which may implement
+ POIFSViewable</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.util.Iterator&lt;java.lang.Object&gt;</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#getViewableIterator()">getViewableIterator</a></strong>()</code>
+<div class="block">Get an Iterator of objects, some of which may implement
+ POIFSViewable</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#hasPOIFSHeader(byte[])">hasPOIFSHeader</a></strong>(byte[]&nbsp;header8Bytes)</code>
+<div class="block">Checks if the supplied first 8 bytes of a stream / file
+  has a POIFS (OLE2) header.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#hasPOIFSHeader(java.io.InputStream)">hasPOIFSHeader</a></strong>(java.io.InputStream&nbsp;inp)</code>
+<div class="block">Checks that the supplied InputStream (which MUST
+  support mark and reset, or be a PushbackInputStream)
+  has a POIFS (OLE2) header at the start of it.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#main(java.lang.String[])">main</a></strong>(java.lang.String[]&nbsp;args)</code>
+<div class="block">read in a file and write it back out again</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#preferArray()">preferArray</a></strong>()</code>
+<div class="block">Give viewers a hint as to whether to call getViewableArray or
+ getViewableIterator</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#writeFilesystem(java.io.OutputStream)">writeFilesystem</a></strong>(java.io.OutputStream&nbsp;stream)</code>
+<div class="block">Write the filesystem out</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.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="OPOIFSFileSystem()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>OPOIFSFileSystem</h4>
+<pre>public&nbsp;OPOIFSFileSystem()</pre>
+<div class="block">Constructor, intended for writing</div>
+</li>
+</ul>
+<a name="OPOIFSFileSystem(java.io.InputStream)">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>OPOIFSFileSystem</h4>
+<pre>public&nbsp;OPOIFSFileSystem(java.io.InputStream&nbsp;stream)
+                 throws java.io.IOException</pre>
+<div class="block">Create a OPOIFSFileSystem from an <tt>InputStream</tt>.  Normally the stream is read until
+ EOF.  The stream is always closed.<p/>
+
+ Some streams are usable after reaching EOF (typically those that return <code>true</code>
+ for <tt>markSupported()</tt>).  In the unlikely case that the caller has such a stream
+ <i>and</i> needs to use it after this constructor completes, a work around is to wrap the
+ stream in order to trap the <tt>close()</tt> call.  A convenience method (
+ <tt>createNonClosingInputStream()</tt>) has been provided for this purpose:
+ <pre>
+ InputStream wrappedStream = OPOIFSFileSystem.createNonClosingInputStream(is);
+ HSSFWorkbook wb = new HSSFWorkbook(wrappedStream);
+ is.reset();
+ doSomethingElse(is);
+ </pre>
+ Note also the special case of <tt>ByteArrayInputStream</tt> for which the <tt>close()</tt>
+ method does nothing.
+ <pre>
+ ByteArrayInputStream bais = ...
+ HSSFWorkbook wb = new HSSFWorkbook(bais); // calls bais.close() !
+ bais.reset(); // no problem
+ doSomethingElse(bais);
+ </pre></div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - the InputStream from which to read the data</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - on errors reading, or on invalid data</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="createNonClosingInputStream(java.io.InputStream)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>createNonClosingInputStream</h4>
+<pre>public static&nbsp;java.io.InputStream&nbsp;createNonClosingInputStream(java.io.InputStream&nbsp;is)</pre>
+<div class="block">Convenience method for clients that want to avoid the auto-close behaviour of the constructor.</div>
+</li>
+</ul>
+<a name="closeInputStream(java.io.InputStream, boolean)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>closeInputStream</h4>
+<pre>protected&nbsp;void&nbsp;closeInputStream(java.io.InputStream&nbsp;stream,
+                    boolean&nbsp;success)</pre>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - the stream to be closed</dd><dd><code>success</code> - <code>false</code> if an exception is currently being thrown in the calling method</dd></dl>
+</li>
+</ul>
+<a name="hasPOIFSHeader(java.io.InputStream)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>hasPOIFSHeader</h4>
+<pre>public static&nbsp;boolean&nbsp;hasPOIFSHeader(java.io.InputStream&nbsp;inp)
+                              throws java.io.IOException</pre>
+<div class="block">Checks that the supplied InputStream (which MUST
+  support mark and reset, or be a PushbackInputStream)
+  has a POIFS (OLE2) header at the start of it.
+ If your InputStream does not support mark / reset,
+  then wrap it in a PushBackInputStream, then be
+  sure to always use that, and not the original!</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>inp</code> - An InputStream which supports either mark/reset, or is a PushbackInputStream</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code></dd></dl>
+</li>
+</ul>
+<a name="hasPOIFSHeader(byte[])">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>hasPOIFSHeader</h4>
+<pre>public static&nbsp;boolean&nbsp;hasPOIFSHeader(byte[]&nbsp;header8Bytes)</pre>
+<div class="block">Checks if the supplied first 8 bytes of a stream / file
+  has a POIFS (OLE2) header.</div>
+</li>
+</ul>
+<a name="createDocument(java.io.InputStream, java.lang.String)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>createDocument</h4>
+<pre>public&nbsp;<a href="../../../../../org/apache/poi/poifs/filesystem/DocumentEntry.html" title="interface in org.apache.poi.poifs.filesystem">DocumentEntry</a>&nbsp;createDocument(java.io.InputStream&nbsp;stream,
+                           java.lang.String&nbsp;name)
+                             throws java.io.IOException</pre>
+<div class="block">Create a new document to be added to the root directory</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - the InputStream from which the document's data
+               will be obtained</dd><dd><code>name</code> - the name of the new POIFSDocument</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the new DocumentEntry</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - on error creating the new POIFSDocument</dd></dl>
+</li>
+</ul>
+<a name="createDocument(java.lang.String, int, org.apache.poi.poifs.filesystem.POIFSWriterListener)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>createDocument</h4>
+<pre>public&nbsp;<a href="../../../../../org/apache/poi/poifs/filesystem/DocumentEntry.html" title="interface in org.apache.poi.poifs.filesystem">DocumentEntry</a>&nbsp;createDocument(java.lang.String&nbsp;name,
+                           int&nbsp;size,
+                           <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSWriterListener.html" title="interface in org.apache.poi.poifs.filesystem">POIFSWriterListener</a>&nbsp;writer)
+                             throws java.io.IOException</pre>
+<div class="block">create a new DocumentEntry in the root entry; the data will be
+ provided later</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the new DocumentEntry</dd><dd><code>size</code> - the size of the new DocumentEntry</dd><dd><code>writer</code> - the writer of the new DocumentEntry</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the new DocumentEntry</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code></dd></dl>
+</li>
+</ul>
+<a name="createDirectory(java.lang.String)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>createDirectory</h4>
+<pre>public&nbsp;<a href="../../../../../org/apache/poi/poifs/filesystem/DirectoryEntry.html" title="interface in org.apache.poi.poifs.filesystem">DirectoryEntry</a>&nbsp;createDirectory(java.lang.String&nbsp;name)
+                               throws java.io.IOException</pre>
+<div class="block">create a new DirectoryEntry in the root directory</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the new DirectoryEntry</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the new DirectoryEntry</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - on name duplication</dd></dl>
+</li>
+</ul>
+<a name="writeFilesystem(java.io.OutputStream)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>writeFilesystem</h4>
+<pre>public&nbsp;void&nbsp;writeFilesystem(java.io.OutputStream&nbsp;stream)
+                     throws java.io.IOException</pre>
+<div class="block">Write the filesystem out</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - the OutputStream to which the filesystem will be
+               written</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - thrown on errors writing to the stream</dd></dl>
+</li>
+</ul>
+<a name="main(java.lang.String[])">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>main</h4>
+<pre>public static&nbsp;void&nbsp;main(java.lang.String[]&nbsp;args)
+                 throws java.io.IOException</pre>
+<div class="block">read in a file and write it back out again</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - names of the files; arg[ 0 ] is the input file,
+             arg[ 1 ] is the output file</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code></dd></dl>
+</li>
+</ul>
+<a name="getRoot()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getRoot</h4>
+<pre>public&nbsp;<a href="../../../../../org/apache/poi/poifs/filesystem/DirectoryNode.html" title="class in org.apache.poi.poifs.filesystem">DirectoryNode</a>&nbsp;getRoot()</pre>
+<div class="block">get the root entry</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the root entry</dd></dl>
+</li>
+</ul>
+<a name="createDocumentInputStream(java.lang.String)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>createDocumentInputStream</h4>
+<pre>public&nbsp;<a href="../../../../../org/apache/poi/poifs/filesystem/DocumentInputStream.html" title="class in org.apache.poi.poifs.filesystem">DocumentInputStream</a>&nbsp;createDocumentInputStream(java.lang.String&nbsp;documentName)
+                                              throws java.io.IOException</pre>
+<div class="block">open a document in the root entry's list of entries</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>documentName</code> - the name of the document to be opened</dd>
+<dt><span class="strong">Returns:</span></dt><dd>a newly opened DocumentInputStream</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - if the document does not exist or the
+            name is that of a DirectoryEntry</dd></dl>
+</li>
+</ul>
+<a name="getViewableArray()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getViewableArray</h4>
+<pre>public&nbsp;java.lang.Object[]&nbsp;getViewableArray()</pre>
+<div class="block">Get an array of objects, some of which may implement
+ POIFSViewable</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html#getViewableArray()">getViewableArray</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html" title="interface in org.apache.poi.poifs.dev">POIFSViewable</a></code></dd>
+<dt><span class="strong">Returns:</span></dt><dd>an array of Object; may not be null, but may be empty</dd></dl>
+</li>
+</ul>
+<a name="getViewableIterator()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getViewableIterator</h4>
+<pre>public&nbsp;java.util.Iterator&lt;java.lang.Object&gt;&nbsp;getViewableIterator()</pre>
+<div class="block">Get an Iterator of objects, some of which may implement
+ POIFSViewable</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html#getViewableIterator()">getViewableIterator</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html" title="interface in org.apache.poi.poifs.dev">POIFSViewable</a></code></dd>
+<dt><span class="strong">Returns:</span></dt><dd>an Iterator; may not be null, but may have an empty
+ back end store</dd></dl>
+</li>
+</ul>
+<a name="preferArray()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>preferArray</h4>
+<pre>public&nbsp;boolean&nbsp;preferArray()</pre>
+<div class="block">Give viewers a hint as to whether to call getViewableArray or
+ getViewableIterator</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html#preferArray()">preferArray</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html" title="interface in org.apache.poi.poifs.dev">POIFSViewable</a></code></dd>
+<dt><span class="strong">Returns:</span></dt><dd>true if a viewer should call getViewableArray, false if
+         a viewer should call getViewableIterator</dd></dl>
+</li>
+</ul>
+<a name="getShortDescription()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getShortDescription</h4>
+<pre>public&nbsp;java.lang.String&nbsp;getShortDescription()</pre>
+<div class="block">Provides a short description of the object, to be used when a
+ POIFSViewable object has not provided its contents.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html#getShortDescription()">getShortDescription</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html" title="interface in org.apache.poi.poifs.dev">POIFSViewable</a></code></dd>
+<dt><span class="strong">Returns:</span></dt><dd>short description</dd></dl>
+</li>
+</ul>
+<a name="getBigBlockSize()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getBigBlockSize</h4>
+<pre>public&nbsp;int&nbsp;getBigBlockSize()</pre>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The Big Block size, normally 512 bytes, sometimes 4096 bytes</dd></dl>
+</li>
+</ul>
+<a name="getBigBlockSizeDetails()">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>getBigBlockSizeDetails</h4>
+<pre>public&nbsp;<a href="../../../../../org/apache/poi/poifs/common/POIFSBigBlockSize.html" title="class in org.apache.poi.poifs.common">POIFSBigBlockSize</a>&nbsp;getBigBlockSizeDetails()</pre>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The Big Block size, normally 512 bytes, sometimes 4096 bytes</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/OPOIFSFileSystem.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/poi/poifs/filesystem/OPOIFSDocument.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSDocumentPath.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html" target="_top">Frames</a></li>
+<li><a href="OPOIFSFileSystem.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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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>
+                <i>Copyright 2015 The Apache Software Foundation or
+        its licensors, as applicable.</i>
+            </small></p>
+</body>
+</html>

Modified: poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/Ole10NativeException.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/Ole10NativeException.html?rev=1678837&r1=1678836&r2=1678837&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/Ole10NativeException.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/Ole10NativeException.html Mon May 11 23:44:49 2015
@@ -35,7 +35,7 @@
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">Prev Class</span></a></li>
-<li><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSDocument.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">Next Class</span></a></li>
+<li><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSDocument.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">Next Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../index.html?org/apache/poi/poifs/filesystem/Ole10NativeException.html" target="_top">Frames</a></li>
@@ -204,7 +204,7 @@ extends java.lang.Exception</pre>
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">Prev Class</span></a></li>
-<li><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSDocument.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">Next Class</span></a></li>
+<li><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSDocument.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">Next Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../index.html?org/apache/poi/poifs/filesystem/Ole10NativeException.html" target="_top">Frames</a></li>

Modified: poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/POIFSDocumentPath.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/POIFSDocumentPath.html?rev=1678837&r1=1678836&r2=1678837&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/POIFSDocumentPath.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/POIFSDocumentPath.html Mon May 11 23:44:49 2015
@@ -34,7 +34,7 @@
 </div>
 <div class="subNav">
 <ul class="navList">
-<li><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSDocument.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">Prev Class</span></a></li>
 <li><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">Next Class</span></a></li>
 </ul>
 <ul class="navList">
@@ -390,7 +390,7 @@ extends java.lang.Object</pre>
 </div>
 <div class="subNav">
 <ul class="navList">
-<li><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSDocument.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">Prev Class</span></a></li>
 <li><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">Next Class</span></a></li>
 </ul>
 <ul class="navList">

Modified: poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/POIFSFileSystem.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/POIFSFileSystem.html?rev=1678837&r1=1678836&r2=1678837&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/POIFSFileSystem.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/POIFSFileSystem.html Mon May 11 23:44:49 2015
@@ -85,10 +85,15 @@
 <li>java.lang.Object</li>
 <li>
 <ul class="inheritance">
+<li><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">org.apache.poi.poifs.filesystem.OPOIFSFileSystem</a></li>
+<li>
+<ul class="inheritance">
 <li>org.apache.poi.poifs.filesystem.POIFSFileSystem</li>
 </ul>
 </li>
 </ul>
+</li>
+</ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
@@ -99,12 +104,11 @@
 <hr>
 <br>
 <pre>public class <span class="strong">POIFSFileSystem</span>
-extends java.lang.Object
+extends <a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">OPOIFSFileSystem</a>
 implements <a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html" title="interface in org.apache.poi.poifs.dev">POIFSViewable</a></pre>
-<div class="block">This is the main class of the POIFS system; it manages the entire
- life cycle of the filesystem.</div>
-<dl><dt><span class="strong">Author:</span></dt>
-  <dd>Marc Johnson (mjohnson at apache dot org)</dd></dl>
+<div class="block">Transition class for the move from <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a> to 
+  <a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>OPOIFSFileSystem</code></a>, and from <a href="../../../../../org/apache/poi/poifs/filesystem/NPOIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>NPOIFSFileSystem</code></a> to
+  <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a>. Currently, this is OPOIFS-powered</div>
 </li>
 </ul>
 </div>
@@ -148,75 +152,12 @@ implements <a href="../../../../../org/a
 <th class="colLast" scope="col">Method and Description</th>
 </tr>
 <tr class="altColor">
-<td class="colFirst"><code><a href="../../../../../org/apache/poi/poifs/filesystem/DirectoryEntry.html" title="interface in org.apache.poi.poifs.filesystem">DirectoryEntry</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html#createDirectory(java.lang.String)">createDirectory</a></strong>(java.lang.String&nbsp;name)</code>
-<div class="block">create a new DirectoryEntry in the root directory</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code><a href="../../../../../org/apache/poi/poifs/filesystem/DocumentEntry.html" title="interface in org.apache.poi.poifs.filesystem">DocumentEntry</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html#createDocument(java.io.InputStream,%20java.lang.String)">createDocument</a></strong>(java.io.InputStream&nbsp;stream,
-              java.lang.String&nbsp;name)</code>
-<div class="block">Create a new document to be added to the root directory</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code><a href="../../../../../org/apache/poi/poifs/filesystem/DocumentEntry.html" title="interface in org.apache.poi.poifs.filesystem">DocumentEntry</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html#createDocument(java.lang.String,%20int,%20org.apache.poi.poifs.filesystem.POIFSWriterListener)">createDocument</a></strong>(java.lang.String&nbsp;name,
-              int&nbsp;size,
-              <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSWriterListener.html" title="interface in org.apache.poi.poifs.filesystem">POIFSWriterListener</a>&nbsp;writer)</code>
-<div class="block">create a new DocumentEntry in the root entry; the data will be
- provided later</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code><a href="../../../../../org/apache/poi/poifs/filesystem/DocumentInputStream.html" title="class in org.apache.poi.poifs.filesystem">DocumentInputStream</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html#createDocumentInputStream(java.lang.String)">createDocumentInputStream</a></strong>(java.lang.String&nbsp;documentName)</code>
-<div class="block">open a document in the root entry's list of entries</div>
-</td>
-</tr>
-<tr class="altColor">
 <td class="colFirst"><code>static java.io.InputStream</code></td>
 <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html#createNonClosingInputStream(java.io.InputStream)">createNonClosingInputStream</a></strong>(java.io.InputStream&nbsp;is)</code>
 <div class="block">Convenience method for clients that want to avoid the auto-close behaviour of the constructor.</div>
 </td>
 </tr>
 <tr class="rowColor">
-<td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html#getBigBlockSize()">getBigBlockSize</a></strong>()</code>&nbsp;</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code><a href="../../../../../org/apache/poi/poifs/common/POIFSBigBlockSize.html" title="class in org.apache.poi.poifs.common">POIFSBigBlockSize</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html#getBigBlockSizeDetails()">getBigBlockSizeDetails</a></strong>()</code>&nbsp;</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code><a href="../../../../../org/apache/poi/poifs/filesystem/DirectoryNode.html" title="class in org.apache.poi.poifs.filesystem">DirectoryNode</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html#getRoot()">getRoot</a></strong>()</code>
-<div class="block">get the root entry</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>java.lang.String</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html#getShortDescription()">getShortDescription</a></strong>()</code>
-<div class="block">Provides a short description of the object, to be used when a
- POIFSViewable object has not provided its contents.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>java.lang.Object[]</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html#getViewableArray()">getViewableArray</a></strong>()</code>
-<div class="block">Get an array of objects, some of which may implement
- POIFSViewable</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>java.util.Iterator&lt;java.lang.Object&gt;</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html#getViewableIterator()">getViewableIterator</a></strong>()</code>
-<div class="block">Get an Iterator of objects, some of which may implement
- POIFSViewable</div>
-</td>
-</tr>
-<tr class="rowColor">
 <td class="colFirst"><code>static boolean</code></td>
 <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html#hasPOIFSHeader(byte[])">hasPOIFSHeader</a></strong>(byte[]&nbsp;header8Bytes)</code>
 <div class="block">Checks if the supplied first 8 bytes of a stream / file
@@ -237,27 +178,28 @@ implements <a href="../../../../../org/a
 <div class="block">read in a file and write it back out again</div>
 </td>
 </tr>
-<tr class="altColor">
-<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html#preferArray()">preferArray</a></strong>()</code>
-<div class="block">Give viewers a hint as to whether to call getViewableArray or
- getViewableIterator</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html#writeFilesystem(java.io.OutputStream)">writeFilesystem</a></strong>(java.io.OutputStream&nbsp;stream)</code>
-<div class="block">Write the filesystem out</div>
-</td>
-</tr>
 </table>
 <ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.poifs.filesystem.OPOIFSFileSystem">
+<!--   -->
+</a>
+<h3>Methods inherited from class&nbsp;org.apache.poi.poifs.filesystem.<a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">OPOIFSFileSystem</a></h3>
+<code><a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#closeInputStream(java.io.InputStream,%20boolean)">closeInputStream</a>, <a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#createDirectory(java.lang.String)">createDirectory</a>, <a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#createDocument(java.io.InputStream,%20java.lang.String)">createDocument</a>, <a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#createDocument(java.lang.String,%20int,%20org.apache.poi.poifs.filesystem.POIFSWriterListener)">createDocument</a>, <a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#createDocumentInputStream(java.lang.String)">createDocumentInputStream</a>, <a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#getBigBlockSize()">getBigBlockSize</a>, <a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#getBigBl
 ockSizeDetails()">getBigBlockSizeDetails</a>, <a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#getRoot()">getRoot</a>, <a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#getShortDescription()">getShortDescription</a>, <a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#getViewableArray()">getViewableArray</a>, <a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#getViewableIterator()">getViewableIterator</a>, <a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#preferArray()">preferArray</a>, <a href="../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html#writeFilesystem(java.io.OutputStream)">writeFilesystem</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&nbsp;java.lang.Object</h3>
 <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
 </ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.poifs.dev.POIFSViewable">
+<!--   -->
+</a>
+<h3>Methods inherited from interface&nbsp;org.apache.poi.poifs.dev.<a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html" title="interface in org.apache.poi.poifs.dev">POIFSViewable</a></h3>
+<code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html#getShortDescription()">getShortDescription</a>, <a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html#getViewableArray()">getViewableArray</a>, <a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html#getViewableIterator()">getViewableIterator</a>, <a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html#preferArray()">preferArray</a></code></li>
+</ul>
 </li>
 </ul>
 </li>
@@ -365,75 +307,10 @@ implements <a href="../../../../../org/a
   has a POIFS (OLE2) header.</div>
 </li>
 </ul>
-<a name="createDocument(java.io.InputStream, java.lang.String)">
-<!--   -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>createDocument</h4>
-<pre>public&nbsp;<a href="../../../../../org/apache/poi/poifs/filesystem/DocumentEntry.html" title="interface in org.apache.poi.poifs.filesystem">DocumentEntry</a>&nbsp;createDocument(java.io.InputStream&nbsp;stream,
-                           java.lang.String&nbsp;name)
-                             throws java.io.IOException</pre>
-<div class="block">Create a new document to be added to the root directory</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - the InputStream from which the document's data
-               will be obtained</dd><dd><code>name</code> - the name of the new POIFSDocument</dd>
-<dt><span class="strong">Returns:</span></dt><dd>the new DocumentEntry</dd>
-<dt><span class="strong">Throws:</span></dt>
-<dd><code>java.io.IOException</code> - on error creating the new POIFSDocument</dd></dl>
-</li>
-</ul>
-<a name="createDocument(java.lang.String, int, org.apache.poi.poifs.filesystem.POIFSWriterListener)">
-<!--   -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>createDocument</h4>
-<pre>public&nbsp;<a href="../../../../../org/apache/poi/poifs/filesystem/DocumentEntry.html" title="interface in org.apache.poi.poifs.filesystem">DocumentEntry</a>&nbsp;createDocument(java.lang.String&nbsp;name,
-                           int&nbsp;size,
-                           <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSWriterListener.html" title="interface in org.apache.poi.poifs.filesystem">POIFSWriterListener</a>&nbsp;writer)
-                             throws java.io.IOException</pre>
-<div class="block">create a new DocumentEntry in the root entry; the data will be
- provided later</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the new DocumentEntry</dd><dd><code>size</code> - the size of the new DocumentEntry</dd><dd><code>writer</code> - the writer of the new DocumentEntry</dd>
-<dt><span class="strong">Returns:</span></dt><dd>the new DocumentEntry</dd>
-<dt><span class="strong">Throws:</span></dt>
-<dd><code>java.io.IOException</code></dd></dl>
-</li>
-</ul>
-<a name="createDirectory(java.lang.String)">
-<!--   -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>createDirectory</h4>
-<pre>public&nbsp;<a href="../../../../../org/apache/poi/poifs/filesystem/DirectoryEntry.html" title="interface in org.apache.poi.poifs.filesystem">DirectoryEntry</a>&nbsp;createDirectory(java.lang.String&nbsp;name)
-                               throws java.io.IOException</pre>
-<div class="block">create a new DirectoryEntry in the root directory</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the new DirectoryEntry</dd>
-<dt><span class="strong">Returns:</span></dt><dd>the new DirectoryEntry</dd>
-<dt><span class="strong">Throws:</span></dt>
-<dd><code>java.io.IOException</code> - on name duplication</dd></dl>
-</li>
-</ul>
-<a name="writeFilesystem(java.io.OutputStream)">
-<!--   -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>writeFilesystem</h4>
-<pre>public&nbsp;void&nbsp;writeFilesystem(java.io.OutputStream&nbsp;stream)
-                     throws java.io.IOException</pre>
-<div class="block">Write the filesystem out</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - the OutputStream to which the filesystem will be
-               written</dd>
-<dt><span class="strong">Throws:</span></dt>
-<dd><code>java.io.IOException</code> - thrown on errors writing to the stream</dd></dl>
-</li>
-</ul>
 <a name="main(java.lang.String[])">
 <!--   -->
 </a>
-<ul class="blockList">
+<ul class="blockListLast">
 <li class="blockList">
 <h4>main</h4>
 <pre>public static&nbsp;void&nbsp;main(java.lang.String[]&nbsp;args)
@@ -445,115 +322,6 @@ implements <a href="../../../../../org/a
 <dd><code>java.io.IOException</code></dd></dl>
 </li>
 </ul>
-<a name="getRoot()">
-<!--   -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>getRoot</h4>
-<pre>public&nbsp;<a href="../../../../../org/apache/poi/poifs/filesystem/DirectoryNode.html" title="class in org.apache.poi.poifs.filesystem">DirectoryNode</a>&nbsp;getRoot()</pre>
-<div class="block">get the root entry</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>the root entry</dd></dl>
-</li>
-</ul>
-<a name="createDocumentInputStream(java.lang.String)">
-<!--   -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>createDocumentInputStream</h4>
-<pre>public&nbsp;<a href="../../../../../org/apache/poi/poifs/filesystem/DocumentInputStream.html" title="class in org.apache.poi.poifs.filesystem">DocumentInputStream</a>&nbsp;createDocumentInputStream(java.lang.String&nbsp;documentName)
-                                              throws java.io.IOException</pre>
-<div class="block">open a document in the root entry's list of entries</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>documentName</code> - the name of the document to be opened</dd>
-<dt><span class="strong">Returns:</span></dt><dd>a newly opened DocumentInputStream</dd>
-<dt><span class="strong">Throws:</span></dt>
-<dd><code>java.io.IOException</code> - if the document does not exist or the
-            name is that of a DirectoryEntry</dd></dl>
-</li>
-</ul>
-<a name="getViewableArray()">
-<!--   -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>getViewableArray</h4>
-<pre>public&nbsp;java.lang.Object[]&nbsp;getViewableArray()</pre>
-<div class="block">Get an array of objects, some of which may implement
- POIFSViewable</div>
-<dl>
-<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html#getViewableArray()">getViewableArray</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html" title="interface in org.apache.poi.poifs.dev">POIFSViewable</a></code></dd>
-<dt><span class="strong">Returns:</span></dt><dd>an array of Object; may not be null, but may be empty</dd></dl>
-</li>
-</ul>
-<a name="getViewableIterator()">
-<!--   -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>getViewableIterator</h4>
-<pre>public&nbsp;java.util.Iterator&lt;java.lang.Object&gt;&nbsp;getViewableIterator()</pre>
-<div class="block">Get an Iterator of objects, some of which may implement
- POIFSViewable</div>
-<dl>
-<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html#getViewableIterator()">getViewableIterator</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html" title="interface in org.apache.poi.poifs.dev">POIFSViewable</a></code></dd>
-<dt><span class="strong">Returns:</span></dt><dd>an Iterator; may not be null, but may have an empty
- back end store</dd></dl>
-</li>
-</ul>
-<a name="preferArray()">
-<!--   -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>preferArray</h4>
-<pre>public&nbsp;boolean&nbsp;preferArray()</pre>
-<div class="block">Give viewers a hint as to whether to call getViewableArray or
- getViewableIterator</div>
-<dl>
-<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html#preferArray()">preferArray</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html" title="interface in org.apache.poi.poifs.dev">POIFSViewable</a></code></dd>
-<dt><span class="strong">Returns:</span></dt><dd>true if a viewer should call getViewableArray, false if
-         a viewer should call getViewableIterator</dd></dl>
-</li>
-</ul>
-<a name="getShortDescription()">
-<!--   -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>getShortDescription</h4>
-<pre>public&nbsp;java.lang.String&nbsp;getShortDescription()</pre>
-<div class="block">Provides a short description of the object, to be used when a
- POIFSViewable object has not provided its contents.</div>
-<dl>
-<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html#getShortDescription()">getShortDescription</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/poifs/dev/POIFSViewable.html" title="interface in org.apache.poi.poifs.dev">POIFSViewable</a></code></dd>
-<dt><span class="strong">Returns:</span></dt><dd>short description</dd></dl>
-</li>
-</ul>
-<a name="getBigBlockSize()">
-<!--   -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>getBigBlockSize</h4>
-<pre>public&nbsp;int&nbsp;getBigBlockSize()</pre>
-<dl><dt><span class="strong">Returns:</span></dt><dd>The Big Block size, normally 512 bytes, sometimes 4096 bytes</dd></dl>
-</li>
-</ul>
-<a name="getBigBlockSizeDetails()">
-<!--   -->
-</a>
-<ul class="blockListLast">
-<li class="blockList">
-<h4>getBigBlockSizeDetails</h4>
-<pre>public&nbsp;<a href="../../../../../org/apache/poi/poifs/common/POIFSBigBlockSize.html" title="class in org.apache.poi.poifs.common">POIFSBigBlockSize</a>&nbsp;getBigBlockSizeDetails()</pre>
-<dl><dt><span class="strong">Returns:</span></dt><dd>The Big Block size, normally 512 bytes, sometimes 4096 bytes</dd></dl>
-</li>
-</ul>
 </li>
 </ul>
 </li>

Modified: poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/BATManaged.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/BATManaged.html?rev=1678837&r1=1678836&r2=1678837&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/BATManaged.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/BATManaged.html Mon May 11 23:44:49 2015
@@ -110,8 +110,9 @@ Compound Document Format.</div>
 <tbody>
 <tr class="altColor">
 <td class="colFirst"><code>class&nbsp;</code></td>
-<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/filesystem/POIFSDocument.html" title="class in org.apache.poi.poifs.filesystem">POIFSDocument</a></strong></code>
-<div class="block">This class manages a document in the POIFS filesystem.</div>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/filesystem/OPOIFSDocument.html" title="class in org.apache.poi.poifs.filesystem">OPOIFSDocument</a></strong></code>
+<div class="block">This class manages a document in a old-style 
+  OPOIFS filesystem.</div>
 </td>
 </tr>
 </tbody>
@@ -139,7 +140,7 @@ Compound Document Format.</div>
 <tr class="rowColor">
 <td class="colFirst"><code>class&nbsp;</code></td>
 <td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/poifs/property/PropertyTable.html" title="class in org.apache.poi.poifs.property">PropertyTable</a></strong></code>
-<div class="block">This class embodies the Property Table for the <a href="../../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a>; 
+<div class="block">This class embodies the Property Table for the <code>POIFSFileSystem</code>; 
   this is basically the directory for all of the documents in the
  filesystem.</div>
 </td>



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org