[jboss-svn-commits] JBoss Common SVN: r3955 - shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/importer.

[jboss-svn-commits at lists.jboss.org]

Author: ALRubinger
Date: 2010-01-24 16:41:28 -0500 (Sun, 24 Jan 2010)
New Revision: 3955

Modified:
   shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/importer/ArchiveImportException.java
   shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/importer/ZipImporter.java
Log:
[SHRINKWRAP-122] Clearly describe the conditions leading to ArchiveImportException

Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/importer/ArchiveImportException.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/importer/ArchiveImportException.java	2010-01-22 17:02:19 UTC (rev 3954)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/importer/ArchiveImportException.java	2010-01-24 21:41:28 UTC (rev 3955)
@@ -17,9 +17,7 @@
 package org.jboss.shrinkwrap.api.importer;
 
 /**
- * ArchiveImportException
- * 
- * Exception thrown on error while mporting a Archive.
+ * Denotes an unexpected error was encountered while importing a Archive.
  *
  * @author <a href="mailto:aslak at conduct.no">Aslak Knutsen</a>
  * @version $Revision: $
@@ -39,14 +37,6 @@
    }
 
    /**
-    * @param message
-    */
-   public ArchiveImportException(String message)
-   {
-      super(message);
-   }
-
-   /**
     * @param cause
     */
    public ArchiveImportException(Throwable cause)

Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/importer/ZipImporter.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/importer/ZipImporter.java	2010-01-22 17:02:19 UTC (rev 3954)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/importer/ZipImporter.java	2010-01-24 21:41:28 UTC (rev 3955)
@@ -33,21 +33,21 @@
    //-------------------------------------------------------------------------------------||
    // Contracts --------------------------------------------------------------------------||
    //-------------------------------------------------------------------------------------||
-    /**
-    * Imports provided {@link ZipInputStream} as a {@link Archive}.
-    * 
-    * @param stream the stream to import
-    * @return Archive of the imported Zip
-    * @throws ArchiveImportException if IOException during import
-    */
+   /**
+   * Imports provided {@link ZipInputStream} as a {@link Archive}.
+   * 
+   * @param stream the stream to import
+   * @return Archive of the imported Zip
+   * @throws ArchiveImportException If an error occured during the import process
+   */
    ZipImporter importZip(ZipInputStream stream) throws ArchiveImportException;
-   
+
    /**
     * Imports provided {@link ZipFile} as a {@link Archive}.
     * 
     * @param file the file to import
     * @return Archive of the imported Zip
-    * @throws ArchiveImportException if IOException during import
+    * @throws ArchiveImportException If an error occured during the import process
     */
    ZipImporter importZip(ZipFile file) throws ArchiveImportException;
 }