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

Update Javadocs to refer to the fact that WorkbookFactory.create will throw a EncryptedDocumentException if the file is password protected 

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1662074 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Nick Burch 2015-02-24 18:20:02 +00:00
parent 42d9b31296
commit 51209bc957
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -22,6 +22,7 @@ import java.io.IOException;
import java.io.InputStream; import java.io.InputStream;
import java.io.PushbackInputStream; import java.io.PushbackInputStream;
import org.apache.poi.EncryptedDocumentException;
import org.apache.poi.POIXMLDocument; import org.apache.poi.POIXMLDocument;
import org.apache.poi.hssf.usermodel.HSSFWorkbook; import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.openxml4j.exceptions.InvalidFormatException; import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
@ -73,8 +74,9 @@ public class WorkbookFactory {
* than using a {@link File}.</p> * than using a {@link File}.</p>
* <p>Note that in order to properly release resources the * <p>Note that in order to properly release resources the
* Workbook should be closed after use. * Workbook should be closed after use.
* @throws EncryptedDocumentException If the workbook given is password protected
*/ */
public static Workbook create(InputStream inp) throws IOException, InvalidFormatException { public static Workbook create(InputStream inp) throws IOException, InvalidFormatException, EncryptedDocumentException {
// If clearly doesn't do mark/reset, wrap up // If clearly doesn't do mark/reset, wrap up
if (! inp.markSupported()) { if (! inp.markSupported()) {
inp = new PushbackInputStream(inp, 8); inp = new PushbackInputStream(inp, 8);
@ -94,8 +96,9 @@ public class WorkbookFactory {
* the given File, which must exist and be readable. * the given File, which must exist and be readable.
* <p>Note that in order to properly release resources the * <p>Note that in order to properly release resources the
* Workbook should be closed after use. * Workbook should be closed after use.
* @throws EncryptedDocumentException If the workbook given is password protected
*/ */
public static Workbook create(File file) throws IOException, InvalidFormatException { public static Workbook create(File file) throws IOException, InvalidFormatException, EncryptedDocumentException {
if (! file.exists()) { if (! file.exists()) {
throw new FileNotFoundException(file.toString()); throw new FileNotFoundException(file.toString());
} }