[jboss-cvs] JBossAS SVN: r90252 - projects/vfs/trunk/src/main/java/org/jboss/virtual/spi/zip.

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

Author: david.lloyd at jboss.com
Date: 2009-06-16 10:37:10 -0400 (Tue, 16 Jun 2009)
New Revision: 90252

Modified:
   projects/vfs/trunk/src/main/java/org/jboss/virtual/spi/zip/ZipFile.java
Log:
Javadocs for the ZipFile abstraction

Modified: projects/vfs/trunk/src/main/java/org/jboss/virtual/spi/zip/ZipFile.java
===================================================================
--- projects/vfs/trunk/src/main/java/org/jboss/virtual/spi/zip/ZipFile.java	2009-06-16 13:58:30 UTC (rev 90251)
+++ projects/vfs/trunk/src/main/java/org/jboss/virtual/spi/zip/ZipFile.java	2009-06-16 14:37:10 UTC (rev 90252)
@@ -32,9 +32,30 @@
  */
 public interface ZipFile
 {
+
+   /**
+    * Get the input stream for a specific entry.  The caller <b>must</b> close the input stream or
+    * file locking/cleanup issues may ensue.
+    *
+    * @param entry the zip entry
+    * @return the input stream
+    * @throws IOException if an I/O error occurs
+    */
    InputStream getInputStream(ZipEntry entry) throws IOException;
 
+   /**
+    * Close the zip file.  May or may not close any {@code InputStream}s associated with this zip file; to be
+    * safe, any outstanding {@code InputStream}s returned by {@link #getInputStream(ZipEntry)} must be closed
+    * explicitly.
+    *
+    * @throws IOException if an I/O error occurs
+    */
    void close() throws IOException;
 
+   /**
+    * Get an enumeration over all the entries.  May fail if the zip file has been closed.
+    *
+    * @return the enumeration
+    */
    Enumeration<? extends ZipEntry> entries();
 }
\ No newline at end of file