You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ti...@apache.org on 2016/10/18 16:35:34 UTC
svn commit: r1765477 -
/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java
Author: tilman
Date: Tue Oct 18 16:35:34 2016
New Revision: 1765477
URL: http://svn.apache.org/viewvc?rev=1765477&view=rev
Log:
PDFBOX-2852: improve javadoc
Modified:
pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java
Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java?rev=1765477&r1=1765476&r2=1765477&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java Tue Oct 18 16:35:34 2016
@@ -853,7 +853,7 @@ public class PDDocument implements Close
*
* @return loaded document
*
- * @throws InvalidPasswordException If the password is incorrect.
+ * @throws InvalidPasswordException If the file required a non-empty password.
* @throws IOException in case of a file reading or parsing error
*/
public static PDDocument load(File file) throws InvalidPasswordException, IOException
@@ -869,7 +869,7 @@ public class PDDocument implements Close
*
* @return loaded document
*
- * @throws InvalidPasswordException If the password is incorrect.
+ * @throws InvalidPasswordException If the file required a non-empty password.
* @throws IOException in case of a file reading or parsing error
*/
public static PDDocument load(File file, MemoryUsageSetting memUsageSetting)
@@ -978,8 +978,8 @@ public class PDDocument implements Close
*
* @return loaded document
*
- * @throws InvalidPasswordException If the password is incorrect.
- * @throws IOException in case of a file reading or parsing error
+ * @throws InvalidPasswordException If the PDF required a non-empty password.
+ * @throws IOException In case of a reading or parsing error.
*/
public static PDDocument load(InputStream input) throws InvalidPasswordException, IOException
{
@@ -996,8 +996,8 @@ public class PDDocument implements Close
*
* @return loaded document
*
- * @throws InvalidPasswordException If the password is incorrect.
- * @throws IOException in case of a file reading or parsing error
+ * @throws InvalidPasswordException If the PDF required a non-empty password.
+ * @throws IOException In case of a reading or parsing error.
*/
public static PDDocument load(InputStream input, MemoryUsageSetting memUsageSetting)
throws InvalidPasswordException, IOException
@@ -1015,7 +1015,7 @@ public class PDDocument implements Close
* @return loaded document
*
* @throws InvalidPasswordException If the password is incorrect.
- * @throws IOException in case of a file reading or parsing error
+ * @throws IOException In case of a reading or parsing error.
*/
public static PDDocument load(InputStream input, String password)
throws InvalidPasswordException, IOException
@@ -1034,7 +1034,7 @@ public class PDDocument implements Close
*
* @return loaded document
*
- * @throws IOException in case of a file reading or parsing error
+ * @throws IOException In case of a reading or parsing error.
*/
public static PDDocument load(InputStream input, String password, InputStream keyStore, String alias)
throws IOException
@@ -1054,7 +1054,7 @@ public class PDDocument implements Close
* @return loaded document
*
* @throws InvalidPasswordException If the password is incorrect.
- * @throws IOException in case of a file reading or parsing error
+ * @throws IOException In case of a reading or parsing error.
*/
public static PDDocument load(InputStream input, String password, MemoryUsageSetting memUsageSetting)
throws InvalidPasswordException, IOException
@@ -1075,7 +1075,8 @@ public class PDDocument implements Close
*
* @return loaded document
*
- * @throws IOException in case of a file reading or parsing error
+ * @throws InvalidPasswordException If the password is incorrect.
+ * @throws IOException In case of a reading or parsing error.
*/
public static PDDocument load(InputStream input, String password, InputStream keyStore,
String alias, MemoryUsageSetting memUsageSetting) throws IOException
@@ -1102,8 +1103,8 @@ public class PDDocument implements Close
*
* @return loaded document
*
- * @throws InvalidPasswordException If the password is incorrect.
- * @throws IOException in case of a file reading or parsing error
+ * @throws InvalidPasswordException If the PDF required a non-empty password.
+ * @throws IOException In case of a reading or parsing error.
*/
public static PDDocument load(byte[] input) throws InvalidPasswordException, IOException
{
@@ -1119,7 +1120,7 @@ public class PDDocument implements Close
* @return loaded document
*
* @throws InvalidPasswordException If the password is incorrect.
- * @throws IOException in case of a file reading or parsing error
+ * @throws IOException In case of a reading or parsing error.
*/
public static PDDocument load(byte[] input, String password)
throws InvalidPasswordException, IOException
@@ -1137,7 +1138,8 @@ public class PDDocument implements Close
*
* @return loaded document
*
- * @throws IOException in case of a file reading or parsing error
+ * @throws InvalidPasswordException If the password is incorrect.
+ * @throws IOException In case of a reading or parsing error.
*/
public static PDDocument load(byte[] input, String password, InputStream keyStore,
String alias) throws IOException
@@ -1156,7 +1158,8 @@ public class PDDocument implements Close
*
* @return loaded document
*
- * @throws IOException in case of a file reading or parsing error
+ * @throws InvalidPasswordException If the password is incorrect.
+ * @throws IOException In case of a reading or parsing error.
*/
public static PDDocument load(byte[] input, String password, InputStream keyStore,
String alias, MemoryUsageSetting memUsageSetting) throws IOException