You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by bo...@apache.org on 2018/04/22 16:21:37 UTC

[2/3] commons-compress git commit: COMPRESS-445 cosmetics

COMPRESS-445 cosmetics


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

Branch: refs/heads/master
Commit: 22c79b2f6abf6fbe7292e097dfb1edfaf8584613
Parents: 02c963a
Author: Stefan Bodewig <bo...@apache.org>
Authored: Sun Apr 22 18:20:10 2018 +0200
Committer: Stefan Bodewig <bo...@apache.org>
Committed: Sun Apr 22 18:20:10 2018 +0200

----------------------------------------------------------------------
 .../compress/archivers/zip/ExplodingInputStream.java |  6 ++++++
 .../compress/archivers/zip/InflaterInputStream.java  |  2 ++
 .../bzip2/BZip2CompressorInputStream.java            |  8 +++++++-
 .../deflate64/Deflate64CompressorInputStream.java    |  6 ++++++
 .../compressors/deflate64/HuffmanDecoder.java        |  5 ++++-
 .../compress/compressors/lzw/LZWInputStream.java     |  8 ++++++++
 .../commons/compress/utils/BitInputStream.java       | 15 +++++++++++----
 .../compress/utils/InputStreamStatistics.java        |  2 ++
 .../commons/compress/archivers/ZipTestCase.java      |  7 ++++++-
 9 files changed, 52 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-compress/blob/22c79b2f/src/main/java/org/apache/commons/compress/archivers/zip/ExplodingInputStream.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ExplodingInputStream.java b/src/main/java/org/apache/commons/compress/archivers/zip/ExplodingInputStream.java
index 71e4cb9..bea9e4c 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ExplodingInputStream.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ExplodingInputStream.java
@@ -119,11 +119,17 @@ class ExplodingInputStream extends InputStream implements InputStreamStatistics
         return ret;
     }
 
+    /**
+     * @since 1.17
+     */
     @Override
     public long getCompressedCount() {
         return bits.getBytesRead();
     }
 
+    /**
+     * @since 1.17
+     */
     @Override
     public long getUncompressedCount() {
         return uncompressedCount;

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/22c79b2f/src/main/java/org/apache/commons/compress/archivers/zip/InflaterInputStream.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/InflaterInputStream.java b/src/main/java/org/apache/commons/compress/archivers/zip/InflaterInputStream.java
index 1213a1b..32d20e3 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/InflaterInputStream.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/InflaterInputStream.java
@@ -26,6 +26,8 @@ import java.util.zip.Inflater;
 
 /**
  * Helper class to provide statistics
+ *
+ * @since 1.17
  */
 /* package */ class InflaterInputStream extends java.util.zip.InflaterInputStream
     implements InputStreamStatistics {

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/22c79b2f/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java b/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java
index d82713e..54457cf 100644
--- a/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java
+++ b/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java
@@ -40,7 +40,7 @@ import org.apache.commons.compress.utils.InputStreamStatistics;
  * @NotThreadSafe
  */
 public class BZip2CompressorInputStream extends CompressorInputStream
-implements BZip2Constants, InputStreamStatistics {
+    implements BZip2Constants, InputStreamStatistics {
 
     /**
      * Index of the last char in the block, so the block size == last + 1.
@@ -182,11 +182,17 @@ implements BZip2Constants, InputStreamStatistics {
         return (destOffs == offs) ? -1 : (destOffs - offs);
     }
 
+    /**
+     * @since 1.17
+     */
     @Override
     public long getCompressedCount() {
         return bin.getBytesRead();
     }
 
+    /**
+     * @since 1.17
+     */
     @Override
     public long getUncompressedCount() {
         return getBytesRead();

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/22c79b2f/src/main/java/org/apache/commons/compress/compressors/deflate64/Deflate64CompressorInputStream.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/compressors/deflate64/Deflate64CompressorInputStream.java b/src/main/java/org/apache/commons/compress/compressors/deflate64/Deflate64CompressorInputStream.java
index 02dc4f3..36b8a83 100644
--- a/src/main/java/org/apache/commons/compress/compressors/deflate64/Deflate64CompressorInputStream.java
+++ b/src/main/java/org/apache/commons/compress/compressors/deflate64/Deflate64CompressorInputStream.java
@@ -100,11 +100,17 @@ public class Deflate64CompressorInputStream extends CompressorInputStream implem
         }
     }
 
+    /**
+     * @since 1.17
+     */
     @Override
     public long getCompressedCount() {
         return decoder.getBytesRead();
     }
 
+    /**
+     * @since 1.17
+     */
     @Override
     public long getUncompressedCount() {
         return getBytesRead();

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/22c79b2f/src/main/java/org/apache/commons/compress/compressors/deflate64/HuffmanDecoder.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/compressors/deflate64/HuffmanDecoder.java b/src/main/java/org/apache/commons/compress/compressors/deflate64/HuffmanDecoder.java
index 1cc0c81..a6afa2c 100644
--- a/src/main/java/org/apache/commons/compress/compressors/deflate64/HuffmanDecoder.java
+++ b/src/main/java/org/apache/commons/compress/compressors/deflate64/HuffmanDecoder.java
@@ -155,7 +155,10 @@ class HuffmanDecoder implements Closeable {
         return -1;
     }
 
-    public long getBytesRead() {
+    /**
+     * @since 1.17
+     */
+    long getBytesRead() {
         return reader.getBytesRead();
     }
 

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/22c79b2f/src/main/java/org/apache/commons/compress/compressors/lzw/LZWInputStream.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/compressors/lzw/LZWInputStream.java b/src/main/java/org/apache/commons/compress/compressors/lzw/LZWInputStream.java
index 1ada577..9cdf680 100644
--- a/src/main/java/org/apache/commons/compress/compressors/lzw/LZWInputStream.java
+++ b/src/main/java/org/apache/commons/compress/compressors/lzw/LZWInputStream.java
@@ -88,10 +88,18 @@ public abstract class LZWInputStream extends CompressorInputStream implements In
         return bytesRead;
     }
 
+    /**
+     * @since 1.17
+     */
+    @Override
     public long getCompressedCount() {
         return in.getBytesRead();
     }
 
+    /**
+     * @since 1.17
+     */
+    @Override
     public long getUncompressedCount() {
         return getBytesRead();
     }

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/22c79b2f/src/main/java/org/apache/commons/compress/utils/BitInputStream.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/utils/BitInputStream.java b/src/main/java/org/apache/commons/compress/utils/BitInputStream.java
index 41c7449..124e21f 100644
--- a/src/main/java/org/apache/commons/compress/utils/BitInputStream.java
+++ b/src/main/java/org/apache/commons/compress/utils/BitInputStream.java
@@ -125,6 +125,17 @@ public class BitInputStream implements Closeable {
         }
     }
 
+    /**
+     * Returns the number of bytes read from the underlying stream.
+     *
+     * <p>This includes the bytes read to fill the current cache and
+     * not read as bits so far.</p>
+     * @since 1.17
+     */
+    public long getBytesRead() {
+        return in.getBytesRead();
+    }
+
     private long processBitsGreater57(final int count) throws IOException {
         final long bitsOut;
         int overflowBits = 0;
@@ -188,8 +199,4 @@ public class BitInputStream implements Closeable {
         return false;
     }
 
-
-    public long getBytesRead() {
-        return in.getBytesRead();
-    }
 }

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/22c79b2f/src/main/java/org/apache/commons/compress/utils/InputStreamStatistics.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/utils/InputStreamStatistics.java b/src/main/java/org/apache/commons/compress/utils/InputStreamStatistics.java
index 26baad5..b53e6f5 100644
--- a/src/main/java/org/apache/commons/compress/utils/InputStreamStatistics.java
+++ b/src/main/java/org/apache/commons/compress/utils/InputStreamStatistics.java
@@ -22,6 +22,8 @@ package org.apache.commons.compress.utils;
  * This interface provides statistics on the current decompression stream.
  * The stream consumer can use that statistics to handle abnormal
  * compression ratios, i.e. to prevent zip bombs.
+ *
+ * @since 1.17
  */
 public interface InputStreamStatistics {
     /**

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/22c79b2f/src/test/java/org/apache/commons/compress/archivers/ZipTestCase.java
----------------------------------------------------------------------
diff --git a/src/test/java/org/apache/commons/compress/archivers/ZipTestCase.java b/src/test/java/org/apache/commons/compress/archivers/ZipTestCase.java
index 4265cbc..4451a07 100644
--- a/src/test/java/org/apache/commons/compress/archivers/ZipTestCase.java
+++ b/src/test/java/org/apache/commons/compress/archivers/ZipTestCase.java
@@ -27,7 +27,12 @@ import java.io.FileOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Enumeration;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipException;