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

Bug 56537: Update javadoc to reflect the addition of Closeable to Workbook 

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1607390 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Dominik Stadler 2014-07-02 15:05:05 +00:00
parent e53716bd5b
commit 757dd5bb9a
2 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/java/org/apache/poi/poifs/filesystem/NPOIFSFileSystem.java
View File

@ -157,7 +157,6 @@ public class NPOIFSFileSystem extends BlockStore
* *
* @exception IOException on errors reading, or on invalid data * @exception IOException on errors reading, or on invalid data
*/ */
@SuppressWarnings("resource")
public NPOIFSFileSystem(File file, boolean readOnly) public NPOIFSFileSystem(File file, boolean readOnly)
throws IOException throws IOException
{ {

13
src/ooxml/java/org/apache/poi/ss/usermodel/WorkbookFactory.java
View File

@ -39,6 +39,8 @@ import org.apache.poi.xssf.usermodel.XSSFWorkbook;
public class WorkbookFactory { public class WorkbookFactory {
/** /**
* Creates a HSSFWorkbook from the given POIFSFileSystem * Creates a HSSFWorkbook from the given POIFSFileSystem
* <p>Note that in order to properly release resources the
* Workbook should be closed after use.
*/ */
public static Workbook create(POIFSFileSystem fs) throws IOException { public static Workbook create(POIFSFileSystem fs) throws IOException {
return new HSSFWorkbook(fs); return new HSSFWorkbook(fs);
@ -46,6 +48,8 @@ public class WorkbookFactory {
/** /**
* Creates a HSSFWorkbook from the given NPOIFSFileSystem * Creates a HSSFWorkbook from the given NPOIFSFileSystem
* <p>Note that in order to properly release resources the
* Workbook should be closed after use.
*/ */
public static Workbook create(NPOIFSFileSystem fs) throws IOException { public static Workbook create(NPOIFSFileSystem fs) throws IOException {
return new HSSFWorkbook(fs.getRoot(), true); return new HSSFWorkbook(fs.getRoot(), true);
@ -53,6 +57,8 @@ public class WorkbookFactory {
/** /**
* Creates a XSSFWorkbook from the given OOXML Package * Creates a XSSFWorkbook from the given OOXML Package
* <p>Note that in order to properly release resources the
* Workbook should be closed after use.
*/ */
public static Workbook create(OPCPackage pkg) throws IOException { public static Workbook create(OPCPackage pkg) throws IOException {
return new XSSFWorkbook(pkg); return new XSSFWorkbook(pkg);
@ -65,6 +71,8 @@ public class WorkbookFactory {
* be wrapped as a {@link PushbackInputStream}! Note that * be wrapped as a {@link PushbackInputStream}! Note that
* using an {@link InputStream} has a higher memory footprint * using an {@link InputStream} has a higher memory footprint
* than using a {@link File}.</p> * than using a {@link File}.</p>
* <p>Note that in order to properly release resources the
* Workbook should be closed after use.
*/ */
public static Workbook create(InputStream inp) throws IOException, InvalidFormatException { public static Workbook create(InputStream inp) throws IOException, InvalidFormatException {
// If clearly doesn't do mark/reset, wrap up // If clearly doesn't do mark/reset, wrap up
@ -84,8 +92,8 @@ public class WorkbookFactory {
/** /**
* Creates the appropriate HSSFWorkbook / XSSFWorkbook from * Creates the appropriate HSSFWorkbook / XSSFWorkbook from
* the given File, which must exist and be readable. * the given File, which must exist and be readable.
* <p>Note that for Workbooks opened this way, it is not possible * <p>Note that in order to properly release resources the
* to explicitly close the underlying File resource. * Workbook should be closed after use.
*/ */
public static Workbook create(File file) throws IOException, InvalidFormatException { public static Workbook create(File file) throws IOException, InvalidFormatException {
if (! file.exists()) { if (! file.exists()) {
@ -93,6 +101,7 @@ public class WorkbookFactory {
} }
try { try {
@SuppressWarnings("resource")
NPOIFSFileSystem fs = new NPOIFSFileSystem(file); NPOIFSFileSystem fs = new NPOIFSFileSystem(file);
return new HSSFWorkbook(fs.getRoot(), true); return new HSSFWorkbook(fs.getRoot(), true);
} catch(OfficeXmlFileException e) { } catch(OfficeXmlFileException e) {