big-data/hadoop
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

HADOOP-7981. Improve documentation for org.apache.hadoop.io.compress.Decompressor.getRemaining (Jonathan Eagles via mahadev)

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/hadoop/common/trunk@1235007 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Mahadev Konar 2012-01-23 21:44:49 +00:00
parent 4b36997b1b
commit f07d91a1fc
2 changed files with 21 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
hadoop-common-project/hadoop-common/CHANGES.txt
View File

@ -285,6 +285,9 @@ Release 0.23.1 - Unreleased
HADOOP-7986. Adding config for MapReduce History Server protocol in HADOOP-7986. Adding config for MapReduce History Server protocol in
hadoop-policy.xml for service level authorization. (Mahadev Konar via vinodkv) hadoop-policy.xml for service level authorization. (Mahadev Konar via vinodkv)
HADOOP-7981. Improve documentation for org.apache.hadoop.io.compress.
Decompressor.getRemaining (Jonathan Eagles via mahadev)
Release 0.23.0 - 2011-11-01 Release 0.23.0 - 2011-11-01
INCOMPATIBLE CHANGES INCOMPATIBLE CHANGES

25
hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/compress/Decompressor.java
View File

@ -49,7 +49,7 @@ public interface Decompressor {
public void setInput(byte[] b, int off, int len); public void setInput(byte[] b, int off, int len);
/** /**
* Returns true if the input data buffer is empty and * Returns <code>true</code> if the input data buffer is empty and
* {@link #setInput(byte[], int, int)} should be called to * {@link #setInput(byte[], int, int)} should be called to
* provide more input. * provide more input.
* *
@ -76,8 +76,11 @@ public interface Decompressor {
public boolean needsDictionary(); public boolean needsDictionary();
/** /**
* Returns true if the end of the decompressed * Returns <code>true</code> if the end of the decompressed
* data output stream has been reached. * data output stream has been reached. Indicates a concatenated data stream
* when finished() returns <code>true</code> and {@link #getRemaining()}
* returns a positive value. finished() will be reset with the
* {@link #reset()} method.
* @return <code>true</code> if the end of the decompressed * @return <code>true</code> if the end of the decompressed
* data output stream has been reached. * data output stream has been reached.
*/ */
@ -98,15 +101,23 @@ public interface Decompressor {
public int decompress(byte[] b, int off, int len) throws IOException; public int decompress(byte[] b, int off, int len) throws IOException;
/** /**
* Returns the number of bytes remaining in the compressed-data buffer; * Returns the number of bytes remaining in the compressed data buffer.
* typically called after the decompressor has finished decompressing * Indicates a concatenated data stream if {@link #finished()} returns
* the current gzip stream (a.k.a. "member"). * <code>true</code> and getRemaining() returns a positive value. If
* {@link #finished()} returns <code>true</code> and getRemaining() returns
* a zero value, indicates that the end of data stream has been reached and
* is not a concatenated data stream.
* @return The number of bytes remaining in the compressed data buffer.
*/ */
public int getRemaining(); public int getRemaining();
/** /**
* Resets decompressor and input and output buffers so that a new set of * Resets decompressor and input and output buffers so that a new set of
* input data can be processed. * input data can be processed. If {@link #finished()}} returns
* <code>true</code> and {@link #getRemaining()} returns a positive value,
* reset() is called before processing of the next data stream in the
* concatenated data stream. {@link #finished()} will be reset and will
* return <code>false</code> when reset() is called.
*/ */
public void reset(); public void reset();