Compress-LZF 1.1.2 · com.ning.compress.lzf.LZFInputStream

Field Summary

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[]	_decodedBytes the buffer of uncompressed bytes from which content is read
protected final ChunkDecoder	_decoder Underlying decoder in use.
protected byte[]	_inputBuffer the current buffer of compressed bytes (from which to decode)
protected final InputStream	_inputStream stream to be decompressed
protected boolean	_inputStreamClosed Flag that indicates if we have already called 'inputStream.close()' (to avoid calling it multiple times)
protected final BufferRecycler	_recycler Object that handles details of buffer recycling

Constructor Summary

Access	Constructor and Description
public	LZFInputStream(final InputStream inputStream)
public	LZFInputStream(final ChunkDecoder decoder, final InputStream in)
public	LZFInputStream(final InputStream Underlying input stream to use in, boolean Whether `read(byte[])` should try to read exactly as many bytes as requested (true); or just however many happen to be available (false) fullReads)
public	LZFInputStream(final ChunkDecoder decoder, final InputStream in, boolean fullReads)
public	LZFInputStream(final InputStream inputStream, final BufferRecycler bufferRecycler)
public	LZFInputStream(final InputStream Underlying input stream to use in, final BufferRecycler Buffer recycler instance, for usages where the caller manages the recycler instances bufferRecycler, boolean Whether `read(byte[])` should try to read exactly as many bytes as requested (true); or just however many happen to be available (false) fullReads)
public	LZFInputStream(final ChunkDecoder decoder, final InputStream in, final BufferRecycler bufferRecycler, boolean fullReads)

Method Summary

Modifier and Type	Method and Description
public int	available() Overrides java.io.InputStream.available. Method is overridden to report number of bytes that can now be read from decoded data buffer, without reading bytes from the underlying stream.
public void	close() Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Closes this input stream and releases any system resources associated with the stream.
public void	discardBuffered() Method that can be called to discard any already buffered input, read from input source.
public InputStream	getUnderlyingInputStream() Method that can be used to find underlying `InputStream` that we read from to get LZF encoded data to decode.
public int	read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.
public int	read(final byte[] the buffer into which the data is read. buffer) Overrides java.io.InputStream.read. Reads some number of bytes from the input stream and stores them into the buffer array `b`.
public int	read(final byte[] the buffer into which the data is read. buffer, int the start offset in array `b` at which the data is written. offset, int the maximum number of bytes to read. length) Overrides java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes.
public int	Returns: Number of bytes written (uncompressed) readAndWrite(OutputStream OutputStream to use for writing content out) Convenience method that will read and uncompress all data available, and write it using given `OutputStream`.
protected boolean	Returns: True if there is now at least one byte to read in the buffer; false if there is no more content to read readyBuffer() Fill the uncompressed bytes buffer by reading the underlying inputStream.
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.
public long	skip(long the number of bytes to be skipped. n) Overrides java.io.InputStream.skip. Overridden to implement efficient skipping by skipping full chunks whenever possible.

Inherited from java.io.InputStream:: mark markSupported nullInputStream readAllBytes readNBytes readNBytes reset skipNBytes transferTo

Field Detail

_bufferLength	back to summary
protected int _bufferLength Length of the current uncompressed bytes buffer

_bufferPosition	back to summary
protected int _bufferPosition The current position (next char to output) in the uncompressed bytes buffer.

_cfgFullReads	back to summary
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.

_decodedBytes	back to summary
protected byte[] _decodedBytes the buffer of uncompressed bytes from which content is read

_decoder	back to summary
protected final ChunkDecoder _decoder Underlying decoder in use.

_inputBuffer	back to summary
protected byte[] _inputBuffer the current buffer of compressed bytes (from which to decode)

_inputStream	back to summary
protected final InputStream _inputStream stream to be decompressed

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

_recycler	back to summary
protected final BufferRecycler _recycler Object that handles details of buffer recycling

Constructor Detail

LZFInputStream	back to summary
public LZFInputStream(final InputStream inputStream) throws IOException

LZFInputStream	back to summary
public LZFInputStream(final ChunkDecoder decoder, final InputStream in) throws IOException

LZFInputStream	back to summary
public LZFInputStream(final InputStream in, boolean fullReads) throws IOException Parameters in:InputStream Underlying input stream to use fullReads:boolean Whether `read(byte[])` should try to read exactly as many bytes as requested (true); or just however many happen to be available (false)

LZFInputStream	back to summary
public LZFInputStream(final ChunkDecoder decoder, final InputStream in, boolean fullReads) throws IOException

LZFInputStream	back to summary
public LZFInputStream(final InputStream inputStream, final BufferRecycler bufferRecycler) throws IOException

LZFInputStream back to summary

LZFInputStream	back to summary
public LZFInputStream(final InputStream in, final BufferRecycler bufferRecycler, boolean fullReads) throws IOException Parameters in:InputStream Underlying input stream to use bufferRecycler:BufferRecycler Buffer recycler instance, for usages where the caller manages the recycler instances fullReads:boolean Whether `read(byte[])` should try to read exactly as many bytes as requested (true); or just however many happen to be available (false)

public LZFInputStream(final InputStream in, final BufferRecycler bufferRecycler, boolean fullReads) throws IOException

Parameters

in:InputStream: Underlying input stream to use
bufferRecycler:BufferRecycler: Buffer recycler instance, for usages where the caller manages the recycler instances
fullReads:boolean: Whether read(byte[]) should try to read exactly as many bytes as requested (true); or just however many happen to be available (false)

LZFInputStream	back to summary
public LZFInputStream(final ChunkDecoder decoder, final InputStream in, final BufferRecycler bufferRecycler, boolean fullReads) throws IOException

Method Detail

available back to summary

available	back to summary
public int available() Overrides java.io.InputStream.available. Method is overridden to report number of bytes that can now be read from decoded data buffer, without reading bytes from the underlying stream. Never throws an exception; returns number of bytes available without further reads from underlying source; -1 if stream has been closed, or 0 if an actual read (and possible blocking) is needed to find out. Returns:int Doc from java.io.InputStream.available. an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or `0` when it reaches the end of the input stream. Annotations @Override

public int available()

Overrides java.io.InputStream.available.

Method is overridden to report number of bytes that can now be read from decoded data buffer, without reading bytes from the underlying stream. Never throws an exception; returns number of bytes available without further reads from underlying source; -1 if stream has been closed, or 0 if an actual read (and possible blocking) is needed to find out.

Returns:int

Doc from java.io.InputStream.available.

an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or 0 when it reaches the end of the input stream.

Annotations

@Override

close	back to summary
public void close() throws IOException Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Doc from java.io.InputStream.close. Closes this input stream and releases any system resources associated with the stream. Annotations @Override Exceptions IOException: if an I/O error occurs.

back to summary

public void close() throws IOException

Overrides java.io.InputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.InputStream.close.

Closes this input stream and releases any system resources associated with the stream.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

discardBuffered	back to summary
public void discardBuffered() Method that can be called to discard any already buffered input, read from input source. Specialized method that only makes sense if the underlying `InputStream` can be repositioned reliably.

getUnderlyingInputStream	back to summary
public InputStream getUnderlyingInputStream() Method that can be used to find underlying `InputStream` that we read from to get LZF encoded data to decode. Will never return null; although underlying stream may be closed (if this stream has been closed).

read back to summary

read	back to summary
public int read() throws IOException Implements abstract java.io.InputStream.read. Doc from java.io.InputStream.read. Reads the next byte of data from the input stream. The value byte is returned as an `int` in the range `0` to `255`. If no byte is available because the end of the stream has been reached, the value `-1` is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. Returns:int the next byte of data, or `-1` if the end of the stream is reached. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(final byte[] buffer) throws IOException Overrides java.io.InputStream.read. Doc from java.io.InputStream.read. Reads some number of bytes from the input stream and stores them into the buffer array `b`. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown. If the length of `b` is zero, then no bytes are read and `0` is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at the end of the file, the value `-1` is returned; otherwise, at least one byte is read and stored into `b`. The first byte read is stored into element `b[0]`, the next one into `b[1]`, and so on. The number of bytes read is, at most, equal to the length of `b`. Let k be the number of bytes actually read; these bytes will be stored in elements `b[0]` through `b[`k`-1]`, leaving elements `b[`k`]` through `b[b.length-1]` unaffected. Parameters buffer:byte[] the buffer into which the data is read. Returns:int the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the stream has been reached. Annotations @Override Exceptions IOException: If the first byte cannot be read for any reason other than the end of the file, if the input stream has been closed, or if some other I/O error occurs.

public int read(final byte[] buffer) throws IOException

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads some number of bytes from the input stream and stores them into the buffer array b. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown.

If the length of b is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at the end of the file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[0], the next one into b[1], and so on. The number of bytes read is, at most, equal to the length of b. Let k be the number of bytes actually read; these bytes will be stored in elements b[0] through b[k-1], leaving elements b[k] through b[b.length-1] unaffected.

Parameters

buffer:byte[]: the buffer into which the data is read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Annotations

@Override

Exceptions

IOException:: If the first byte cannot be read for any reason other than the end of the file, if the input stream has been closed, or if some other I/O error occurs.

read back to summary

read	back to summary
public int read(final byte[] buffer, int offset, int length) throws IOException Overrides java.io.InputStream.read. Doc from java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes. An attempt is made to read as many as `len` bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown. If `len` is zero, then no bytes are read and `0` is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value `-1` is returned; otherwise, at least one byte is read and stored into `b`. The first byte read is stored into element `b[off]`, the next one into `b[off+1]`, and so on. The number of bytes read is, at most, equal to `len`. Let k be the number of bytes actually read; these bytes will be stored in elements `b[off]` through `b[off+`k`-1]`, leaving elements `b[off+`k`]` through `b[off+len-1]` unaffected. In every case, elements `b[0]` through `b[off-1]` and elements `b[off+len]` through `b[b.length-1]` are unaffected. Parameters buffer:byte[] the buffer into which the data is read. offset:int the start offset in array `b` at which the data is written. length:int the maximum number of bytes to read. Returns:int the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the stream has been reached. Annotations @Override Exceptions IOException: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

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

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off-1] and elements b[off+len] through b[b.length-1] are unaffected.

Parameters

buffer:byte[]: the buffer into which the data is read.
offset:int: the start offset in array b at which the data is written.
length:int: the maximum number of bytes to read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Annotations

@Override

Exceptions

IOException:: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

readAndWrite back to summary

readAndWrite	back to summary
public int readAndWrite(OutputStream out) throws IOException Convenience method that will read and uncompress all data available, and write it using given `OutputStream`. This avoids having to make an intermediate copy of uncompressed data which would be needed when doing the same manually. Parameters out:OutputStream OutputStream to use for writing content Returns:int Number of bytes written (uncompressed)

public int readAndWrite(OutputStream out) throws IOException

Convenience method that will read and uncompress all data available, and write it using given OutputStream. This avoids having to make an intermediate copy of uncompressed data which would be needed when doing the same manually.

Parameters

out:OutputStream: OutputStream to use for writing content

Returns:int

Number of bytes written (uncompressed)

readyBuffer	back to summary
protected boolean readyBuffer() throws IOException Fill the uncompressed bytes buffer by reading the underlying inputStream. Returns:boolean True if there is now at least one byte to read in the buffer; false if there is no more content to read

readyBuffer

back to summary

protected boolean readyBuffer() throws IOException

Fill the uncompressed bytes buffer by reading the underlying inputStream.

Returns:boolean: True if there is now at least one byte to read in the buffer; false if there is no more content to read

setUseFullReads	back to summary
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.

skip	back to summary
public long skip(long n) throws IOException Overrides java.io.InputStream.skip. Overridden to implement efficient skipping by skipping full chunks whenever possible. Parameters n:long Doc from java.io.InputStream.skip. the number of bytes to be skipped. Returns:long Doc from java.io.InputStream.skip. the actual number of bytes skipped which might be zero. Annotations @Override Exceptions IOException: Doc from java.io.InputStream.skip. if an I/O error occurs.

skip

back to summary

public long skip(long n) throws IOException

Overrides java.io.InputStream.skip.

Overridden to implement efficient skipping by skipping full chunks whenever possible.

Parameters

n:long

Doc from java.io.InputStream.skip.

the number of bytes to be skipped.

Returns:long

Doc from java.io.InputStream.skip.

the actual number of bytes skipped which might be zero.