svn commit: r760392 - /commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java

[se...@apache.org]

Author: sebb
Date: Tue Mar 31 10:36:25 2009
New Revision: 760392

URL: http://svn.apache.org/viewvc?rev=760392&view=rev
Log:
Javadoc

Modified:
    commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java

Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java?rev=760392&r1=760391&r2=760392&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java Tue Mar 31 10:36:25 2009
@@ -31,7 +31,14 @@
 import org.apache.commons.compress.archivers.ArchiveInputStream;
 
 /**
- * Implements and input stream that can read Zip archives.
+ * Implements an input stream that can read Zip archives.
+ * <p>
+ * Note that {@link ZipArchiveEntry#getSize()} may return -1 if the DEFLATE algorithm is used, as the size information
+ * is not available from the header.
+ * <p>
+ * The {@link ZipFile} class is preferred when reading from files.
+ *  
+ * @see ZipFile
  * @NotThreadSafe
  */
 public class ZipArchiveInputStream extends ArchiveInputStream {