From 69e5760b3700e34dc1cf4011a451e92abddeb664 Mon Sep 17 00:00:00 2001 From: zzz Date: Tue, 13 Dec 2011 18:56:44 +0000 Subject: [PATCH] javadoc clarifications --- core/java/src/net/i2p/util/ReusableGZIPInputStream.java | 5 ++--- core/java/src/net/i2p/util/ReusableGZIPOutputStream.java | 7 +++++-- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/core/java/src/net/i2p/util/ReusableGZIPInputStream.java b/core/java/src/net/i2p/util/ReusableGZIPInputStream.java index beb7d3484..abb200ecf 100644 --- a/core/java/src/net/i2p/util/ReusableGZIPInputStream.java +++ b/core/java/src/net/i2p/util/ReusableGZIPInputStream.java @@ -9,9 +9,8 @@ import java.util.concurrent.LinkedBlockingQueue; import net.i2p.data.DataHelper; /** - * Provide a cache of reusable GZIP streams, each handling up to 32KB without - * expansion. - * + * Provide a cache of reusable GZIP unzipper streams. + * This provides stream output only, and therefore can handle unlimited size. */ public class ReusableGZIPInputStream extends ResettableGZIPInputStream { // Apache Harmony 5.0M13 Deflater doesn't work after reset() diff --git a/core/java/src/net/i2p/util/ReusableGZIPOutputStream.java b/core/java/src/net/i2p/util/ReusableGZIPOutputStream.java index 0f82a47de..f4777b095 100644 --- a/core/java/src/net/i2p/util/ReusableGZIPOutputStream.java +++ b/core/java/src/net/i2p/util/ReusableGZIPOutputStream.java @@ -14,6 +14,9 @@ import net.i2p.data.DataHelper; * * This compresses to memory only. Retrieve the compressed data with getData(). * There is no facility to compress to an output stream. + * + * Do NOT use this for compression of unlimited-size data, as it will + * expand, but never release, the BAOS memory buffer. */ public class ReusableGZIPOutputStream extends ResettableGZIPOutputStream { // Apache Harmony 5.0M13 Deflater doesn't work after reset() @@ -51,10 +54,10 @@ public class ReusableGZIPOutputStream extends ResettableGZIPOutputStream { _available.offer(out); } - private ByteArrayOutputStream _buffer = null; + private final ByteArrayOutputStream _buffer; private ReusableGZIPOutputStream() { - super(new ByteArrayOutputStream(40*1024)); + super(new ByteArrayOutputStream(DataHelper.MAX_UNCOMPRESSED)); _buffer = (ByteArrayOutputStream)out; }