Comments, Javadoc and make close() only log instead of throw an exception to not...

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

diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
index 5360fe600ecf1743bb9f9678f5117116d37e0927..471856a9e5d7658e150b3fe12a637019abb84fbf 100644 (file)
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
@@ -1686,6 +1686,7 @@ public final class HSSFSheet implements org.apache.poi.ss.usermodel.Sheet {
             }
             if (endRow == _lastrow) {
                 // Need to walk backward to find the last non-blank row
+                // NOTE: n is always negative here
                 _lastrow = Math.min(endRow + n, SpreadsheetVersion.EXCEL97.getLastRowIndex());
                 for (int i = endRow - 1; i > endRow + n; i++) {
                     if (getRow(i) != null) {

diff --git a/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java b/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java
index 7fbfe779adb7635c6e9fa3c866f6d07a8808f63c..6b6c5e85cbee953cc896257d67964431d5a032ef 100644 (file)
--- a/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java
+++ b/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java
@@ -39,7 +39,6 @@ import java.util.regex.Pattern;
 
 import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
 import org.apache.poi.openxml4j.exceptions.InvalidOperationException;
-import org.apache.poi.openxml4j.exceptions.OpenXML4JException;
 import org.apache.poi.openxml4j.exceptions.OpenXML4JRuntimeException;
 import org.apache.poi.openxml4j.exceptions.PartAlreadyExistsException;
 import org.apache.poi.openxml4j.opc.internal.ContentType;
@@ -241,7 +240,8 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
         * @throws InvalidFormatException
         *             If the specified file doesn't exist, and a parsing error
         *             occur.
-        * @throws InvalidOperationException
+        * @throws InvalidOperationException If the zip file cannot be opened.
+        * @throws InvalidFormatException if the package is not valid.
         */
        public static OPCPackage open(String path, PackageAccess access)
                        throws InvalidFormatException, InvalidOperationException {
@@ -262,11 +262,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
                                success = true;
                        } finally {
                                if (! success) {
-                                       try {
-                                               pack.close();
-                                       } catch (final IOException e) {
-                                               throw new InvalidOperationException("Could not close OPCPackage while cleaning up", e);
-                                       }
+                                       IOUtils.closeQuietly(pack);
                                }
                        }
                }
@@ -403,11 +399,6 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
                return pkg;
        }
 
-       /**
-        * Configure the package.
-        *
-        * @param pkg
-        */
        private static void configurePackage(OPCPackage pkg) {
                try {
                        // Content type manager
@@ -598,8 +589,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
         * (PackageAccess.Write). This method is call when other methods need write
         * right.
         *
-        * @throws InvalidOperationException
-        *             Throws if a read operation is done on a write only package.
+        * @throws InvalidOperationException if a read operation is done on a write only package.
         * @see org.apache.poi.openxml4j.opc.PackageAccess
         */
        void throwExceptionIfWriteOnly() throws InvalidOperationException {
@@ -750,6 +740,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
         *  Compliance with Rule M4.1, and ignore all others silently too. 
         *
         * @return All this package's parts.
+        * @throws InvalidFormatException if the package is not valid.
         */
        public ArrayList<PackagePart> getParts() throws InvalidFormatException {
                throwExceptionIfWriteOnly();
@@ -960,7 +951,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
         * @param part
         *            The part to add (or replace).
         * @return The part added to the package, the same as the one specified.
-        * @throws InvalidFormatException
+        * @throws InvalidOperationException
         *             If rule M1.12 is not verified : Packages shall not contain
         *             equivalent part names and package implementers shall neither
         *             create nor recognize packages with equivalent part names.
@@ -1327,7 +1318,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
         * Retrieves all package relationships.
         *
         * @return All package relationships of this package.
-        * @throws OpenXML4JException
+     * @throws InvalidOperationException if a read operation is done on a write only package.
         * @see #getRelationshipsHelper(String)
         */
        @Override

diff --git a/src/ooxml/java/org/apache/poi/openxml4j/opc/ZipPackage.java b/src/ooxml/java/org/apache/poi/openxml4j/opc/ZipPackage.java
index 33333c3c51cd9d31f0cc0f463617c23b9fad6b4f..7a147b052492235fd4ff505d8b39d6a50a6e4e02 100644 (file)
--- a/src/ooxml/java/org/apache/poi/openxml4j/opc/ZipPackage.java
+++ b/src/ooxml/java/org/apache/poi/openxml4j/opc/ZipPackage.java
@@ -114,7 +114,7 @@ public final class ZipPackage extends OPCPackage {
      *            The path of the file to open or create.
      * @param access
      *            The package access mode.
-     * @throws InvalidOperationException
+     * @throws InvalidOperationException If the zip file cannot be opened.
      */
     ZipPackage(String path, PackageAccess access) throws InvalidOperationException {
         this(new File(path), access);
@@ -127,7 +127,7 @@ public final class ZipPackage extends OPCPackage {
      *            The file to open or create.
      * @param access
      *            The package access mode.
-     * @throws InvalidOperationException
+     * @throws InvalidOperationException If the zip file cannot be opened.
      */
     ZipPackage(File file, PackageAccess access) throws InvalidOperationException {
         super(access);
@@ -231,8 +231,7 @@ public final class ZipPackage extends OPCPackage {
      * list is not empty, it will be emptied.
      *
      * @return All parts contain in this package.
-     * @throws InvalidFormatException
-     *             Throws if the package is not valid.
+     * @throws InvalidFormatException if the package is not valid.
      */
     @Override
     protected PackagePart[] getPartsImpl() throws InvalidFormatException {