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

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

Author: ALRubinger
Date: 2010-05-28 19:57:22 -0400 (Fri, 28 May 2010)
New Revision: 4452

Modified:
   shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/importer/ZipImporter.java
Log:
[SHRINKWRAP-177] Document that users must close the ZipInputStream

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-05-28 23:55:48 UTC (rev 4451)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/importer/ZipImporter.java	2010-05-28 23:57:22 UTC (rev 4452)
@@ -34,7 +34,8 @@
    // Contracts --------------------------------------------------------------------------||
    //-------------------------------------------------------------------------------------||
    /**
-   * Imports provided {@link ZipInputStream} as a {@link Archive}.
+   * Imports provided {@link ZipInputStream} as a {@link Archive}.  It remains
+   * the responsibility of the caller to close the {@link ZipInputStream}.
    * 
    * @param stream the stream to import
    * @return Archive of the imported Zip