Author: grobmeier
Date: Wed Apr 22 05:03:30 2009
New Revision: 767369
URL: http://svn.apache.org/viewvc?rev=767369&view=rev
Log:
added javadocs
counts read bytes
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java?rev=767369&r1=767368&r2=767369&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
Wed Apr 22 05:03:30 2009
@@ -24,16 +24,30 @@
import org.apache.commons.compress.compressors.CompressorInputStream;
+/**
+ * Implements the "gz" compression format as an input stream.
+ * This classes wraps the standard java classes for working with gz.
+ */
public class GzipCompressorInputStream extends CompressorInputStream {
-
+ /* reference to the compressed stream */
private final GZIPInputStream in;
+ /**
+ * Constructs a new GZip compressed input stream by the referenced
+ * InputStream.
+ *
+ * @param inputStream the InputStream from which this object should be
created of
+ * @throws IOException if the stream could not be created
+ */
public GzipCompressorInputStream(InputStream inputStream) throws
IOException {
in = new GZIPInputStream(inputStream);
}
+ /* (non-Javadoc)
+ * @see java.io.InputStream#read()
+ */
public int read() throws IOException {
+ this.count(1);
return in.read();
}
-
}