Apache
/
poi
mirror of https://github.com/apache/poi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

bug 57919: add performance note to javadocs about using BufferedOutputStreams on Document.write(OutputStream) if underlying resource is high latency 

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1753112 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Javen O'Neal 2016-07-17 20:25:37 +00:00
parent 6763ecb9b9
commit bf53115645
4 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/java/org/apache/poi/POIDocument.java
View File

@ -314,6 +314,11 @@ public abstract class POIDocument implements Closeable {
* than an {@link InputStream}, you <b>must</b> write out to
* a different file, overwriting via an OutputStream isn't possible.
*
* If {@code stream} is a {@link java.io.FileOutputStream} on a networked drive
* or has a high cost/latency associated with each written byte,
* consider wrapping the OutputStream in a {@link java.io.BufferedOutputStream}
* to improve write performance.
*
* @param out The stream to write to.
*
* @throws IOException thrown on errors writing to the stream

5
src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
View File

@ -1328,6 +1328,11 @@ public final class HSSFWorkbook extends POIDocument implements org.apache.poi.ss
* a new POI POIFSFileSystem, passes in the workbook binary representation and
* writes it out.
*
* If {@code stream} is a {@link java.io.FileOutputStream} on a networked drive
* or has a high cost/latency associated with each written byte,
* consider wrapping the OutputStream in a {@link java.io.BufferedOutputStream}
* to improve write performance.
*
* @param stream - the java OutputStream you wish to write the XLS to
*
* @exception IOException if anything can't be written.

5
src/ooxml/java/org/apache/poi/POIXMLDocument.java
View File

@ -215,6 +215,11 @@ public abstract class POIXMLDocument extends POIXMLDocumentPart implements Close
* than an {@link InputStream}, you <b>must</b> write out to
* a different file, overwriting via an OutputStream isn't possible.
*
* If {@code stream} is a {@link java.io.FileOutputStream} on a networked drive
* or has a high cost/latency associated with each written byte,
* consider wrapping the OutputStream in a {@link java.io.BufferedOutputStream}
* to improve write performance.
*
* @param stream - the java OutputStream you wish to write the file to
*
* @exception IOException if anything can't be written.

7
src/scratchpad/src/org/apache/poi/hwpf/HWPFDocument.java
View File

@ -79,7 +79,7 @@ import org.apache.poi.util.Internal;
*/
public final class HWPFDocument extends HWPFDocumentCore
{
static final String PROPERTY_PRESERVE_BIN_TABLES = "org.apache.poi.hwpf.preserveBinTables";
/*package*/ static final String PROPERTY_PRESERVE_BIN_TABLES = "org.apache.poi.hwpf.preserveBinTables";
private static final String PROPERTY_PRESERVE_TEXT_TABLE = "org.apache.poi.hwpf.preserveTextTable";
private static final String STREAM_DATA = "Data";
@ -584,6 +584,11 @@ public final class HWPFDocument extends HWPFDocumentCore
/**
* Writes out the word file that is represented by an instance of this class.
*
* If {@code stream} is a {@link java.io.FileOutputStream} on a networked drive
* or has a high cost/latency associated with each written byte,
* consider wrapping the OutputStream in a {@link java.io.BufferedOutputStream}
* to improve write performance.
*
* @param out The OutputStream to write to.
* @throws IOException If there is an unexpected IOException from the passed
* in OutputStream.