You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ni...@apache.org on 2016/07/21 10:22:52 UTC
svn commit: r1753654 [1/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...

Author: nick
Date: Thu Jul 21 10:22:51 2016
New Revision: 1753654

URL: http://svn.apache.org/viewvc?rev=1753654&view=rev
Log:
Republish javadocs

Modified:
    poi/site/publish/apidocs/allclasses-frame.html
    poi/site/publish/apidocs/allclasses-noframe.html
    poi/site/publish/apidocs/index-all.html
    poi/site/publish/apidocs/org/apache/poi/POIDocument.html
    poi/site/publish/apidocs/org/apache/poi/POIOLE2TextExtractor.html
    poi/site/publish/apidocs/org/apache/poi/POITextExtractor.html
    poi/site/publish/apidocs/org/apache/poi/class-use/POIDocument.html
    poi/site/publish/apidocs/org/apache/poi/hdgf/HDGFDiagram.html
    poi/site/publish/apidocs/org/apache/poi/hdgf/package-tree.html
    poi/site/publish/apidocs/org/apache/poi/hpbf/HPBFDocument.html
    poi/site/publish/apidocs/org/apache/poi/hpbf/package-tree.html
    poi/site/publish/apidocs/org/apache/poi/hpsf/HPSFPropertiesOnlyDocument.html
    poi/site/publish/apidocs/org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.html
    poi/site/publish/apidocs/org/apache/poi/hsmf/MAPIMessage.html
    poi/site/publish/apidocs/org/apache/poi/hsmf/package-tree.html
    poi/site/publish/apidocs/org/apache/poi/hssf/usermodel/HSSFWorkbook.html
    poi/site/publish/apidocs/org/apache/poi/hwpf/HWPFDocument.html
    poi/site/publish/apidocs/org/apache/poi/hwpf/HWPFDocumentCore.html
    poi/site/publish/apidocs/org/apache/poi/hwpf/HWPFOldDocument.html
    poi/site/publish/apidocs/org/apache/poi/package-frame.html
    poi/site/publish/apidocs/org/apache/poi/package-summary.html
    poi/site/publish/apidocs/org/apache/poi/package-tree.html
    poi/site/publish/apidocs/org/apache/poi/package-use.html
    poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/POIFSFileSystem.html
    poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/DirectoryNode.html
    poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/NPOIFSFileSystem.html
    poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/OPOIFSFileSystem.html
    poi/site/publish/apidocs/org/apache/poi/poifs/filesystem/class-use/POIFSFileSystem.html
    poi/site/publish/apidocs/overview-tree.html

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

Modified: poi/site/publish/apidocs/allclasses-noframe.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/allclasses-noframe.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/allclasses-noframe.html (original)
+++ poi/site/publish/apidocs/allclasses-noframe.html Thu Jul 21 10:22:51 2016
@@ -1495,6 +1495,7 @@
 <li><a href="org/apache/poi/hdgf/pointers/PointerFactory.html" title="class in org.apache.poi.hdgf.pointers">PointerFactory</a></li>
 <li><a href="org/apache/poi/hdgf/pointers/PointerV6.html" title="class in org.apache.poi.hdgf.pointers">PointerV6</a></li>
 <li><a href="org/apache/poi/POIOLE2TextExtractor.html" title="class in org.apache.poi">POIOLE2TextExtractor</a></li>
+<li><a href="org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi">POIReadOnlyDocument</a></li>
 <li><a href="org/apache/poi/POITextExtractor.html" title="class in org.apache.poi">POITextExtractor</a></li>
 <li><a href="org/apache/poi/POIXMLDocument.html" title="class in org.apache.poi">POIXMLDocument</a></li>
 <li><a href="org/apache/poi/POIXMLDocumentPart.html" title="class in org.apache.poi">POIXMLDocumentPart</a></li>

Modified: poi/site/publish/apidocs/index-all.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/index-all.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/index-all.html (original)
+++ poi/site/publish/apidocs/index-all.html Thu Jul 21 10:22:51 2016
@@ -7530,6 +7530,10 @@
 </dd>
 <dt><span class="strong"><a href="./org/apache/poi/openxml4j/opc/OPCPackage.html#create(java.io.OutputStream)">create(OutputStream)</a></span> - Static method in class org.apache.poi.openxml4j.opc.<a href="./org/apache/poi/openxml4j/opc/OPCPackage.html" title="class in org.apache.poi.openxml4j.opc">OPCPackage</a></dt>
 <dd>&nbsp;</dd>
+<dt><span class="strong"><a href="./org/apache/poi/poifs/filesystem/POIFSFileSystem.html#create(java.io.File)">create(File)</a></span> - Static method in class org.apache.poi.poifs.filesystem.<a href="./org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">POIFSFileSystem</a></dt>
+<dd>
+<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>
+</dd>
 <dt><span class="strong"><a href="./org/apache/poi/sl/draw/SLGraphics.html#create()">create()</a></span> - Method in class org.apache.poi.sl.draw.<a href="./org/apache/poi/sl/draw/SLGraphics.html" title="class in org.apache.poi.sl.draw">SLGraphics</a></dt>
 <dd>
 <div class="block">Creates a new <code>Graphics</code> object that is
@@ -57043,6 +57047,10 @@ Compound Document Format.</div>
 <dd>
 <div class="block">Create a POIFSFileSystem from an <tt>InputStream</tt>.</div>
 </dd>
+<dt><span class="strong"><a href="./org/apache/poi/poifs/filesystem/POIFSFileSystem.html#POIFSFileSystem(java.io.File,%20boolean)">POIFSFileSystem(File, boolean)</a></span> - Constructor for class org.apache.poi.poifs.filesystem.<a href="./org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">POIFSFileSystem</a></dt>
+<dd>
+<div class="block">Creates a POIFSFileSystem from a <tt>File</tt>.</div>
+</dd>
 <dt><span class="strong"><a href="./org/apache/poi/poifs/filesystem/POIFSFileSystem.html#POIFSFileSystem(java.io.File)">POIFSFileSystem(File)</a></span> - Constructor for class org.apache.poi.poifs.filesystem.<a href="./org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">POIFSFileSystem</a></dt>
 <dd>
 <div class="block">Creates a POIFSFileSystem from a <tt>File</tt>.</div>
@@ -57166,6 +57174,19 @@ Compound Document Format.</div>
 <div class="block">Creates a new text extractor, using the same
   document as another text extractor.</div>
 </dd>
+<dt><a href="./org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi"><span class="strong">POIReadOnlyDocument</span></a> - Class in <a href="./org/apache/poi/package-summary.html">org.apache.poi</a></dt>
+<dd>
+<div class="block">This holds the common functionality for all read-only
+  POI Document classes, i.e.</div>
+</dd>
+<dt><span class="strong"><a href="./org/apache/poi/POIReadOnlyDocument.html#POIReadOnlyDocument(org.apache.poi.poifs.filesystem.DirectoryNode)">POIReadOnlyDocument(DirectoryNode)</a></span> - Constructor for class org.apache.poi.<a href="./org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi">POIReadOnlyDocument</a></dt>
+<dd>&nbsp;</dd>
+<dt><span class="strong"><a href="./org/apache/poi/POIReadOnlyDocument.html#POIReadOnlyDocument(org.apache.poi.poifs.filesystem.NPOIFSFileSystem)">POIReadOnlyDocument(NPOIFSFileSystem)</a></span> - Constructor for class org.apache.poi.<a href="./org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi">POIReadOnlyDocument</a></dt>
+<dd>&nbsp;</dd>
+<dt><span class="strong"><a href="./org/apache/poi/POIReadOnlyDocument.html#POIReadOnlyDocument(org.apache.poi.poifs.filesystem.OPOIFSFileSystem)">POIReadOnlyDocument(OPOIFSFileSystem)</a></span> - Constructor for class org.apache.poi.<a href="./org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi">POIReadOnlyDocument</a></dt>
+<dd>&nbsp;</dd>
+<dt><span class="strong"><a href="./org/apache/poi/POIReadOnlyDocument.html#POIReadOnlyDocument(org.apache.poi.poifs.filesystem.POIFSFileSystem)">POIReadOnlyDocument(POIFSFileSystem)</a></span> - Constructor for class org.apache.poi.<a href="./org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi">POIReadOnlyDocument</a></dt>
+<dd>&nbsp;</dd>
 <dt><span class="strong"><a href="./org/apache/poi/ss/formula/functions/NumericFunction.html#POISSON">POISSON</a></span> - Static variable in class org.apache.poi.ss.formula.functions.<a href="./org/apache/poi/ss/formula/functions/NumericFunction.html" title="class in org.apache.poi.ss.formula.functions">NumericFunction</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="./org/apache/poi/POITextExtractor.html" title="class in org.apache.poi"><span class="strong">POITextExtractor</span></a> - Class in <a href="./org/apache/poi/package-summary.html">org.apache.poi</a></dt>
@@ -84462,6 +84483,12 @@ Compound Document Format.</div>
 <dd>
 <div class="block">Runs a bounds check for column numbers</div>
 </dd>
+<dt><span class="strong"><a href="./org/apache/poi/POIDocument.html#validateInPlaceWritePossible()">validateInPlaceWritePossible()</a></span> - Method in class org.apache.poi.<a href="./org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></dt>
+<dd>
+<div class="block">Called during a <a href="./org/apache/poi/POIDocument.html#write()"><code>POIDocument.write()</code></a> to ensure that the Document (and
+  associated <a href="./org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a>) was opened in a way compatible
+  with an in-place write.</div>
+</dd>
 <dt><span class="strong"><a href="./org/apache/poi/hssf/usermodel/HSSFSheet.html#validateMergedRegions()">validateMergedRegions()</a></span> - Method in class org.apache.poi.hssf.usermodel.<a href="./org/apache/poi/hssf/usermodel/HSSFSheet.html" title="class in org.apache.poi.hssf.usermodel">HSSFSheet</a></dt>
 <dd>
 <div class="block">Verify that merged regions do not intersect multi-cell array formulas and
@@ -86864,15 +86891,19 @@ the order they are declared.</div>
 <dd>
 <div class="block">Specifies a wrapping rule that is undefined and MUST be ignored.</div>
 </dd>
-<dt><span class="strong"><a href="./org/apache/poi/hdgf/HDGFDiagram.html#write(java.io.OutputStream)">write(OutputStream)</a></span> - Method in class org.apache.poi.hdgf.<a href="./org/apache/poi/hdgf/HDGFDiagram.html" title="class in org.apache.poi.hdgf">HDGFDiagram</a></dt>
-<dd>&nbsp;</dd>
-<dt><span class="strong"><a href="./org/apache/poi/hpbf/HPBFDocument.html#write(java.io.OutputStream)">write(OutputStream)</a></span> - Method in class org.apache.poi.hpbf.<a href="./org/apache/poi/hpbf/HPBFDocument.html" title="class in org.apache.poi.hpbf">HPBFDocument</a></dt>
-<dd>&nbsp;</dd>
 <dt><span class="strong"><a href="./org/apache/poi/hpsf/ClassID.html#write(byte[],%20int)">write(byte[], int)</a></span> - Method in class org.apache.poi.hpsf.<a href="./org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a></dt>
 <dd>
 <div class="block">Writes the class ID to a byte array in the
  little-endian format.</div>
 </dd>
+<dt><span class="strong"><a href="./org/apache/poi/hpsf/HPSFPropertiesOnlyDocument.html#write()">write()</a></span> - Method in class org.apache.poi.hpsf.<a href="./org/apache/poi/hpsf/HPSFPropertiesOnlyDocument.html" title="class in org.apache.poi.hpsf">HPSFPropertiesOnlyDocument</a></dt>
+<dd>
+<div class="block">Write out to the currently open file the properties changes, but nothing else</div>
+</dd>
+<dt><span class="strong"><a href="./org/apache/poi/hpsf/HPSFPropertiesOnlyDocument.html#write(java.io.File)">write(File)</a></span> - Method in class org.apache.poi.hpsf.<a href="./org/apache/poi/hpsf/HPSFPropertiesOnlyDocument.html" title="class in org.apache.poi.hpsf">HPSFPropertiesOnlyDocument</a></dt>
+<dd>
+<div class="block">Write out, with any properties changes, but nothing else</div>
+</dd>
 <dt><span class="strong"><a href="./org/apache/poi/hpsf/HPSFPropertiesOnlyDocument.html#write(java.io.OutputStream)">write(OutputStream)</a></span> - Method in class org.apache.poi.hpsf.<a href="./org/apache/poi/hpsf/HPSFPropertiesOnlyDocument.html" title="class in org.apache.poi.hpsf">HPSFPropertiesOnlyDocument</a></dt>
 <dd>
 <div class="block">Write out, with any properties changes, but nothing else</div>
@@ -86911,6 +86942,18 @@ the order they are declared.</div>
 </dd>
 <dt><span class="strong"><a href="./org/apache/poi/hslf/usermodel/HSLFSlideShow.html#write(java.io.OutputStream)">write(OutputStream)</a></span> - Method in class org.apache.poi.hslf.usermodel.<a href="./org/apache/poi/hslf/usermodel/HSLFSlideShow.html" title="class in org.apache.poi.hslf.usermodel">HSLFSlideShow</a></dt>
 <dd>&nbsp;</dd>
+<dt><span class="strong"><a href="./org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.html#write()">write()</a></span> - Method in class org.apache.poi.hslf.usermodel.<a href="./org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.html" title="class in org.apache.poi.hslf.usermodel">HSLFSlideShowImpl</a></dt>
+<dd>&nbsp;</dd>
+<dt><span class="strong"><a href="./org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.html#write(java.io.File)">write(File)</a></span> - Method in class org.apache.poi.hslf.usermodel.<a href="./org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.html" title="class in org.apache.poi.hslf.usermodel">HSLFSlideShowImpl</a></dt>
+<dd>
+<div class="block">Writes out the slideshow file the is represented by an instance
+  of this class.</div>
+</dd>
+<dt><span class="strong"><a href="./org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.html#write(java.io.File,%20boolean)">write(File, boolean)</a></span> - Method in class org.apache.poi.hslf.usermodel.<a href="./org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.html" title="class in org.apache.poi.hslf.usermodel">HSLFSlideShowImpl</a></dt>
+<dd>
+<div class="block">Writes out the slideshow file the is represented by an instance
+  of this class.</div>
+</dd>
 <dt><span class="strong"><a href="./org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.html#write(java.io.OutputStream)">write(OutputStream)</a></span> - Method in class org.apache.poi.hslf.usermodel.<a href="./org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.html" title="class in org.apache.poi.hslf.usermodel">HSLFSlideShowImpl</a></dt>
 <dd>
 <div class="block">Writes out the slideshow file the is represented by an instance
@@ -86927,10 +86970,6 @@ the order they are declared.</div>
 </dd>
 <dt><span class="strong"><a href="./org/apache/poi/hslf/util/MutableByteArrayOutputStream.html#write(int)">write(int)</a></span> - Method in class org.apache.poi.hslf.util.<a href="./org/apache/poi/hslf/util/MutableByteArrayOutputStream.html" title="class in org.apache.poi.hslf.util">MutableByteArrayOutputStream</a></dt>
 <dd>&nbsp;</dd>
-<dt><span class="strong"><a href="./org/apache/poi/hsmf/MAPIMessage.html#write(java.io.OutputStream)">write(OutputStream)</a></span> - Method in class org.apache.poi.hsmf.<a href="./org/apache/poi/hsmf/MAPIMessage.html" title="class in org.apache.poi.hsmf">MAPIMessage</a></dt>
-<dd>
-<div class="block">Note - not yet supported, sorry.</div>
-</dd>
 <dt><span class="strong"><a href="./org/apache/poi/hssf/record/cont/ContinuableRecordOutput.html#write(byte[])">write(byte[])</a></span> - Method in class org.apache.poi.hssf.record.cont.<a href="./org/apache/poi/hssf/record/cont/ContinuableRecordOutput.html" title="class in org.apache.poi.hssf.record.cont">ContinuableRecordOutput</a></dt>
 <dd>&nbsp;</dd>
 <dt><span class="strong"><a href="./org/apache/poi/hssf/record/cont/ContinuableRecordOutput.html#write(byte[],%20int,%20int)">write(byte[], int, int)</a></span> - Method in class org.apache.poi.hssf.record.cont.<a href="./org/apache/poi/hssf/record/cont/ContinuableRecordOutput.html" title="class in org.apache.poi.hssf.record.cont">ContinuableRecordOutput</a></dt>
@@ -86940,14 +86979,26 @@ the order they are declared.</div>
 <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.</div>
 </dd>
+<dt><span class="strong"><a href="./org/apache/poi/hssf/usermodel/HSSFWorkbook.html#write(java.io.File)">write(File)</a></span> - Method in class org.apache.poi.hssf.usermodel.<a href="./org/apache/poi/hssf/usermodel/HSSFWorkbook.html" title="class in org.apache.poi.hssf.usermodel">HSSFWorkbook</a></dt>
+<dd>
+<div class="block">Method write - write out this workbook to a new <code>File</code>.</div>
+</dd>
 <dt><span class="strong"><a href="./org/apache/poi/hssf/usermodel/HSSFWorkbook.html#write(java.io.OutputStream)">write(OutputStream)</a></span> - Method in class org.apache.poi.hssf.usermodel.<a href="./org/apache/poi/hssf/usermodel/HSSFWorkbook.html" title="class in org.apache.poi.hssf.usermodel">HSSFWorkbook</a></dt>
 <dd>
 <div class="block">Method write - write out this workbook to an <code>OutputStream</code>.</div>
 </dd>
+<dt><span class="strong"><a href="./org/apache/poi/hwpf/HWPFDocument.html#write()">write()</a></span> - Method in class org.apache.poi.hwpf.<a href="./org/apache/poi/hwpf/HWPFDocument.html" title="class in org.apache.poi.hwpf">HWPFDocument</a></dt>
+<dd>&nbsp;</dd>
+<dt><span class="strong"><a href="./org/apache/poi/hwpf/HWPFDocument.html#write(java.io.File)">write(File)</a></span> - Method in class org.apache.poi.hwpf.<a href="./org/apache/poi/hwpf/HWPFDocument.html" title="class in org.apache.poi.hwpf">HWPFDocument</a></dt>
+<dd>&nbsp;</dd>
 <dt><span class="strong"><a href="./org/apache/poi/hwpf/HWPFDocument.html#write(java.io.OutputStream)">write(OutputStream)</a></span> - Method in class org.apache.poi.hwpf.<a href="./org/apache/poi/hwpf/HWPFDocument.html" title="class in org.apache.poi.hwpf">HWPFDocument</a></dt>
 <dd>
 <div class="block">Writes out the word file that is represented by an instance of this class.</div>
 </dd>
+<dt><span class="strong"><a href="./org/apache/poi/hwpf/HWPFOldDocument.html#write()">write()</a></span> - Method in class org.apache.poi.hwpf.<a href="./org/apache/poi/hwpf/HWPFOldDocument.html" title="class in org.apache.poi.hwpf">HWPFOldDocument</a></dt>
+<dd>&nbsp;</dd>
+<dt><span class="strong"><a href="./org/apache/poi/hwpf/HWPFOldDocument.html#write(java.io.File)">write(File)</a></span> - Method in class org.apache.poi.hwpf.<a href="./org/apache/poi/hwpf/HWPFOldDocument.html" title="class in org.apache.poi.hwpf">HWPFOldDocument</a></dt>
+<dd>&nbsp;</dd>
 <dt><span class="strong"><a href="./org/apache/poi/hwpf/HWPFOldDocument.html#write(java.io.OutputStream)">write(OutputStream)</a></span> - Method in class org.apache.poi.hwpf.<a href="./org/apache/poi/hwpf/HWPFOldDocument.html" title="class in org.apache.poi.hwpf">HWPFOldDocument</a></dt>
 <dd>&nbsp;</dd>
 <dt><span class="strong"><a href="./org/apache/poi/hwpf/model/FieldsTables.html#write(org.apache.poi.hwpf.model.FileInformationBlock,%20org.apache.poi.hwpf.model.io.HWPFOutputStream)">write(FileInformationBlock, HWPFOutputStream)</a></span> - Method in class org.apache.poi.hwpf.model.<a href="./org/apache/poi/hwpf/model/FieldsTables.html" title="class in org.apache.poi.hwpf.model">FieldsTables</a></dt>
@@ -86964,6 +87015,15 @@ the order they are declared.</div>
 <dd>&nbsp;</dd>
 <dt><span class="strong"><a href="./org/apache/poi/openxml4j/opc/internal/MemoryPackagePartOutputStream.html#write(byte[])">write(byte[])</a></span> - Method in class org.apache.poi.openxml4j.opc.internal.<a href="./org/apache/poi/openxml4j/opc/internal/MemoryPackagePartOutputStream.html" title="class in org.apache.poi.openxml4j.opc.internal">MemoryPackagePartOutputStream</a></dt>
 <dd>&nbsp;</dd>
+<dt><span class="strong"><a href="./org/apache/poi/POIDocument.html#write()">write()</a></span> - Method in class org.apache.poi.<a href="./org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></dt>
+<dd>
+<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>
+</dd>
+<dt><span class="strong"><a href="./org/apache/poi/POIDocument.html#write(java.io.File)">write(File)</a></span> - Method in class org.apache.poi.<a href="./org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></dt>
+<dd>
+<div class="block">Writes the document out to the specified new <code>File</code>.</div>
+</dd>
 <dt><span class="strong"><a href="./org/apache/poi/POIDocument.html#write(java.io.OutputStream)">write(OutputStream)</a></span> - Method in class org.apache.poi.<a href="./org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></dt>
 <dd>
 <div class="block">Writes the document out to the specified output stream.</div>
@@ -87036,6 +87096,18 @@ the order they are declared.</div>
 <dd>
 <div class="block">Writes the properties out into the given low-level stream</div>
 </dd>
+<dt><span class="strong"><a href="./org/apache/poi/POIReadOnlyDocument.html#write()">write()</a></span> - Method in class org.apache.poi.<a href="./org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi">POIReadOnlyDocument</a></dt>
+<dd>
+<div class="block">Note - writing is not yet supported for this file format, sorry.</div>
+</dd>
+<dt><span class="strong"><a href="./org/apache/poi/POIReadOnlyDocument.html#write(java.io.File)">write(File)</a></span> - Method in class org.apache.poi.<a href="./org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi">POIReadOnlyDocument</a></dt>
+<dd>
+<div class="block">Note - writing is not yet supported for this file format, sorry.</div>
+</dd>
+<dt><span class="strong"><a href="./org/apache/poi/POIReadOnlyDocument.html#write(java.io.OutputStream)">write(OutputStream)</a></span> - Method in class org.apache.poi.<a href="./org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi">POIReadOnlyDocument</a></dt>
+<dd>
+<div class="block">Note - writing is not yet supported for this file format, sorry.</div>
+</dd>
 <dt><span class="strong"><a href="./org/apache/poi/POIXMLDocument.html#write(java.io.OutputStream)">write(OutputStream)</a></span> - Method in class org.apache.poi.<a href="./org/apache/poi/POIXMLDocument.html" title="class in org.apache.poi">POIXMLDocument</a></dt>
 <dd>
 <div class="block">Write out this document to an Outputstream.</div>

Modified: poi/site/publish/apidocs/org/apache/poi/POIDocument.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/POIDocument.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/POIDocument.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/POIDocument.html Thu Jul 21 10:22:51 2016
@@ -98,7 +98,7 @@
 </dl>
 <dl>
 <dt>Direct Known Subclasses:</dt>
-<dd><a href="../../../org/apache/poi/hdgf/HDGFDiagram.html" title="class in org.apache.poi.hdgf">HDGFDiagram</a>, <a href="../../../org/apache/poi/hpbf/HPBFDocument.html" title="class in org.apache.poi.hpbf">HPBFDocument</a>, <a href="../../../org/apache/poi/hpsf/HPSFPropertiesOnlyDocument.html" title="class in org.apache.poi.hpsf">HPSFPropertiesOnlyDocument</a>, <a href="../../../org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.html" title="class in org.apache.poi.hslf.usermodel">HSLFSlideShowImpl</a>, <a href="../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html" title="class in org.apache.poi.hssf.usermodel">HSSFWorkbook</a>, <a href="../../../org/apache/poi/hwpf/HWPFDocumentCore.html" title="class in org.apache.poi.hwpf">HWPFDocumentCore</a>, <a href="../../../org/apache/poi/hsmf/MAPIMessage.html" title="class in org.apache.poi.hsmf">MAPIMessage</a></dd>
+<dd><a href="../../../org/apache/poi/hpsf/HPSFPropertiesOnlyDocument.html" title="class in org.apache.poi.hpsf">HPSFPropertiesOnlyDocument</a>, <a href="../../../org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.html" title="class in org.apache.poi.hslf.usermodel">HSLFSlideShowImpl</a>, <a href="../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html" title="class in org.apache.poi.hssf.usermodel">HSSFWorkbook</a>, <a href="../../../org/apache/poi/hwpf/HWPFDocumentCore.html" title="class in org.apache.poi.hwpf">HWPFDocumentCore</a>, <a href="../../../org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi">POIReadOnlyDocument</a></dd>
 </dl>
 <hr>
 <br>
@@ -240,12 +240,33 @@ implements java.io.Closeable</pre>
 </td>
 </tr>
 <tr class="altColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><strong><a href="../../../org/apache/poi/POIDocument.html#validateInPlaceWritePossible()">validateInPlaceWritePossible</a></strong>()</code>
+<div class="block">Called during a <a href="../../../org/apache/poi/POIDocument.html#write()"><code>write()</code></a> to ensure that the Document (and
+  associated <a href="../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a>) was opened in a way compatible
+  with an in-place write.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>abstract void</code></td>
+<td class="colLast"><code><strong><a href="../../../org/apache/poi/POIDocument.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="altColor">
+<td class="colFirst"><code>abstract void</code></td>
+<td class="colLast"><code><strong><a href="../../../org/apache/poi/POIDocument.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="rowColor">
 <td class="colFirst"><code>abstract void</code></td>
 <td class="colLast"><code><strong><a href="../../../org/apache/poi/POIDocument.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>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>protected void</code></td>
 <td class="colLast"><code><strong><a href="../../../org/apache/poi/POIDocument.html#writeProperties()">writeProperties</a></strong>()</code>
 <div class="block">Writes out the updated standard Document Information Properties (HPSF)
@@ -253,20 +274,20 @@ implements java.io.Closeable</pre>
  TODO Implement in-place update</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>protected void</code></td>
 <td class="colLast"><code><strong><a href="../../../org/apache/poi/POIDocument.html#writeProperties(org.apache.poi.poifs.filesystem.NPOIFSFileSystem)">writeProperties</a></strong>(<a href="../../../org/apache/poi/poifs/filesystem/NPOIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">NPOIFSFileSystem</a>&nbsp;outFS)</code>
 <div class="block">Writes out the standard Document Information Properties (HPSF)</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>protected void</code></td>
 <td class="colLast"><code><strong><a href="../../../org/apache/poi/POIDocument.html#writeProperties(org.apache.poi.poifs.filesystem.NPOIFSFileSystem,%20java.util.List)">writeProperties</a></strong>(<a href="../../../org/apache/poi/poifs/filesystem/NPOIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">NPOIFSFileSystem</a>&nbsp;outFS,
                java.util.List&lt;java.lang.String&gt;&nbsp;writtenEntries)</code>
 <div class="block">Writes out the standard Document Information Properties (HPSF)</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>protected void</code></td>
 <td class="colLast"><code><strong><a href="../../../org/apache/poi/POIDocument.html#writePropertySet(java.lang.String,%20org.apache.poi.hpsf.PropertySet,%20org.apache.poi.poifs.filesystem.NPOIFSFileSystem)">writePropertySet</a></strong>(java.lang.String&nbsp;name,
                 <a href="../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf">PropertySet</a>&nbsp;set,
@@ -511,6 +532,56 @@ implements java.io.Closeable</pre>
       <a href="../../../org/apache/poi/poifs/filesystem/NPOIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>NPOIFSFileSystem</code></a> occurs</dd></dl>
 </li>
 </ul>
+<a name="validateInPlaceWritePossible()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>validateInPlaceWritePossible</h4>
+<pre>protected&nbsp;void&nbsp;validateInPlaceWritePossible()
+                                     throws java.lang.IllegalStateException</pre>
+<div class="block">Called during a <a href="../../../org/apache/poi/POIDocument.html#write()"><code>write()</code></a> to ensure that the Document (and
+  associated <a href="../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a>) was opened in a way compatible
+  with an in-place write.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if the document was opened suitably</dd></dl>
+</li>
+</ul>
+<a name="write()">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>write</h4>
+<pre>public abstract&nbsp;void&nbsp;write()
+                    throws java.io.IOException</pre>
+<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>write(OutputStream)</code></a> or <a href="../../../org/apache/poi/POIDocument.html#write(java.io.File)"><code>write(File)</code></a> to 
+   write to a brand new document.</div>
+<dl><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 abstract&nbsp;void&nbsp;write(java.io.File&nbsp;newFile)
+                    throws java.io.IOException</pre>
+<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><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>
@@ -523,13 +594,15 @@ implements java.io.Closeable</pre>
  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>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>write()</code></a> / <a href="../../../org/apache/poi/POIDocument.html#write(java.io.File)"><code>write(File)</code></a>
+ if possible.</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - The stream to write to.</dd>
 <dt><span class="strong">Throws:</span></dt>
 <dd><code>java.io.IOException</code> - thrown on errors writing to the stream</dd></dl>

Modified: poi/site/publish/apidocs/org/apache/poi/POIOLE2TextExtractor.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/POIOLE2TextExtractor.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/POIOLE2TextExtractor.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/POIOLE2TextExtractor.html Thu Jul 21 10:22:51 2016
@@ -35,7 +35,7 @@
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi"><span class="strong">Prev Class</span></a></li>
-<li><a href="../../../org/apache/poi/POITextExtractor.html" title="class in org.apache.poi"><span class="strong">Next Class</span></a></li>
+<li><a href="../../../org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi"><span class="strong">Next Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../index.html?org/apache/poi/POIOLE2TextExtractor.html" target="_top">Frames</a></li>
@@ -366,7 +366,7 @@ extends <a href="../../../org/apache/poi
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi"><span class="strong">Prev Class</span></a></li>
-<li><a href="../../../org/apache/poi/POITextExtractor.html" title="class in org.apache.poi"><span class="strong">Next Class</span></a></li>
+<li><a href="../../../org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi"><span class="strong">Next Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../index.html?org/apache/poi/POIOLE2TextExtractor.html" target="_top">Frames</a></li>

Modified: poi/site/publish/apidocs/org/apache/poi/POITextExtractor.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/POITextExtractor.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/POITextExtractor.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/POITextExtractor.html Thu Jul 21 10:22:51 2016
@@ -34,7 +34,7 @@
 </div>
 <div class="subNav">
 <ul class="navList">
-<li><a href="../../../org/apache/poi/POIOLE2TextExtractor.html" title="class in org.apache.poi"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi"><span class="strong">Prev Class</span></a></li>
 <li><a href="../../../org/apache/poi/POIXMLDocument.html" title="class in org.apache.poi"><span class="strong">Next Class</span></a></li>
 </ul>
 <ul class="navList">
@@ -301,7 +301,7 @@ implements java.io.Closeable</pre>
 </div>
 <div class="subNav">
 <ul class="navList">
-<li><a href="../../../org/apache/poi/POIOLE2TextExtractor.html" title="class in org.apache.poi"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi"><span class="strong">Prev Class</span></a></li>
 <li><a href="../../../org/apache/poi/POIXMLDocument.html" title="class in org.apache.poi"><span class="strong">Next Class</span></a></li>
 </ul>
 <ul class="navList">

Modified: poi/site/publish/apidocs/org/apache/poi/class-use/POIDocument.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/class-use/POIDocument.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/class-use/POIDocument.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/class-use/POIDocument.html Thu Jul 21 10:22:51 2016
@@ -122,6 +122,22 @@
 <!--   -->
 </a>
 <h3>Uses of <a href="../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a> in <a href="../../../../org/apache/poi/package-summary.html">org.apache.poi</a></h3>
+<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation">
+<caption><span>Subclasses of <a href="../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a> in <a href="../../../../org/apache/poi/package-summary.html">org.apache.poi</a></span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Class and Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><code>class&nbsp;</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi">POIReadOnlyDocument</a></strong></code>
+<div class="block">This holds the common functionality for all read-only
+  POI Document classes, i.e.</div>
+</td>
+</tr>
+</tbody>
+</table>
 <table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing fields, and an explanation">
 <caption><span>Fields in <a href="../../../../org/apache/poi/package-summary.html">org.apache.poi</a> declared as <a href="../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></span><span class="tabEnd">&nbsp;</span></caption>
 <tr>

Modified: poi/site/publish/apidocs/org/apache/poi/hdgf/HDGFDiagram.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hdgf/HDGFDiagram.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/hdgf/HDGFDiagram.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/hdgf/HDGFDiagram.html Thu Jul 21 10:22:51 2016
@@ -88,12 +88,17 @@
 <li><a href="../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">org.apache.poi.POIDocument</a></li>
 <li>
 <ul class="inheritance">
+<li><a href="../../../../org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi">org.apache.poi.POIReadOnlyDocument</a></li>
+<li>
+<ul class="inheritance">
 <li>org.apache.poi.hdgf.HDGFDiagram</li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
+</li>
+</ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
@@ -104,7 +109,7 @@
 <hr>
 <br>
 <pre>public final class <span class="strong">HDGFDiagram</span>
-extends <a href="../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></pre>
+extends <a href="../../../../org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi">POIReadOnlyDocument</a></pre>
 <div class="block">See
   http://www.redferni.uklinux.net/visio/
   http://www.gnome.ru/projects/docs/vsdocs.html
@@ -196,19 +201,20 @@ extends <a href="../../../../org/apache/
 <div class="block">For testing only</div>
 </td>
 </tr>
-<tr class="rowColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hdgf/HDGFDiagram.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>
-</tr>
 </table>
 <ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.POIReadOnlyDocument">
+<!--   -->
+</a>
+<h3>Methods inherited from class&nbsp;org.apache.poi.<a href="../../../../org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi">POIReadOnlyDocument</a></h3>
+<code><a href="../../../../org/apache/poi/POIReadOnlyDocument.html#write()">write</a>, <a href="../../../../org/apache/poi/POIReadOnlyDocument.html#write(java.io.File)">write</a>, <a href="../../../../org/apache/poi/POIReadOnlyDocument.html#write(java.io.OutputStream)">write</a></code></li>
+</ul>
+<ul class="blockList">
 <li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.POIDocument">
 <!--   -->
 </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">
@@ -317,31 +323,6 @@ extends <a href="../../../../org/apache/
 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/poi/hdgf/dev/VSDDumper.html" title="class in org.apache.poi.hdgf.dev"><code>VSDDumper</code></a></dd></dl>
 </li>
 </ul>
-<a name="write(java.io.OutputStream)">
-<!--   -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>write</h4>
-<pre>public&nbsp;void&nbsp;write(java.io.OutputStream&nbsp;out)</pre>
-<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../org/apache/poi/POIDocument.html#write(java.io.OutputStream)">POIDocument</a></code></strong></div>
-<div class="block">Writes the document out to the specified output stream. The
- 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.
-  
- 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>
-<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>
-<dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - The stream to write to.</dd></dl>
-</li>
-</ul>
 <a name="main(java.lang.String[])">
 <!--   -->
 </a>

Modified: poi/site/publish/apidocs/org/apache/poi/hdgf/package-tree.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hdgf/package-tree.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/hdgf/package-tree.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/hdgf/package-tree.html Thu Jul 21 10:22:51 2016
@@ -79,10 +79,14 @@
 </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>
+<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>
 </ul>
 </li>
 </ul>
+</li>
+</ul>
 </li>
 </ul>
 </div>

Modified: poi/site/publish/apidocs/org/apache/poi/hpbf/HPBFDocument.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpbf/HPBFDocument.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/hpbf/HPBFDocument.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/hpbf/HPBFDocument.html Thu Jul 21 10:22:51 2016
@@ -88,12 +88,17 @@
 <li><a href="../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">org.apache.poi.POIDocument</a></li>
 <li>
 <ul class="inheritance">
+<li><a href="../../../../org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi">org.apache.poi.POIReadOnlyDocument</a></li>
+<li>
+<ul class="inheritance">
 <li>org.apache.poi.hpbf.HPBFDocument</li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
+</li>
+</ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
@@ -104,7 +109,7 @@
 <hr>
 <br>
 <pre>public final class <span class="strong">HPBFDocument</span>
-extends <a href="../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></pre>
+extends <a href="../../../../org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi">POIReadOnlyDocument</a></pre>
 <div class="block">This class provides the basic functionality
   for HPBF, our implementation of the publisher
   file format.</div>
@@ -188,19 +193,20 @@ extends <a href="../../../../org/apache/
 <td class="colFirst"><code><a href="../../../../org/apache/poi/hpbf/model/QuillContents.html" title="class in org.apache.poi.hpbf.model">QuillContents</a></code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpbf/HPBFDocument.html#getQuillContents()">getQuillContents</a></strong>()</code>&nbsp;</td>
 </tr>
-<tr class="altColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpbf/HPBFDocument.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>
-</tr>
 </table>
 <ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.POIReadOnlyDocument">
+<!--   -->
+</a>
+<h3>Methods inherited from class&nbsp;org.apache.poi.<a href="../../../../org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi">POIReadOnlyDocument</a></h3>
+<code><a href="../../../../org/apache/poi/POIReadOnlyDocument.html#write()">write</a>, <a href="../../../../org/apache/poi/POIReadOnlyDocument.html#write(java.io.File)">write</a>, <a href="../../../../org/apache/poi/POIReadOnlyDocument.html#write(java.io.OutputStream)">write</a></code></li>
+</ul>
+<ul class="blockList">
 <li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.POIDocument">
 <!--   -->
 </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">
@@ -312,40 +318,12 @@ extends <a href="../../../../org/apache/
 <a name="getEscherDelayStm()">
 <!--   -->
 </a>
-<ul class="blockList">
+<ul class="blockListLast">
 <li class="blockList">
 <h4>getEscherDelayStm</h4>
 <pre>public&nbsp;<a href="../../../../org/apache/poi/hpbf/model/EscherDelayStm.html" title="class in org.apache.poi.hpbf.model">EscherDelayStm</a>&nbsp;getEscherDelayStm()</pre>
 </li>
 </ul>
-<a name="write(java.io.OutputStream)">
-<!--   -->
-</a>
-<ul class="blockListLast">
-<li class="blockList">
-<h4>write</h4>
-<pre>public&nbsp;void&nbsp;write(java.io.OutputStream&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.OutputStream)">POIDocument</a></code></strong></div>
-<div class="block">Writes the document out to the specified output stream. The
- 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.
-  
- 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>
-<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>
-<dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - The stream to write to.</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>
 </li>
 </ul>
 </li>

Modified: poi/site/publish/apidocs/org/apache/poi/hpbf/package-tree.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpbf/package-tree.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/hpbf/package-tree.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/hpbf/package-tree.html Thu Jul 21 10:22:51 2016
@@ -74,10 +74,14 @@
 <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)
 <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>
+<ul>
 <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>
 </ul>
 </li>
 </ul>
+</li>
+</ul>
 </li>
 </ul>
 </div>

Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/HPSFPropertiesOnlyDocument.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/HPSFPropertiesOnlyDocument.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/hpsf/HPSFPropertiesOnlyDocument.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/hpsf/HPSFPropertiesOnlyDocument.html Thu Jul 21 10:22:51 2016
@@ -167,6 +167,18 @@ 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/hpsf/HPSFPropertiesOnlyDocument.html#write()">write</a></strong>()</code>
+<div class="block">Write out to the currently open file the properties changes, but nothing else</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/HPSFPropertiesOnlyDocument.html#write(java.io.File)">write</a></strong>(java.io.File&nbsp;newFile)</code>
+<div class="block">Write out, with any properties changes, but nothing else</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/HPSFPropertiesOnlyDocument.html#write(java.io.OutputStream)">write</a></strong>(java.io.OutputStream&nbsp;out)</code>
 <div class="block">Write out, with any properties changes, but nothing else</div>
 </td>
@@ -177,7 +189,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">
@@ -235,6 +247,39 @@ extends <a href="../../../../org/apache/
 <!--   -->
 </a>
 <h3>Method Detail</h3>
+<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">Write out to the currently open file the properties changes, but nothing else</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">Write out, with any properties changes, but nothing else</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/hslf/usermodel/HSLFSlideShowImpl.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.html Thu Jul 21 10:22:51 2016
@@ -108,8 +108,6 @@ extends <a href="../../../../../org/apac
 implements java.io.Closeable</pre>
 <div class="block">This class contains the main functionality for the Powerpoint file
  "reader". It is only a very basic class for now</div>
-<dl><dt><span class="strong">Author:</span></dt>
-  <dd>Nick Burch</dd></dl>
 </li>
 </ul>
 </div>
@@ -284,20 +282,42 @@ implements java.io.Closeable</pre>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.html#write(java.io.OutputStream)">write</a></strong>(java.io.OutputStream&nbsp;out)</code>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.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/hslf/usermodel/HSLFSlideShowImpl.html#write(java.io.File)">write</a></strong>(java.io.File&nbsp;newFile)</code>
+<div class="block">Writes out the slideshow file the is represented by an instance
+  of this class.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.html#write(java.io.File,%20boolean)">write</a></strong>(java.io.File&nbsp;newFile,
+     boolean&nbsp;preserveNodes)</code>
 <div class="block">Writes out the slideshow file the is represented by an instance
   of this class.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.html#write(java.io.OutputStream)">write</a></strong>(java.io.OutputStream&nbsp;out)</code>
+<div class="block">Writes out the slideshow file the is represented by an instance
+  of this class.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.html#write(java.io.OutputStream,%20boolean)">write</a></strong>(java.io.OutputStream&nbsp;out,
      boolean&nbsp;preserveNodes)</code>
 <div class="block">Writes out the slideshow file the is represented by an instance
   of this class.</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>protected void</code></td>
 <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.html#writeProperties(org.apache.poi.poifs.filesystem.POIFSFileSystem,%20java.util.List)">writeProperties</a></strong>(<a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">POIFSFileSystem</a>&nbsp;outFS,
                java.util.List&lt;java.lang.String&gt;&nbsp;writtenEntries)</code>
@@ -310,7 +330,7 @@ implements java.io.Closeable</pre>
 <!--   -->
 </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,%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.filesystem.NPOIFSFileSystem)">writeProperties</a>, <a href="../../../../../org/apache/poi/POIDocument.html#writ
 eProperties(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,%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">
@@ -494,6 +514,69 @@ implements java.io.Closeable</pre>
 <dd><code>java.io.IOException</code></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">Writes out the slideshow file the is represented by an instance
+  of this class.
+ <p>This will write out only the common OLE2 streams. If you require all
+  streams to be written out, use <a href="../../../../../org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.html#write(java.io.File,%20boolean)"><code>write(File, boolean)</code></a>
+  with <code>preserveNodes</code> set to <code>true</code>.</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 File to write to.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - If there is an unexpected IOException from writing to the File</dd></dl>
+</li>
+</ul>
+<a name="write(java.io.File, boolean)">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>write</h4>
+<pre>public&nbsp;void&nbsp;write(java.io.File&nbsp;newFile,
+         boolean&nbsp;preserveNodes)
+           throws java.io.IOException</pre>
+<div class="block">Writes out the slideshow file the is represented by an instance
+  of this class.
+ If you require all streams to be written out (eg Marcos, embeded
+  documents), then set <code>preserveNodes</code> set to <code>true</code></div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newFile</code> - The File to write to.</dd><dd><code>preserveNodes</code> - Should all OLE2 streams be written back out, or only the common ones?</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - If there is an unexpected IOException from writing to the File</dd></dl>
+</li>
+</ul>
 <a name="write(java.io.OutputStream)">
 <!--   -->
 </a>
@@ -504,8 +587,9 @@ implements java.io.Closeable</pre>
            throws java.io.IOException</pre>
 <div class="block">Writes out the slideshow file the is represented by an instance
   of this class.
- It will write out the common OLE2 streams. If you require all
-  streams to be written out, pass in preserveNodes</div>
+ <p>This will write out only the common OLE2 streams. If you require all
+  streams to be written out, use <a href="../../../../../org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.html#write(java.io.OutputStream,%20boolean)"><code>write(OutputStream, boolean)</code></a>
+  with <code>preserveNodes</code> set to <code>true</code>.</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>
@@ -527,7 +611,7 @@ implements java.io.Closeable</pre>
 <div class="block">Writes out the slideshow file the is represented by an instance
   of this class.
  If you require all streams to be written out (eg Marcos, embeded
-  documents), then set preserveNodes to true</div>
+  documents), then set <code>preserveNodes</code> set to <code>true</code></div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - The OutputStream to write to.</dd><dd><code>preserveNodes</code> - Should all OLE2 streams be written back out, or only the common ones?</dd>
 <dt><span class="strong">Throws:</span></dt>
 <dd><code>java.io.IOException</code> - If there is an unexpected IOException from

Modified: poi/site/publish/apidocs/org/apache/poi/hsmf/MAPIMessage.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hsmf/MAPIMessage.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/hsmf/MAPIMessage.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/hsmf/MAPIMessage.html Thu Jul 21 10:22:51 2016
@@ -88,12 +88,17 @@
 <li><a href="../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">org.apache.poi.POIDocument</a></li>
 <li>
 <ul class="inheritance">
+<li><a href="../../../../org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi">org.apache.poi.POIReadOnlyDocument</a></li>
+<li>
+<ul class="inheritance">
 <li>org.apache.poi.hsmf.MAPIMessage</li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
+</li>
+</ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
@@ -104,7 +109,7 @@
 <hr>
 <br>
 <pre>public class <span class="strong">MAPIMessage</span>
-extends <a href="../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></pre>
+extends <a href="../../../../org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi">POIReadOnlyDocument</a></pre>
 <div class="block">Reads an Outlook MSG File in and provides hooks into its data structure.
  
  If you want to develop with HSMF, you might find it worth getting
@@ -375,19 +380,20 @@ extends <a href="../../../../org/apache/
   (default is the exception).</div>
 </td>
 </tr>
-<tr class="rowColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hsmf/MAPIMessage.html#write(java.io.OutputStream)">write</a></strong>(java.io.OutputStream&nbsp;out)</code>
-<div class="block">Note - not yet supported, sorry.</div>
-</td>
-</tr>
 </table>
 <ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.POIReadOnlyDocument">
+<!--   -->
+</a>
+<h3>Methods inherited from class&nbsp;org.apache.poi.<a href="../../../../org/apache/poi/POIReadOnlyDocument.html" title="class in org.apache.poi">POIReadOnlyDocument</a></h3>
+<code><a href="../../../../org/apache/poi/POIReadOnlyDocument.html#write()">write</a>, <a href="../../../../org/apache/poi/POIReadOnlyDocument.html#write(java.io.File)">write</a>, <a href="../../../../org/apache/poi/POIReadOnlyDocument.html#write(java.io.OutputStream)">write</a></code></li>
+</ul>
+<ul class="blockList">
 <li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.POIDocument">
 <!--   -->
 </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">
@@ -883,23 +889,6 @@ public&nbsp;java.lang.String&nbsp;getHmt
 <div class="block">Gets the message attachments.</div>
 </li>
 </ul>
-<a name="write(java.io.OutputStream)">
-<!--   -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>write</h4>
-<pre>public&nbsp;void&nbsp;write(java.io.OutputStream&nbsp;out)
-           throws java.io.IOException</pre>
-<div class="block">Note - not yet supported, sorry.</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>
-<dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - The stream to write to.</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="isReturnNullOnMissingChunk()">
 <!--   -->
 </a>

Modified: poi/site/publish/apidocs/org/apache/poi/hsmf/package-tree.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hsmf/package-tree.html?rev=1753654&r1=1753653&r2=1753654&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/hsmf/package-tree.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/hsmf/package-tree.html Thu Jul 21 10:22:51 2016
@@ -74,10 +74,14 @@
 <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)
 <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>
+<ul>
 <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>
+</ul>
 </li>
 </ul>
 </div>



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