[4/5] commons-compress git commit: COMPRESS-445 document ZipFile's new contract

[bo...@apache.org]

COMPRESS-445 document ZipFile's new contract


Project: http://git-wip-us.apache.org/repos/asf/commons-compress/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-compress/commit/0db4e9a6
Tree: http://git-wip-us.apache.org/repos/asf/commons-compress/tree/0db4e9a6
Diff: http://git-wip-us.apache.org/repos/asf/commons-compress/diff/0db4e9a6

Branch: refs/heads/master
Commit: 0db4e9a63319f9fab2d347181533c127977f59fb
Parents: 74abd5b
Author: Stefan Bodewig <bo...@apache.org>
Authored: Sun Apr 22 20:09:16 2018 +0200
Committer: Stefan Bodewig <bo...@apache.org>
Committed: Sun Apr 22 20:09:16 2018 +0200

----------------------------------------------------------------------
 .../java/org/apache/commons/compress/archivers/zip/ZipFile.java   | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-compress/blob/0db4e9a6/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
index 868f581..5e7cfa0 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
@@ -469,7 +469,8 @@ public class ZipFile implements Closeable {
      * Returns an InputStream for reading the contents of the given entry.
      *
      * @param ze the entry to get the stream for.
-     * @return a stream to read the entry from.
+     * @return a stream to read the entry from. The returned stream
+     * implements {@link InputStreamStatistics}.
      * @throws IOException if unable to create an input stream from the zipentry
      */
     public InputStream getInputStream(final ZipArchiveEntry ze)