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/26 11:00:47 UTC
svn commit: r1754109 - in /poi/site: publish/apidocs/index-all.html
publish/apidocs/org/apache/poi/hwpf/HWPFDocument.html publish/changes.html
publish/changes.rss src/documentation/content/xdocs/status.xml
Author: nick
Date: Tue Jul 26 11:00:47 2016
New Revision: 1754109
URL: http://svn.apache.org/viewvc?rev=1754109&view=rev
Log:
Changelog and javadoc update
Modified:
poi/site/publish/apidocs/index-all.html
poi/site/publish/apidocs/org/apache/poi/hwpf/HWPFDocument.html
poi/site/publish/changes.html
poi/site/publish/changes.rss
poi/site/src/documentation/content/xdocs/status.xml
Modified: poi/site/publish/apidocs/index-all.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/index-all.html?rev=1754109&r1=1754108&r2=1754109&view=diff
==============================================================================
--- poi/site/publish/apidocs/index-all.html (original)
+++ poi/site/publish/apidocs/index-all.html Tue Jul 26 11:00:47 2016
@@ -87000,9 +87000,13 @@ the order they are declared.</div>
<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> </dd>
+<dd>
+<div class="block">Warning - not currently implemented for HWPF!</div>
+</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> </dd>
+<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/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>
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=1754109&r1=1754108&r2=1754109&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/hwpf/HWPFDocument.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/hwpf/HWPFDocument.html Tue Jul 26 11:00:47 2016
@@ -450,14 +450,13 @@ extends <a href="../../../../org/apache/
<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>
+<div class="block">Warning - not currently implemented for HWPF!</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 newFile)</code>
-<div class="block">Writes the document out to the specified new <code>File</code>.</div>
+<div class="block">Writes out the word file that is represented by an instance of this class.</div>
</td>
</tr>
<tr class="altColor">
@@ -1026,15 +1025,7 @@ public <a href="../../../../org/apa
<h4>write</h4>
<pre>public void write()
throws java.io.IOException</pre>
-<div class="block"><strong>Description copied from class: <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>
+<div class="block">Warning - not currently implemented for HWPF!</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/poi/POIDocument.html#write()">write</a></code> in class <code><a href="../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></code></dd>
@@ -1050,15 +1041,18 @@ public <a href="../../../../org/apa
<h4>write</h4>
<pre>public void write(java.io.File newFile)
throws java.io.IOException</pre>
-<div class="block"><strong>Description copied from class: <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>
+<div class="block">Writes out the word file that is represented by an instance of this class.
+
+ If the <code>File</code> 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> in class <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">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> - thrown on errors writing to the file</dd></dl>
+<dd><code>java.io.IOException</code> - If there is an unexpected IOException from writing
+ to the File.</dd><dt><span class="strong">Since:</span></dt>
+ <dd>3.15 beta 3</dd></dl>
</li>
</ul>
<a name="write(java.io.OutputStream)">
@@ -1071,8 +1065,8 @@ public <a href="../../../../org/apa
throws java.io.IOException</pre>
<div class="block">Writes out the word file that is represented by an instance of this class.
- If <code>stream</code> is a <code>FileOutputStream</code> on a networked drive
- or has a high cost/latency associated with each written byte,
+ For better performance when writing to files, use <a href="../../../../org/apache/poi/hwpf/HWPFDocument.html#write(java.io.File)"><code>write(File)</code></a>.
+ If <code>stream</code> 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>
Modified: poi/site/publish/changes.html
URL: http://svn.apache.org/viewvc/poi/site/publish/changes.html?rev=1754109&r1=1754108&r2=1754109&view=diff
==============================================================================
--- poi/site/publish/changes.html (original)
+++ poi/site/publish/changes.html Tue Jul 26 11:00:47 2016
@@ -265,6 +265,12 @@ if (VERSION > 3) {
<ul>
<li>
+<img class="icon" alt="add" src="images/add.jpg"> <a href="https://bz.apache.org/bugzilla/show_bug.cgi?id=57919">57919</a> - HSSF, HSLF and HPSF support for in-place writing to the currently open File (requires the POIFS/NPOIFS was opened from a read-write File)</li>
+
+<li>
+<img class="icon" alt="add" src="images/add.jpg"> <a href="https://bz.apache.org/bugzilla/show_bug.cgi?id=57919">57919</a> - HSSF, HSLF, HPSF and HWPF support for writing out to a new File - normally faster than writing to an OutputStream</li>
+
+<li>
<img class="icon" alt="fix" src="images/fix.jpg"> <a href="https://bz.apache.org/bugzilla/show_bug.cgi?id=59881">59881</a> - SS Common: D* formula evaluation from blank cells in database headers</li>
<li>
Modified: poi/site/publish/changes.rss
URL: http://svn.apache.org/viewvc/poi/site/publish/changes.rss?rev=1754109&r1=1754108&r2=1754109&view=diff
==============================================================================
--- poi/site/publish/changes.rss (original)
+++ poi/site/publish/changes.rss Tue Jul 26 11:00:47 2016
@@ -1,6 +1,8 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE rss PUBLIC "-//Netscape Communications//DTD RSS 0.91//EN" "http://my.netscape.com/publish/formats/rss-0.91.dtd">
<rss version="0.91"><channel><title>Apache POI Changes</title><link>http://poi.apache.org/changes.html</link><description>Apache POI Changes</description><language>en-us</language>
+<item><title> add(bug 57919)</title><link>http://poi.apache.org/changes.html</link><description> add by POI Developers (bug 57919) - HSSF, HSLF and HPSF support for in-place writing to the currently open File (requires the POIFS/NPOIFS was opened from a read-write File)</description></item>
+<item><title> add(bug 57919)</title><link>http://poi.apache.org/changes.html</link><description> add by POI Developers (bug 57919) - HSSF, HSLF, HPSF and HWPF support for writing out to a new File - normally faster than writing to an OutputStream</description></item>
<item><title> fix(bug 59881)</title><link>http://poi.apache.org/changes.html</link><description> fix by POI Developers (bug 59881) - SS Common: D* formula evaluation from blank cells in database headers</description></item>
<item><title> add(bug 52122)</title><link>http://poi.apache.org/changes.html</link><description> add by POI Developers (bug 52122) - Excel does not handle conditional formatting based on formula correctly unless recalculation is forced</description></item>
<item><title> add(bug 59106)</title><link>http://poi.apache.org/changes.html</link><description> add by POI Developers (bug 59106) - WorkdayFunction does not read the area with holidays correctly to calculate work days</description></item>
Modified: poi/site/src/documentation/content/xdocs/status.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/status.xml?rev=1754109&r1=1754108&r2=1754109&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/status.xml (original)
+++ poi/site/src/documentation/content/xdocs/status.xml Tue Jul 26 11:00:47 2016
@@ -40,6 +40,8 @@
</devs>
<release version="3.15-beta3" date="2016-08-??">
+ <action dev="PD" type="add" fixes-bug="57919">HSSF, HSLF and HPSF support for in-place writing to the currently open File (requires the POIFS/NPOIFS was opened from a read-write File)</action>
+ <action dev="PD" type="add" fixes-bug="57919">HSSF, HSLF, HPSF and HWPF support for writing out to a new File - normally faster than writing to an OutputStream</action>
<action dev="PD" type="fix" fixes-bug="59881">SS Common: D* formula evaluation from blank cells in database headers</action>
<action dev="PD" type="add" fixes-bug="52122">Excel does not handle conditional formatting based on formula correctly unless recalculation is forced</action>
<action dev="PD" type="add" fixes-bug="59106">WorkdayFunction does not read the area with holidays correctly to calculate work days</action>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org