com.ning.compress.lzf

Class LZFCompressingInputStream

java.lang.Object

java.io.InputStream

com.ning.compress.lzf.LZFCompressingInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class LZFCompressingInputStream
extends InputStream

Decorator InputStream implementation used for reading uncompressed data and compressing it on the fly, such that reads return compressed data. It is reverse of LZFInputStream (which instead uncompresses data).

Author:

Tatu Saloranta

See Also:

LZFInputStream

Field Summary

Fields

Modifier and Type	Field and Description
protected int	_bufferLength Length of the current uncompressed bytes buffer
protected int	_bufferPosition The current position (next char to output) in the uncompressed bytes buffer.
protected boolean	_cfgFullReads Flag that indicates whether we force full reads (reading of as many bytes as requested), or 'optimal' reads (up to as many as available, but at least one).
protected byte[]	_encodedBytes Buffer that contains compressed data that is returned to readers.
protected byte[]	_inputBuffer Buffer in which uncompressed input is first read, before getting encoded in _encodedBytes.
protected InputStream	_inputStream Stream used for reading data to be compressed
protected boolean	_inputStreamClosed Flag that indicates if we have already called 'inputStream.close()' (to avoid calling it multiple times)
protected int	_readCount Number of bytes read from the underlying _inputStream

Constructor Summary

Constructors

Constructor and Description
LZFCompressingInputStream(ChunkEncoder encoder, InputStream in)
LZFCompressingInputStream(ChunkEncoder encoder, InputStream in, BufferRecycler bufferRecycler)
LZFCompressingInputStream(InputStream in)

Method Summary

Methods

Modifier and Type	Method and Description
int	available()
void	close()
int	read()
int	read(byte[] buffer)
int	read(byte[] buffer, int offset, int length)
protected boolean	readyBuffer() Fill the uncompressed bytes buffer by reading the underlying inputStream.
void	setUseFullReads(boolean b) Method that can be used define whether reads should be "full" or "optimal": former means that full compressed blocks are read right away as needed, optimal that only smaller chunks are read at a time, more being read as needed.
long	skip(long n) Overridden to just skip at most a single chunk at a time

Methods inherited from class java.io.InputStream

mark, markSupported, reset

Methods inherited from class java.lang.Object

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

Field Detail

_inputStream

protected final InputStream _inputStream

Stream used for reading data to be compressed

_inputStreamClosed

protected boolean _inputStreamClosed

Flag that indicates if we have already called 'inputStream.close()' (to avoid calling it multiple times)

_cfgFullReads

protected boolean _cfgFullReads

Flag that indicates whether we force full reads (reading of as many bytes as requested), or 'optimal' reads (up to as many as available, but at least one). Default is false, meaning that 'optimal' read is used.

_inputBuffer

protected byte[] _inputBuffer

Buffer in which uncompressed input is first read, before getting encoded in _encodedBytes.

_encodedBytes

protected byte[] _encodedBytes

Buffer that contains compressed data that is returned to readers.

_bufferPosition

protected int _bufferPosition

The current position (next char to output) in the uncompressed bytes buffer.

_bufferLength

protected int _bufferLength

Length of the current uncompressed bytes buffer

_readCount

protected int _readCount

Number of bytes read from the underlying _inputStream

Constructor Detail

LZFCompressingInputStream

public LZFCompressingInputStream(InputStream in)

LZFCompressingInputStream

public LZFCompressingInputStream(ChunkEncoder encoder,
                         InputStream in)

LZFCompressingInputStream

public LZFCompressingInputStream(ChunkEncoder encoder,
                         InputStream in,
                         BufferRecycler bufferRecycler)

Method Detail

setUseFullReads

public void setUseFullReads(boolean b)

Method that can be used define whether reads should be "full" or "optimal": former means that full compressed blocks are read right away as needed, optimal that only smaller chunks are read at a time, more being read as needed.

available

public int available()

Overrides:

available in class InputStream

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] buffer)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

public int read(byte[] buffer,
       int offset,
       int length)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overridden to just skip at most a single chunk at a time

Overrides:

skip in class InputStream

Throws:

IOException

readyBuffer

protected boolean readyBuffer()
                       throws IOException

Fill the uncompressed bytes buffer by reading the underlying inputStream.

Throws:

IOException