From: Nick Burch <nick@apache.org>
Date: Wed, 4 Jun 2014 16:34:16 +0000 (+0000)
Subject: Add a note about file resources, see bug #56537
X-Git-Tag: REL_3_11_BETA1~120
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=d768645eddc9b302050059ca43964b97f78236c3;p=poi.git

Add a note about file resources, see bug #56537

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1600326 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/src/ooxml/java/org/apache/poi/ss/usermodel/WorkbookFactory.java b/src/ooxml/java/org/apache/poi/ss/usermodel/WorkbookFactory.java
index a2d487c5e1..eeb24a4eb4 100644
--- a/src/ooxml/java/org/apache/poi/ss/usermodel/WorkbookFactory.java
+++ b/src/ooxml/java/org/apache/poi/ss/usermodel/WorkbookFactory.java
@@ -84,6 +84,8 @@ public class WorkbookFactory {
     /**
      * Creates the appropriate HSSFWorkbook / XSSFWorkbook from
      *  the given File, which must exist and be readable.
+     * <p>Note that for Workbooks opened this way, it is not possible
+     *  to explicitly close the underlying File resource.
      */
     public static Workbook create(File file) throws IOException, InvalidFormatException {
         if (! file.exists()) {