Author: bodewig
Date: Mon Oct 24 04:40:45 2011
New Revision: 1188023
URL: http://svn.apache.org/viewvc?rev=1188023&view=rev
Log:
Pack200CompressorInputStream's getBytesRead method always returns 0
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/pack200/Pack200CompressorInputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/pack200/package.html
commons/proper/compress/trunk/src/site/xdoc/pack200.xml
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/pack200/Pack200CompressorInputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/pack200/Pack200CompressorInputStream.java?rev=1188023&r1=1188022&r2=1188023&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/pack200/Pack200CompressorInputStream.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/pack200/Pack200CompressorInputStream.java
Mon Oct 24 04:40:45 2011
@@ -33,6 +33,10 @@ import org.apache.commons.compress.compr
* An input stream that decompresses from the Pack200 format to be read
* as any other stream.
*
+ * <p>The {@link CompressorInputStream#getCount getCount} and {@link
+ * CompressorInputStream#getBytesRead getBytesRead} methods always
+ * return 0.</p>
+ *
* @NotThreadSafe
* @since Apache Commons Compress 1.3
*/
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/pack200/package.html
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/pack200/package.html?rev=1188023&r1=1188022&r2=1188023&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/pack200/package.html
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/pack200/package.html
Mon Oct 24 04:40:45 2011
@@ -60,6 +60,12 @@
in memory but you should switch to the temporary file option if
your archives are really big.</p>
+ <p>Given there always is an intermediate result
+ the <code>getBytesRead</code> and <code>getCount</code> methods
+ of <code>Pack200CompressorInputStream</code> are meaningless
+ (read from the real stream or from the intermediate result?)
+ and always return 0.</p>
+
<p>During development of the initial version several attempts have
been made to use a real streaming API based for example
on <code>Piped(In|Out)putStream</code> or explicit stream
Modified: commons/proper/compress/trunk/src/site/xdoc/pack200.xml
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/site/xdoc/pack200.xml?rev=1188023&r1=1188022&r2=1188023&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/site/xdoc/pack200.xml (original)
+++ commons/proper/compress/trunk/src/site/xdoc/pack200.xml Mon Oct 24 04:40:45
2011
@@ -45,11 +45,11 @@
<p>The Pack200-API provided by the java class library is not
streaming friendly as it wants to consume its input completely
in a single operation. Because of this
- <code>Pack200InputStream</code>'s constructor will immediately
+ <code>Pack200CompressorInputStream</code>'s constructor will
immediately
unpack the stream, cache the results and provide an input
stream to the cache.</p>
- <p><code>Pack200OutputStream</code> will cache all data that
+ <p><code>Pack200CompressorOutputStream</code> will cache all data that
is written to it and then pack it once the <code>finish</code>
or <code>close</code> method is called.</p>
@@ -58,6 +58,12 @@
is cached in memory but you should switch to the temporary
file option if your archives are really big.</p>
+ <p>Given there always is an intermediate result
+ the <code>getBytesRead</code> and <code>getCount</code>
+ methods of <code>Pack200CompressorInputStream</code> are
+ meaningless (read from the real stream or from the
+ intermediate result?) and always return 0.</p>
+
</subsection>
<subsection name="Normalization">
@@ -80,4 +86,4 @@
</section>
</body>
-</document>
\ No newline at end of file
+</document>
