poi-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From n...@apache.org
Subject svn commit: r1753654 [2/2] - in /poi/site/publish/apidocs: ./ org/apache/poi/ org/apache/poi/class-use/ org/apache/poi/hdgf/ org/apache/poi/hpbf/ org/apache/poi/hpsf/ org/apache/poi/hslf/usermodel/ org/apache/poi/hsmf/ org/apache/poi/hssf/usermodel/ or...
Date Thu, 21 Jul 2016 10:22:52 GMT
Modified: poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/HSSFWorkbook.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/HSSFWorkbook.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/HSSFWorkbook.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/HSSFWorkbook.html Thu Jul 21 10:22:51 2016
@@ -748,11 +748,17 @@ implements <a href="../../../../../org/a
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#write(java.io.File)">write</a></strong>(java.io.File&nbsp;newFile)</code>
+<div class="block">Method write - write out this workbook to a new <code>File</code>.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#write(java.io.OutputStream)">write</a></strong>(java.io.OutputStream&nbsp;stream)</code>
 <div class="block">Method write - write out this workbook to an <code>OutputStream</code>.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#writeProtectWorkbook(java.lang.String,%20java.lang.String)">writeProtectWorkbook</a></strong>(java.lang.String&nbsp;password,
                     java.lang.String&nbsp;username)</code>
@@ -766,7 +772,7 @@ implements <a href="../../../../../org/a
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;org.apache.poi.<a href="../../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></h3>
-<code><a href="../../../../../org/apache/poi/POIDocument.html#createInformationProperties()">createInformationProperties</a>, <a href="../../../../../org/apache/poi/POIDocument.html#getDirectory()">getDirectory</a>, <a href="../../../../../org/apache/poi/POIDocument.html#getDocumentSummaryInformation()">getDocumentSummaryInformation</a>, <a href="../../../../../org/apache/poi/POIDocument.html#getPropertySet(java.lang.String)">getPropertySet</a>, <a href="../../../../../org/apache/poi/POIDocument.html#getPropertySet(java.lang.String,%20org.apache.poi.poifs.crypt.EncryptionInfo)">getPropertySet</a>, <a href="../../../../../org/apache/poi/POIDocument.html#getSummaryInformation()">getSummaryInformation</a>, <a href="../../../../../org/apache/poi/POIDocument.html#readProperties()">readProperties</a>, <a href="../../../../../org/apache/poi/POIDocument.html#writeProperties()">writeProperties</a>, <a href="../../../../../org/apache/poi/POIDocument.html#writeProperties(org.apache.poi.poifs.f
 ilesystem.NPOIFSFileSystem)">writeProperties</a>, <a href="../../../../../org/apache/poi/POIDocument.html#writeProperties(org.apache.poi.poifs.filesystem.NPOIFSFileSystem,%20java.util.List)">writeProperties</a>, <a href="../../../../../org/apache/poi/POIDocument.html#writePropertySet(java.lang.String,%20org.apache.poi.hpsf.PropertySet,%20org.apache.poi.poifs.filesystem.NPOIFSFileSystem)">writePropertySet</a></code></li>
+<code><a href="../../../../../org/apache/poi/POIDocument.html#createInformationProperties()">createInformationProperties</a>, <a href="../../../../../org/apache/poi/POIDocument.html#getDirectory()">getDirectory</a>, <a href="../../../../../org/apache/poi/POIDocument.html#getDocumentSummaryInformation()">getDocumentSummaryInformation</a>, <a href="../../../../../org/apache/poi/POIDocument.html#getPropertySet(java.lang.String)">getPropertySet</a>, <a href="../../../../../org/apache/poi/POIDocument.html#getPropertySet(java.lang.String,%20org.apache.poi.poifs.crypt.EncryptionInfo)">getPropertySet</a>, <a href="../../../../../org/apache/poi/POIDocument.html#getSummaryInformation()">getSummaryInformation</a>, <a href="../../../../../org/apache/poi/POIDocument.html#readProperties()">readProperties</a>, <a href="../../../../../org/apache/poi/POIDocument.html#validateInPlaceWritePossible()">validateInPlaceWritePossible</a>, <a href="../../../../../org/apache/poi/POIDocument.html#writePropert
 ies()">writeProperties</a>, <a href="../../../../../org/apache/poi/POIDocument.html#writeProperties(org.apache.poi.poifs.filesystem.NPOIFSFileSystem)">writeProperties</a>, <a href="../../../../../org/apache/poi/POIDocument.html#writeProperties(org.apache.poi.poifs.filesystem.NPOIFSFileSystem,%20java.util.List)">writeProperties</a>, <a href="../../../../../org/apache/poi/POIDocument.html#writePropertySet(java.lang.String,%20org.apache.poi.hpsf.PropertySet,%20org.apache.poi.poifs.filesystem.NPOIFSFileSystem)">writePropertySet</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
@@ -1716,12 +1722,41 @@ public&nbsp;<a href="../../../../../org/
            throws java.io.IOException</pre>
 <div class="block">Write out this workbook to the currently open <code>File</code> via the
   writeable <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a> it was opened as. 
+  
  <p>This will fail (with an <code>IllegalStateException</code> if the
   Workbook was opened read-only, opened from an <code>InputStream</code>
    instead of a File, or if this is not the root document. For those cases, 
-   you must use <a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#write(java.io.OutputStream)"><code>write(OutputStream)</code></a> to write to a brand new stream.</div>
-<dl><dt><span class="strong">Throws:</span></dt>
-<dd><code>java.io.IOException</code></dd></dl>
+   you must use <a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#write(java.io.OutputStream)"><code>write(OutputStream)</code></a> or <a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#write(java.io.File)"><code>write(File)</code></a> to 
+   write to a brand new document.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../org/apache/poi/POIDocument.html#write()">write</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></code></dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - thrown on errors writing to the file</dd></dl>
+</li>
+</ul>
+<a name="write(java.io.File)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>write</h4>
+<pre>public&nbsp;void&nbsp;write(java.io.File&nbsp;newFile)
+           throws java.io.IOException</pre>
+<div class="block">Method write - write out this workbook to a new <code>File</code>. Constructs
+ a new POI POIFSFileSystem, passes in the workbook binary representation and
+ writes it out. If the file exists, it will be replaced, otherwise a new one
+ will be created.
+ 
+ Note that you cannot write to the currently open File using this method.
+ If you opened your Workbook from a File, you <i>must</i> use the <a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#write()"><code>write()</code></a>
+ method instead!</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../org/apache/poi/POIDocument.html#write(java.io.File)">write</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>newFile</code> - The new File you wish to write the XLS to</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - if anything can't be written.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a></dd></dl>
 </li>
 </ul>
 <a name="write(java.io.OutputStream)">
@@ -1732,8 +1767,8 @@ public&nbsp;<a href="../../../../../org/
 <h4>write</h4>
 <pre>public&nbsp;void&nbsp;write(java.io.OutputStream&nbsp;stream)
            throws java.io.IOException</pre>
-<div class="block">Method write - write out this workbook to an <code>OutputStream</code>.  Constructs
- a new POI POIFSFileSystem, passes in the workbook binary representation  and
+<div class="block">Method write - write out this workbook to an <code>OutputStream</code>. Constructs
+ a new POI POIFSFileSystem, passes in the workbook binary representation and
  writes it out.
  
  If <code>stream</code> is a <code>FileOutputStream</code> on a networked drive

Modified: poi/site/publish/apidocs/org/apache/poi/hwpf/HWPFDocument.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hwpf/HWPFDocument.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/hwpf/HWPFDocument.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/hwpf/HWPFDocument.html Thu Jul 21 10:22:51 2016
@@ -112,8 +112,6 @@
 extends <a href="../../../../org/apache/poi/hwpf/HWPFDocumentCore.html" title="class in org.apache.poi.hwpf">HWPFDocumentCore</a></pre>
 <div class="block">This class acts as the bucket that we throw all of the Word data structures
  into.</div>
-<dl><dt><span class="strong">Author:</span></dt>
-  <dd>Ryan Ackley</dd></dl>
 </li>
 </ul>
 </div>
@@ -451,6 +449,19 @@ extends <a href="../../../../org/apache/
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hwpf/HWPFDocument.html#write()">write</a></strong>()</code>
+<div class="block">Writes the document out to the currently open <code>File</code>, via the
+  writeable <a href="../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a> it was opened from.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hwpf/HWPFDocument.html#write(java.io.File)">write</a></strong>(java.io.File&nbsp;newFile)</code>
+<div class="block">Writes the document out to the specified new <code>File</code>.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hwpf/HWPFDocument.html#write(java.io.OutputStream)">write</a></strong>(java.io.OutputStream&nbsp;out)</code>
 <div class="block">Writes out the word file that is represented by an instance of this class.</div>
 </td>
@@ -468,7 +479,7 @@ extends <a href="../../../../org/apache/
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;org.apache.poi.<a href="../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></h3>
-<code><a href="../../../../org/apache/poi/POIDocument.html#close()">close</a>, <a href="../../../../org/apache/poi/POIDocument.html#createInformationProperties()">createInformationProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#getDirectory()">getDirectory</a>, <a href="../../../../org/apache/poi/POIDocument.html#getDocumentSummaryInformation()">getDocumentSummaryInformation</a>, <a href="../../../../org/apache/poi/POIDocument.html#getPropertySet(java.lang.String)">getPropertySet</a>, <a href="../../../../org/apache/poi/POIDocument.html#getPropertySet(java.lang.String,%20org.apache.poi.poifs.crypt.EncryptionInfo)">getPropertySet</a>, <a href="../../../../org/apache/poi/POIDocument.html#getSummaryInformation()">getSummaryInformation</a>, <a href="../../../../org/apache/poi/POIDocument.html#readProperties()">readProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#writeProperties()">writeProperties</a>, <a href="../../../../org/apache/poi/POIDocume
 nt.html#writeProperties(org.apache.poi.poifs.filesystem.NPOIFSFileSystem)">writeProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#writeProperties(org.apache.poi.poifs.filesystem.NPOIFSFileSystem,%20java.util.List)">writeProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#writePropertySet(java.lang.String,%20org.apache.poi.hpsf.PropertySet,%20org.apache.poi.poifs.filesystem.NPOIFSFileSystem)">writePropertySet</a></code></li>
+<code><a href="../../../../org/apache/poi/POIDocument.html#close()">close</a>, <a href="../../../../org/apache/poi/POIDocument.html#createInformationProperties()">createInformationProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#getDirectory()">getDirectory</a>, <a href="../../../../org/apache/poi/POIDocument.html#getDocumentSummaryInformation()">getDocumentSummaryInformation</a>, <a href="../../../../org/apache/poi/POIDocument.html#getPropertySet(java.lang.String)">getPropertySet</a>, <a href="../../../../org/apache/poi/POIDocument.html#getPropertySet(java.lang.String,%20org.apache.poi.poifs.crypt.EncryptionInfo)">getPropertySet</a>, <a href="../../../../org/apache/poi/POIDocument.html#getSummaryInformation()">getSummaryInformation</a>, <a href="../../../../org/apache/poi/POIDocument.html#readProperties()">readProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#validateInPlaceWritePossible()">validateInPlaceWritePossible</a>, <a href="../../../.
 ./org/apache/poi/POIDocument.html#writeProperties()">writeProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#writeProperties(org.apache.poi.poifs.filesystem.NPOIFSFileSystem)">writeProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#writeProperties(org.apache.poi.poifs.filesystem.NPOIFSFileSystem,%20java.util.List)">writeProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#writePropertySet(java.lang.String,%20org.apache.poi.hpsf.PropertySet,%20org.apache.poi.poifs.filesystem.NPOIFSFileSystem)">writePropertySet</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
@@ -1007,6 +1018,49 @@ public&nbsp;<a href="../../../../org/apa
 <dl><dt><span class="strong">Returns:</span></dt><dd>user-friendly interface to access document <a href="../../../../org/apache/poi/hwpf/usermodel/Field.html" title="interface in org.apache.poi.hwpf.usermodel"><code>Field</code></a>s</dd></dl>
 </li>
 </ul>
+<a name="write()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>write</h4>
+<pre>public&nbsp;void&nbsp;write()
+           throws java.io.IOException</pre>
+<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../org/apache/poi/POIDocument.html#write()">POIDocument</a></code></strong></div>
+<div class="block">Writes the document out to the currently open <code>File</code>, via the
+  writeable <a href="../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a> it was opened from.
+  
+ <p>This will fail (with an <code>IllegalStateException</code> if the
+  document was opened read-only, opened from an <code>InputStream</code>
+   instead of a File, or if this is not the root document. For those cases, 
+   you must use <a href="../../../../org/apache/poi/POIDocument.html#write(java.io.OutputStream)"><code>POIDocument.write(OutputStream)</code></a> or <a href="../../../../org/apache/poi/POIDocument.html#write(java.io.File)"><code>POIDocument.write(File)</code></a> to 
+   write to a brand new document.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../org/apache/poi/POIDocument.html#write()">write</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></code></dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - thrown on errors writing to the file</dd></dl>
+</li>
+</ul>
+<a name="write(java.io.File)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>write</h4>
+<pre>public&nbsp;void&nbsp;write(java.io.File&nbsp;newFile)
+           throws java.io.IOException</pre>
+<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../org/apache/poi/POIDocument.html#write(java.io.File)">POIDocument</a></code></strong></div>
+<div class="block">Writes the document out to the specified new <code>File</code>. If the file 
+ exists, it will be replaced, otherwise a new one will be created</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../org/apache/poi/POIDocument.html#write(java.io.File)">write</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>newFile</code> - The new File to write to.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - thrown on errors writing to the file</dd></dl>
+</li>
+</ul>
 <a name="write(java.io.OutputStream)">
 <!--   -->
 </a>

Modified: poi/site/publish/apidocs/org/apache/poi/hwpf/HWPFDocumentCore.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hwpf/HWPFDocumentCore.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/hwpf/HWPFDocumentCore.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/hwpf/HWPFDocumentCore.html Thu Jul 21 10:22:51 2016
@@ -332,7 +332,7 @@ extends <a href="../../../../org/apache/
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;org.apache.poi.<a href="../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></h3>
-<code><a href="../../../../org/apache/poi/POIDocument.html#close()">close</a>, <a href="../../../../org/apache/poi/POIDocument.html#createInformationProperties()">createInformationProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#getDirectory()">getDirectory</a>, <a href="../../../../org/apache/poi/POIDocument.html#getDocumentSummaryInformation()">getDocumentSummaryInformation</a>, <a href="../../../../org/apache/poi/POIDocument.html#getPropertySet(java.lang.String)">getPropertySet</a>, <a href="../../../../org/apache/poi/POIDocument.html#getPropertySet(java.lang.String,%20org.apache.poi.poifs.crypt.EncryptionInfo)">getPropertySet</a>, <a href="../../../../org/apache/poi/POIDocument.html#getSummaryInformation()">getSummaryInformation</a>, <a href="../../../../org/apache/poi/POIDocument.html#readProperties()">readProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#write(java.io.OutputStream)">write</a>, <a href="../../../../org/apache/poi/POIDocume
 nt.html#writeProperties()">writeProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#writeProperties(org.apache.poi.poifs.filesystem.NPOIFSFileSystem)">writeProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#writeProperties(org.apache.poi.poifs.filesystem.NPOIFSFileSystem,%20java.util.List)">writeProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#writePropertySet(java.lang.String,%20org.apache.poi.hpsf.PropertySet,%20org.apache.poi.poifs.filesystem.NPOIFSFileSystem)">writePropertySet</a></code></li>
+<code><a href="../../../../org/apache/poi/POIDocument.html#close()">close</a>, <a href="../../../../org/apache/poi/POIDocument.html#createInformationProperties()">createInformationProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#getDirectory()">getDirectory</a>, <a href="../../../../org/apache/poi/POIDocument.html#getDocumentSummaryInformation()">getDocumentSummaryInformation</a>, <a href="../../../../org/apache/poi/POIDocument.html#getPropertySet(java.lang.String)">getPropertySet</a>, <a href="../../../../org/apache/poi/POIDocument.html#getPropertySet(java.lang.String,%20org.apache.poi.poifs.crypt.EncryptionInfo)">getPropertySet</a>, <a href="../../../../org/apache/poi/POIDocument.html#getSummaryInformation()">getSummaryInformation</a>, <a href="../../../../org/apache/poi/POIDocument.html#readProperties()">readProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#validateInPlaceWritePossible()">validateInPlaceWritePossible</a>, <a href="../../../.
 ./org/apache/poi/POIDocument.html#write()">write</a>, <a href="../../../../org/apache/poi/POIDocument.html#write(java.io.File)">write</a>, <a href="../../../../org/apache/poi/POIDocument.html#write(java.io.OutputStream)">write</a>, <a href="../../../../org/apache/poi/POIDocument.html#writeProperties()">writeProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#writeProperties(org.apache.poi.poifs.filesystem.NPOIFSFileSystem)">writeProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#writeProperties(org.apache.poi.poifs.filesystem.NPOIFSFileSystem,%20java.util.List)">writeProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#writePropertySet(java.lang.String,%20org.apache.poi.hpsf.PropertySet,%20org.apache.poi.poifs.filesystem.NPOIFSFileSystem)">writePropertySet</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">

Modified: poi/site/publish/apidocs/org/apache/poi/hwpf/HWPFOldDocument.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hwpf/HWPFOldDocument.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/hwpf/HWPFOldDocument.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/hwpf/HWPFOldDocument.html Thu Jul 21 10:22:51 2016
@@ -198,6 +198,19 @@ extends <a href="../../../../org/apache/
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hwpf/HWPFOldDocument.html#write()">write</a></strong>()</code>
+<div class="block">Writes the document out to the currently open <code>File</code>, via the
+  writeable <a href="../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a> it was opened from.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hwpf/HWPFOldDocument.html#write(java.io.File)">write</a></strong>(java.io.File&nbsp;out)</code>
+<div class="block">Writes the document out to the specified new <code>File</code>.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hwpf/HWPFOldDocument.html#write(java.io.OutputStream)">write</a></strong>(java.io.OutputStream&nbsp;out)</code>
 <div class="block">Writes the document out to the specified output stream.</div>
 </td>
@@ -215,7 +228,7 @@ extends <a href="../../../../org/apache/
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;org.apache.poi.<a href="../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></h3>
-<code><a href="../../../../org/apache/poi/POIDocument.html#close()">close</a>, <a href="../../../../org/apache/poi/POIDocument.html#createInformationProperties()">createInformationProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#getDirectory()">getDirectory</a>, <a href="../../../../org/apache/poi/POIDocument.html#getDocumentSummaryInformation()">getDocumentSummaryInformation</a>, <a href="../../../../org/apache/poi/POIDocument.html#getPropertySet(java.lang.String)">getPropertySet</a>, <a href="../../../../org/apache/poi/POIDocument.html#getPropertySet(java.lang.String,%20org.apache.poi.poifs.crypt.EncryptionInfo)">getPropertySet</a>, <a href="../../../../org/apache/poi/POIDocument.html#getSummaryInformation()">getSummaryInformation</a>, <a href="../../../../org/apache/poi/POIDocument.html#readProperties()">readProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#writeProperties()">writeProperties</a>, <a href="../../../../org/apache/poi/POIDocume
 nt.html#writeProperties(org.apache.poi.poifs.filesystem.NPOIFSFileSystem)">writeProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#writeProperties(org.apache.poi.poifs.filesystem.NPOIFSFileSystem,%20java.util.List)">writeProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#writePropertySet(java.lang.String,%20org.apache.poi.hpsf.PropertySet,%20org.apache.poi.poifs.filesystem.NPOIFSFileSystem)">writePropertySet</a></code></li>
+<code><a href="../../../../org/apache/poi/POIDocument.html#close()">close</a>, <a href="../../../../org/apache/poi/POIDocument.html#createInformationProperties()">createInformationProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#getDirectory()">getDirectory</a>, <a href="../../../../org/apache/poi/POIDocument.html#getDocumentSummaryInformation()">getDocumentSummaryInformation</a>, <a href="../../../../org/apache/poi/POIDocument.html#getPropertySet(java.lang.String)">getPropertySet</a>, <a href="../../../../org/apache/poi/POIDocument.html#getPropertySet(java.lang.String,%20org.apache.poi.poifs.crypt.EncryptionInfo)">getPropertySet</a>, <a href="../../../../org/apache/poi/POIDocument.html#getSummaryInformation()">getSummaryInformation</a>, <a href="../../../../org/apache/poi/POIDocument.html#readProperties()">readProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#validateInPlaceWritePossible()">validateInPlaceWritePossible</a>, <a href="../../../.
 ./org/apache/poi/POIDocument.html#writeProperties()">writeProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#writeProperties(org.apache.poi.poifs.filesystem.NPOIFSFileSystem)">writeProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#writeProperties(org.apache.poi.poifs.filesystem.NPOIFSFileSystem,%20java.util.List)">writeProperties</a>, <a href="../../../../org/apache/poi/POIDocument.html#writePropertySet(java.lang.String,%20org.apache.poi.hpsf.PropertySet,%20org.apache.poi.poifs.filesystem.NPOIFSFileSystem)">writePropertySet</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
@@ -330,6 +343,49 @@ extends <a href="../../../../org/apache/
 </dl>
 </li>
 </ul>
+<a name="write()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>write</h4>
+<pre>public&nbsp;void&nbsp;write()
+           throws java.io.IOException</pre>
+<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../org/apache/poi/POIDocument.html#write()">POIDocument</a></code></strong></div>
+<div class="block">Writes the document out to the currently open <code>File</code>, via the
+  writeable <a href="../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a> it was opened from.
+  
+ <p>This will fail (with an <code>IllegalStateException</code> if the
+  document was opened read-only, opened from an <code>InputStream</code>
+   instead of a File, or if this is not the root document. For those cases, 
+   you must use <a href="../../../../org/apache/poi/POIDocument.html#write(java.io.OutputStream)"><code>POIDocument.write(OutputStream)</code></a> or <a href="../../../../org/apache/poi/POIDocument.html#write(java.io.File)"><code>POIDocument.write(File)</code></a> to 
+   write to a brand new document.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../org/apache/poi/POIDocument.html#write()">write</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></code></dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - thrown on errors writing to the file</dd></dl>
+</li>
+</ul>
+<a name="write(java.io.File)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>write</h4>
+<pre>public&nbsp;void&nbsp;write(java.io.File&nbsp;out)
+           throws java.io.IOException</pre>
+<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../org/apache/poi/POIDocument.html#write(java.io.File)">POIDocument</a></code></strong></div>
+<div class="block">Writes the document out to the specified new <code>File</code>. If the file 
+ exists, it will be replaced, otherwise a new one will be created</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../org/apache/poi/POIDocument.html#write(java.io.File)">write</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - The new File to write to.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - thrown on errors writing to the file</dd></dl>
+</li>
+</ul>
 <a name="write(java.io.OutputStream)">
 <!--   -->
 </a>
@@ -343,13 +399,15 @@ extends <a href="../../../../org/apache/
  stream is not closed as part of this operation.
  
  Note - if the Document was opened from a <code>File</code> rather
-  than an <code>InputStream</code>, you <b>must</b> write out to
-  a different file, overwriting via an OutputStream isn't possible.
+  than an <code>InputStream</code>, you <b>must</b> write out using
+  <a href="../../../../org/apache/poi/POIDocument.html#write()"><code>POIDocument.write()</code></a> or to a different File. Overwriting the currently
+  open file via an OutputStream isn't possible.
   
  If <code>stream</code> is a <code>FileOutputStream</code> on a networked drive
  or has a high cost/latency associated with each written byte,
  consider wrapping the OutputStream in a <code>BufferedOutputStream</code>
- to improve write performance.</div>
+ to improve write performance, or use <a href="../../../../org/apache/poi/POIDocument.html#write()"><code>POIDocument.write()</code></a> / <a href="../../../../org/apache/poi/POIDocument.html#write(java.io.File)"><code>POIDocument.write(File)</code></a>
+ if possible.</div>
 <dl>
 <dt><strong>Specified by:</strong></dt>
 <dd><code><a href="../../../../org/apache/poi/POIDocument.html#write(java.io.OutputStream)">write</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></code></dd>

Modified: poi/site/publish/apidocs/org/apache/poi/package-frame.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/package-frame.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/package-frame.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/package-frame.html Thu Jul 21 10:22:51 2016
@@ -12,6 +12,7 @@
 <ul title="Classes">
 <li><a href="POIDocument.html" title="class in org.apache.poi" target="classFrame">POIDocument</a></li>
 <li><a href="POIOLE2TextExtractor.html" title="class in org.apache.poi" target="classFrame">POIOLE2TextExtractor</a></li>
+<li><a href="POIReadOnlyDocument.html" title="class in org.apache.poi" target="classFrame">POIReadOnlyDocument</a></li>
 <li><a href="POITextExtractor.html" title="class in org.apache.poi" target="classFrame">POITextExtractor</a></li>
 <li><a href="POIXMLDocument.html" title="class in org.apache.poi" target="classFrame">POIXMLDocument</a></li>
 <li><a href="POIXMLDocumentPart.html" title="class in org.apache.poi" target="classFrame">POIXMLDocumentPart</a></li>

Modified: poi/site/publish/apidocs/org/apache/poi/package-summary.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/package-summary.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/package-summary.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/package-summary.html Thu Jul 21 10:22:51 2016
@@ -91,38 +91,45 @@
 </td>
 </tr>
 <tr class="altColor">
+<td class="colFirst"><a href="../../../org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi">POIReadOnlyDocument</a></td>
+<td class="colLast">
+<div class="block">This holds the common functionality for all read-only
+  POI Document classes, i.e.</div>
+</td>
+</tr>
+<tr class="rowColor">
 <td class="colFirst"><a href="../../../org/apache/poi/POITextExtractor.html" title="class in org.apache.poi">POITextExtractor</a></td>
 <td class="colLast">
 <div class="block">Common Parent for Text Extractors
   of POI Documents.</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><a href="../../../org/apache/poi/POIXMLDocument.html" title="class in org.apache.poi">POIXMLDocument</a></td>
 <td class="colLast">
 <div class="block">This holds the common functionality for all POI OOXML Document classes.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><a href="../../../org/apache/poi/POIXMLDocumentPart.html" title="class in org.apache.poi">POIXMLDocumentPart</a></td>
 <td class="colLast">
 <div class="block">Represents an entry of a OOXML package.</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><a href="../../../org/apache/poi/POIXMLDocumentPart.RelationPart.html" title="class in org.apache.poi">POIXMLDocumentPart.RelationPart</a></td>
 <td class="colLast">
 <div class="block">The RelationPart is a cached relationship between the document, which contains the RelationPart,
  and one of its referenced child document parts.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><a href="../../../org/apache/poi/POIXMLFactory.html" title="class in org.apache.poi">POIXMLFactory</a></td>
 <td class="colLast">
 <div class="block">Defines a factory API that enables sub-classes to create instances of <code>POIXMLDocumentPart</code></div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><a href="../../../org/apache/poi/POIXMLProperties.html" title="class in org.apache.poi">POIXMLProperties</a></td>
 <td class="colLast">
 <div class="block">Wrapper around the three different kinds of OOXML properties
@@ -130,25 +137,25 @@
   as well Thumbnails.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><a href="../../../org/apache/poi/POIXMLProperties.CoreProperties.html" title="class in org.apache.poi">POIXMLProperties.CoreProperties</a></td>
 <td class="colLast">
 <div class="block">The core document properties</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><a href="../../../org/apache/poi/POIXMLProperties.CustomProperties.html" title="class in org.apache.poi">POIXMLProperties.CustomProperties</a></td>
 <td class="colLast">
 <div class="block">Custom document properties</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><a href="../../../org/apache/poi/POIXMLProperties.ExtendedProperties.html" title="class in org.apache.poi">POIXMLProperties.ExtendedProperties</a></td>
 <td class="colLast">
 <div class="block">Extended document properties</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><a href="../../../org/apache/poi/POIXMLPropertiesTextExtractor.html" title="class in org.apache.poi">POIXMLPropertiesTextExtractor</a></td>
 <td class="colLast">
 <div class="block">A <a href="../../../org/apache/poi/POITextExtractor.html" title="class in org.apache.poi"><code>POITextExtractor</code></a> for returning the textual
@@ -156,17 +163,17 @@
   and title.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><a href="../../../org/apache/poi/POIXMLRelation.html" title="class in org.apache.poi">POIXMLRelation</a></td>
 <td class="colLast">
 <div class="block">Represents a descriptor of a OOXML relation.</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><a href="../../../org/apache/poi/POIXMLTextExtractor.html" title="class in org.apache.poi">POIXMLTextExtractor</a></td>
 <td class="colLast">&nbsp;</td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><a href="../../../org/apache/poi/POIXMLTypeLoader.html" title="class in org.apache.poi">POIXMLTypeLoader</a></td>
 <td class="colLast">&nbsp;</td>
 </tr>

Modified: poi/site/publish/apidocs/org/apache/poi/package-tree.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/package-tree.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/package-tree.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/package-tree.html Thu Jul 21 10:22:51 2016
@@ -72,7 +72,11 @@
 <ul>
 <li type="circle">java.lang.Object
 <ul>
-<li type="circle">org.apache.poi.<a href="../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi"><span class="strong">POIDocument</span></a> (implements java.io.Closeable)</li>
+<li type="circle">org.apache.poi.<a href="../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi"><span class="strong">POIDocument</span></a> (implements java.io.Closeable)
+<ul>
+<li type="circle">org.apache.poi.<a href="../../../org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi"><span class="strong">POIReadOnlyDocument</span></a></li>
+</ul>
+</li>
 <li type="circle">org.apache.poi.<a href="../../../org/apache/poi/POITextExtractor.html" title="class in org.apache.poi"><span class="strong">POITextExtractor</span></a> (implements java.io.Closeable)
 <ul>
 <li type="circle">org.apache.poi.<a href="../../../org/apache/poi/POIOLE2TextExtractor.html" title="class in org.apache.poi"><span class="strong">POIOLE2TextExtractor</span></a></li>

Modified: poi/site/publish/apidocs/org/apache/poi/package-use.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/package-use.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/package-use.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/package-use.html Thu Jul 21 10:22:51 2016
@@ -368,6 +368,12 @@
   Document classes.</div>
 </td>
 </tr>
+<tr class="rowColor">
+<td class="colOne"><a href="../../../org/apache/poi/class-use/POIReadOnlyDocument.html#org.apache.poi.hdgf">POIReadOnlyDocument</a>
+<div class="block">This holds the common functionality for all read-only
+  POI Document classes, i.e.</div>
+</td>
+</tr>
 </tbody>
 </table>
 </li>
@@ -413,6 +419,12 @@
   Document classes.</div>
 </td>
 </tr>
+<tr class="rowColor">
+<td class="colOne"><a href="../../../org/apache/poi/class-use/POIReadOnlyDocument.html#org.apache.poi.hpbf">POIReadOnlyDocument</a>
+<div class="block">This holds the common functionality for all read-only
+  POI Document classes, i.e.</div>
+</td>
+</tr>
 </tbody>
 </table>
 </li>
@@ -581,6 +593,12 @@
   Document classes.</div>
 </td>
 </tr>
+<tr class="rowColor">
+<td class="colOne"><a href="../../../org/apache/poi/class-use/POIReadOnlyDocument.html#org.apache.poi.hsmf">POIReadOnlyDocument</a>
+<div class="block">This holds the common functionality for all read-only
+  POI Document classes, i.e.</div>
+</td>
+</tr>
 </tbody>
 </table>
 </li>

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=1753654&r1=1753653&r2=1753654&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 Thu Jul 21 10:22:51 2016
@@ -157,6 +157,12 @@ implements <a href="../../../../../org/a
 </td>
 </tr>
 <tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html#POIFSFileSystem(java.io.File,%20boolean)">POIFSFileSystem</a></strong>(java.io.File&nbsp;file,
+               boolean&nbsp;readOnly)</code>
+<div class="block">Creates a POIFSFileSystem from a <tt>File</tt>.</div>
+</td>
+</tr>
+<tr class="rowColor">
 <td class="colOne"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html#POIFSFileSystem(java.io.InputStream)">POIFSFileSystem</a></strong>(java.io.InputStream&nbsp;stream)</code>
 <div class="block">Create a POIFSFileSystem from an <tt>InputStream</tt>.</div>
 </td>
@@ -177,19 +183,25 @@ implements <a href="../../../../../org/a
 <th class="colLast" scope="col">Method and Description</th>
 </tr>
 <tr class="altColor">
+<td class="colFirst"><code>static <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">POIFSFileSystem</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html#create(java.io.File)">create</a></strong>(java.io.File&nbsp;file)</code>
+<div class="block">Creates a new <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a> in a new <code>File</code>.</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/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">
+<tr class="altColor">
 <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
   has a POIFS (OLE2) header.</div>
 </td>
 </tr>
-<tr class="altColor">
+<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(java.io.InputStream)">hasPOIFSHeader</a></strong>(java.io.InputStream&nbsp;inp)</code>
 <div class="block">Checks that the supplied InputStream (which MUST
@@ -197,7 +209,7 @@ implements <a href="../../../../../org/a
   has a POIFS (OLE2) header at the start of it.</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>static void</code></td>
 <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.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>
@@ -284,6 +296,26 @@ implements <a href="../../../../../org/a
 <dd><code>java.io.IOException</code> - on errors reading, or on invalid data</dd></dl>
 </li>
 </ul>
+<a name="POIFSFileSystem(java.io.File, boolean)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>POIFSFileSystem</h4>
+<pre>public&nbsp;POIFSFileSystem(java.io.File&nbsp;file,
+               boolean&nbsp;readOnly)
+                throws java.io.IOException</pre>
+<div class="block"><p>Creates a POIFSFileSystem from a <tt>File</tt>. This uses less memory than
+  creating from an <tt>InputStream</tt>.</p>
+  
+ <p>Note that with this constructor, you will need to call <a href="../../../../../org/apache/poi/poifs/filesystem/NPOIFSFileSystem.html#close()"><code>NPOIFSFileSystem.close()</code></a>
+  when you're done to have the underlying file closed, as the file is
+  kept open during normal operation to read the data out.</p></div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>readOnly</code> - whether the POIFileSystem will only be used in read-only mode</dd><dd><code>file</code> - the File 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>
 <a name="POIFSFileSystem(java.io.File)">
 <!--   -->
 </a>
@@ -351,6 +383,23 @@ implements <a href="../../../../../org/a
   has a POIFS (OLE2) header.</div>
 </li>
 </ul>
+<a name="create(java.io.File)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>create</h4>
+<pre>public static&nbsp;<a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">POIFSFileSystem</a>&nbsp;create(java.io.File&nbsp;file)
+                              throws java.io.IOException</pre>
+<div class="block">Creates a new <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a> in a new <code>File</code>.
+ Use <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html#POIFSFileSystem(java.io.File)"><code>POIFSFileSystem(File)</code></a> to open an existing File,
+  this should only be used to create a new empty filesystem.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - The file to create and open</dd>
+<dt><span class="strong">Returns:</span></dt><dd>The created and opened <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a></dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code></dd></dl>
+</li>
+</ul>
 <a name="main(java.lang.String[])">
 <!--   -->
 </a>

Modified: poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/DirectoryNode.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/DirectoryNode.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/DirectoryNode.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/DirectoryNode.html Thu Jul 21 10:22:51 2016
@@ -247,6 +247,9 @@
 <div class="block">Constructs a POIDocument with the given directory node.</div>
 </td>
 </tr>
+<tr class="rowColor">
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/POIReadOnlyDocument.html#POIReadOnlyDocument(org.apache.poi.poifs.filesystem.DirectoryNode)">POIReadOnlyDocument</a></strong>(<a href="../../../../../../org/apache/poi/poifs/filesystem/DirectoryNode.html" title="class in org.apache.poi.poifs.filesystem">DirectoryNode</a>&nbsp;dir)</code>&nbsp;</td>
+</tr>
 </tbody>
 </table>
 </li>

Modified: poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/NPOIFSFileSystem.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/NPOIFSFileSystem.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/NPOIFSFileSystem.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/NPOIFSFileSystem.html Thu Jul 21 10:22:51 2016
@@ -245,6 +245,9 @@
 <div class="block">Constructs from an old-style OPOIFS</div>
 </td>
 </tr>
+<tr class="rowColor">
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/POIReadOnlyDocument.html#POIReadOnlyDocument(org.apache.poi.poifs.filesystem.NPOIFSFileSystem)">POIReadOnlyDocument</a></strong>(<a href="../../../../../../org/apache/poi/poifs/filesystem/NPOIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">NPOIFSFileSystem</a>&nbsp;fs)</code>&nbsp;</td>
+</tr>
 </tbody>
 </table>
 </li>

Modified: poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/OPOIFSFileSystem.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/OPOIFSFileSystem.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/OPOIFSFileSystem.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/OPOIFSFileSystem.html Thu Jul 21 10:22:51 2016
@@ -119,6 +119,9 @@
 <div class="block">Constructs from an old-style OPOIFS</div>
 </td>
 </tr>
+<tr class="rowColor">
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/POIReadOnlyDocument.html#POIReadOnlyDocument(org.apache.poi.poifs.filesystem.OPOIFSFileSystem)">POIReadOnlyDocument</a></strong>(<a href="../../../../../../org/apache/poi/poifs/filesystem/OPOIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">OPOIFSFileSystem</a>&nbsp;fs)</code>&nbsp;</td>
+</tr>
 </tbody>
 </table>
 </li>

Modified: poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/POIFSFileSystem.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/POIFSFileSystem.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/POIFSFileSystem.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/POIFSFileSystem.html Thu Jul 21 10:22:51 2016
@@ -187,6 +187,9 @@
 <div class="block">Constructs from the default POIFS</div>
 </td>
 </tr>
+<tr class="rowColor">
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/POIReadOnlyDocument.html#POIReadOnlyDocument(org.apache.poi.poifs.filesystem.POIFSFileSystem)">POIReadOnlyDocument</a></strong>(<a href="../../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">POIFSFileSystem</a>&nbsp;fs)</code>&nbsp;</td>
+</tr>
 </tbody>
 </table>
 </li>
@@ -637,6 +640,21 @@
 </a>
 <h3>Uses of <a href="../../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">POIFSFileSystem</a> in <a href="../../../../../../org/apache/poi/poifs/filesystem/package-summary.html">org.apache.poi.poifs.filesystem</a></h3>
 <table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
+<caption><span>Methods in <a href="../../../../../../org/apache/poi/poifs/filesystem/package-summary.html">org.apache.poi.poifs.filesystem</a> that return <a href="../../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">POIFSFileSystem</a></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>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><code>static <a href="../../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">POIFSFileSystem</a></code></td>
+<td class="colLast"><span class="strong">POIFSFileSystem.</span><code><strong><a href="../../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html#create(java.io.File)">create</a></strong>(java.io.File&nbsp;file)</code>
+<div class="block">Creates a new <a href="../../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a> in a new <code>File</code>.</div>
+</td>
+</tr>
+</tbody>
+</table>
+<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
 <caption><span>Methods in <a href="../../../../../../org/apache/poi/poifs/filesystem/package-summary.html">org.apache.poi.poifs.filesystem</a> with parameters of type <a href="../../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">POIFSFileSystem</a></span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>

Modified: poi/site/publish/apidocs/overview-tree.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/overview-tree.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/overview-tree.html (original)
+++ poi/site/publish/apidocs/overview-tree.html Thu Jul 21 10:22:51 2016
@@ -1561,8 +1561,6 @@
 <li type="circle">org.apache.poi.util.<a href="org/apache/poi/util/PngUtils.html" title="class in org.apache.poi.util"><span class="strong">PngUtils</span></a></li>
 <li type="circle">org.apache.poi.<a href="org/apache/poi/POIDocument.html" title="class in org.apache.poi"><span class="strong">POIDocument</span></a> (implements java.io.Closeable)
 <ul>
-<li type="circle">org.apache.poi.hdgf.<a href="org/apache/poi/hdgf/HDGFDiagram.html" title="class in org.apache.poi.hdgf"><span class="strong">HDGFDiagram</span></a></li>
-<li type="circle">org.apache.poi.hpbf.<a href="org/apache/poi/hpbf/HPBFDocument.html" title="class in org.apache.poi.hpbf"><span class="strong">HPBFDocument</span></a></li>
 <li type="circle">org.apache.poi.hpsf.<a href="org/apache/poi/hpsf/HPSFPropertiesOnlyDocument.html" title="class in org.apache.poi.hpsf"><span class="strong">HPSFPropertiesOnlyDocument</span></a></li>
 <li type="circle">org.apache.poi.hslf.usermodel.<a href="org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.html" title="class in org.apache.poi.hslf.usermodel"><span class="strong">HSLFSlideShowImpl</span></a> (implements java.io.Closeable)</li>
 <li type="circle">org.apache.poi.hssf.usermodel.<a href="org/apache/poi/hssf/usermodel/HSSFWorkbook.html" title="class in org.apache.poi.hssf.usermodel"><span class="strong">HSSFWorkbook</span></a> (implements org.apache.poi.ss.usermodel.<a href="org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a>)</li>
@@ -1572,9 +1570,15 @@
 <li type="circle">org.apache.poi.hwpf.<a href="org/apache/poi/hwpf/HWPFOldDocument.html" title="class in org.apache.poi.hwpf"><span class="strong">HWPFOldDocument</span></a></li>
 </ul>
 </li>
+<li type="circle">org.apache.poi.<a href="org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi"><span class="strong">POIReadOnlyDocument</span></a>
+<ul>
+<li type="circle">org.apache.poi.hdgf.<a href="org/apache/poi/hdgf/HDGFDiagram.html" title="class in org.apache.poi.hdgf"><span class="strong">HDGFDiagram</span></a></li>
+<li type="circle">org.apache.poi.hpbf.<a href="org/apache/poi/hpbf/HPBFDocument.html" title="class in org.apache.poi.hpbf"><span class="strong">HPBFDocument</span></a></li>
 <li type="circle">org.apache.poi.hsmf.<a href="org/apache/poi/hsmf/MAPIMessage.html" title="class in org.apache.poi.hsmf"><span class="strong">MAPIMessage</span></a></li>
 </ul>
 </li>
+</ul>
+</li>
 <li type="circle">org.apache.poi.poifs.common.<a href="org/apache/poi/poifs/common/POIFSBigBlockSize.html" title="class in org.apache.poi.poifs.common"><span class="strong">POIFSBigBlockSize</span></a></li>
 <li type="circle">org.apache.poi.hsmf.parsers.<a href="org/apache/poi/hsmf/parsers/POIFSChunkParser.html" title="class in org.apache.poi.hsmf.parsers"><span class="strong">POIFSChunkParser</span></a></li>
 <li type="circle">org.apache.poi.poifs.filesystem.<a href="org/apache/poi/poifs/filesystem/POIFSDocumentPath.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">POIFSDocumentPath</span></a></li>



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


Mime
View raw message