Apache/poi
1
0
Fork 0
mirror of https://github.com/apache/poi.git synced 2025-03-06 17:09:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

[bug-64542] allow file channel closing to be controlled by calling code

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1894069 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
PJ Fanning 2021-10-09 13:21:25 +00:00
parent e9b76ce3b1
commit 6659536325
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
poi/src/main/java/org/apache/poi/poifs/filesystem/POIFSFileSystem.java
View File

@ -174,10 +174,13 @@ public class POIFSFileSystem extends BlockStore
* *
* <p>Note that with this constructor, you will need to call {@link #close()} * <p>Note that with this constructor, you will need to call {@link #close()}
* when you're done to have the underlying Channel closed, as the channel is * when you're done to have the underlying Channel closed, as the channel is
* kept open during normal operation to read the data out.</p> * kept open during normal operation to read the data out. For legacy reasons,
* the channel is not closed if there is an error creating the POIFSFileSystem.</p>
* *
* @param channel the FileChannel from which to read the data * @param channel the FileChannel from which to read the data
* @throws IOException on errors reading, or on invalid data * @throws IOException on errors reading, or on invalid data
* @see POIFSFileSystem(FileChannel, boolean, boolean) this constructor gives more control over whether to
* close the provided channel
*/ */
public POIFSFileSystem(FileChannel channel) public POIFSFileSystem(FileChannel channel)
throws IOException { throws IOException {
@ -190,11 +193,14 @@ public class POIFSFileSystem extends BlockStore
* *
* <p>Note that with this constructor, you will need to call {@link #close()} * <p>Note that with this constructor, you will need to call {@link #close()}
* when you're done to have the underlying Channel closed, as the channel is * when you're done to have the underlying Channel closed, as the channel is
* kept open during normal operation to read the data out.</p> * kept open during normal operation to read the data out. For legacy reasons,
* the channel is not closed if there is an error creating the POIFSFileSystem.</p>
* *
* @param channel the FileChannel from which to read or read/write the data * @param channel the FileChannel from which to read or read/write the data
* @param readOnly whether the POIFileSystem will only be used in read-only mode * @param readOnly whether the POIFileSystem will only be used in read-only mode
* @throws IOException on errors reading, or on invalid data * @throws IOException on errors reading, or on invalid data
* @see POIFSFileSystem(FileChannel, boolean, boolean) this constructor gives more control over whether to
* close the provided channel
*/ */
public POIFSFileSystem(FileChannel channel, boolean readOnly) public POIFSFileSystem(FileChannel channel, boolean readOnly)
throws IOException { throws IOException {