Package org.apache.hadoop.io.compress.zlib

Class BuiltInGzipCompressor

java.lang.Object

org.apache.hadoop.io.compress.zlib.BuiltInGzipCompressor

All Implemented Interfaces:

Compressor

@DoNotPool
public class BuiltInGzipCompressor
extends java.lang.Object
implements Compressor

A Compressor based on the popular gzip compressed file format. http://www.gzip.org/

Constructor Summary

Constructors

Constructor	Description
BuiltInGzipCompressor(Configuration conf)

Method Summary

Modifier and Type	Method	Description
int	compress(byte[] b, int off, int len)	Fills specified buffer with compressed data.
void	end()	Closes the compressor and discards any unprocessed input.
void	finish()	When called, indicates that compression should end with the current contents of the input buffer.
boolean	finished()	Returns true if the end of the compressed data output stream has been reached.
long	getBytesRead()	Return number of uncompressed bytes input so far.
long	getBytesWritten()	Return number of compressed bytes output so far.
boolean	needsInput()	Returns true if the input data buffer is empty and #setInput() should be called to provide more input.
void	reinit(Configuration conf)	Prepare the compressor to be used in a new stream with settings defined in the given Configuration
void	reset()	Resets compressor so that a new set of input data can be processed.
void	setDictionary(byte[] b, int off, int len)	Sets preset dictionary for compression.
void	setInput(byte[] b, int off, int len)	Sets input data for compression.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BuiltInGzipCompressor

public BuiltInGzipCompressor(Configuration conf)

Method Detail

finished

public boolean finished()

Description copied from interface: Compressor

Returns true if the end of the compressed data output stream has been reached.

Specified by:

finished in interface Compressor

Returns:

true if the end of the compressed data output stream has been reached.

needsInput

public boolean needsInput()

Description copied from interface: Compressor

Returns true if the input data buffer is empty and #setInput() should be called to provide more input.

Specified by:

needsInput in interface Compressor

Returns:

true if the input data buffer is empty and #setInput() should be called in order to provide more input.

compress

public int compress(byte[] b,
                    int off,
                    int len)
             throws java.io.IOException

Description copied from interface: Compressor

Fills specified buffer with compressed data. Returns actual number of bytes of compressed data. A return value of 0 indicates that needsInput() should be called in order to determine if more input data is required.

Specified by:

compress in interface Compressor

Parameters:

b - Buffer for the compressed data

off - Start offset of the data

len - Size of the buffer

Returns:

The actual number of bytes of compressed data.

Throws:

java.io.IOException - raised on errors performing I/O.

getBytesRead

public long getBytesRead()

Description copied from interface: Compressor

Return number of uncompressed bytes input so far.

Specified by:

getBytesRead in interface Compressor

Returns:

bytes read.

getBytesWritten

public long getBytesWritten()

Description copied from interface: Compressor

Return number of compressed bytes output so far.

Specified by:

getBytesWritten in interface Compressor

Returns:

bytes written.

end

public void end()

Description copied from interface: Compressor

Closes the compressor and discards any unprocessed input.

Specified by:

end in interface Compressor

finish

public void finish()

Description copied from interface: Compressor

When called, indicates that compression should end with the current contents of the input buffer.

Specified by:

finish in interface Compressor

reinit

public void reinit(Configuration conf)

Description copied from interface: Compressor

Prepare the compressor to be used in a new stream with settings defined in the given Configuration

Specified by:

reinit in interface Compressor

Parameters:

conf - Configuration from which new setting are fetched

reset

public void reset()

Description copied from interface: Compressor

Resets compressor so that a new set of input data can be processed.

Specified by:

reset in interface Compressor

setDictionary

public void setDictionary(byte[] b,
                          int off,
                          int len)

Description copied from interface: Compressor

Sets preset dictionary for compression. A preset dictionary is used when the history buffer can be predetermined.

Specified by:

setDictionary in interface Compressor

Parameters:

b - Dictionary data bytes

off - Start offset

len - Length

setInput

public void setInput(byte[] b,
                     int off,
                     int len)

Description copied from interface: Compressor

Sets input data for compression. This should be called whenever #needsInput() returns true indicating that more input data is required.

Specified by:

setInput in interface Compressor

Parameters:

b - Input data

off - Start offset

len - Length