Modifier and Type	Class and Description
private class	LZFFileInputStream.Wrapper This simple wrapper is needed to re-route read calls so that they will use "raw" reads

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	_decompressor Underlying decoder in use.
protected byte[]	_inputBuffer the current buffer of compressed bytes (from which to decode)
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
protected final LZFFileInputStream.Wrapper	_wrapper Wrapper object we use to allow decoder to read directly from the stream, without ending in infinite loop...

Access	Constructor and Description
public	LZFFileInputStream(File file)
public	LZFFileInputStream(FileDescriptor fdObj)
public	LZFFileInputStream(String name)
public	LZFFileInputStream(File file, ChunkDecoder decompressor)
public	LZFFileInputStream(FileDescriptor fdObj, ChunkDecoder decompressor)
public	LZFFileInputStream(String name, ChunkDecoder decompressor)
public	LZFFileInputStream(File file, ChunkDecoder decompressor, BufferRecycler bufferRecycler)
public	LZFFileInputStream(FileDescriptor fdObj, ChunkDecoder decompressor, BufferRecycler bufferRecycler)
public	LZFFileInputStream(String name, ChunkDecoder decompressor, BufferRecycler bufferRecycler)

Method Summary

Modifier and Type	Method and Description
public int	available() Overrides java.io.FileInputStream.available. Returns an estimate of the number of remaining bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream.
public void	close() Overrides java.io.FileInputStream.close. Implements java.io.Closeable.close. Closes this file input stream and releases any system resources associated with the stream.
public int	read() Overrides java.io.FileInputStream.read. Reads a byte of data from this input stream.
public int	read(byte[] the buffer into which the data is read. b) Overrides java.io.FileInputStream.read. Reads up to `b.length` bytes of data from this input stream into an array of bytes.
public int	read(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.FileInputStream.read. Reads up to `len` bytes of data from this 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 final int	readRaw(byte[] buffer, int offset, int length)
protected boolean	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.FileInputStream.skip. Overridden to implement efficient skipping by skipping full chunks whenever possible.
protected final long	skipRaw(long amount)

Inherited from java.io.FileInputStream:: getChannel getFD readAllBytes readNBytes transferTo

_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

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

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

_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

_wrapper	back to summary
protected final LZFFileInputStream.Wrapper _wrapper Wrapper object we use to allow decoder to read directly from the stream, without ending in infinite loop...

LZFFileInputStream	back to summary
public LZFFileInputStream(File file) throws FileNotFoundException

LZFFileInputStream	back to summary
public LZFFileInputStream(FileDescriptor fdObj)

LZFFileInputStream	back to summary
public LZFFileInputStream(String name) throws FileNotFoundException

LZFFileInputStream	back to summary
public LZFFileInputStream(File file, ChunkDecoder decompressor) throws FileNotFoundException

LZFFileInputStream	back to summary
public LZFFileInputStream(FileDescriptor fdObj, ChunkDecoder decompressor)

LZFFileInputStream	back to summary
public LZFFileInputStream(String name, ChunkDecoder decompressor) throws FileNotFoundException

LZFFileInputStream	back to summary
public LZFFileInputStream(File file, ChunkDecoder decompressor, BufferRecycler bufferRecycler) throws FileNotFoundException

LZFFileInputStream	back to summary
public LZFFileInputStream(FileDescriptor fdObj, ChunkDecoder decompressor, BufferRecycler bufferRecycler)

LZFFileInputStream	back to summary
public LZFFileInputStream(String name, ChunkDecoder decompressor, BufferRecycler bufferRecycler) throws FileNotFoundException

Method Detail

available	back to summary
public int available() Overrides java.io.FileInputStream.available. Doc from java.io.FileInputStream.available. Returns an estimate of the number of remaining bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream. Returns 0 when the file position is beyond EOF. The next invocation might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes. In some cases, a non-blocking read (or skip) may appear to be blocked when it is merely slow, for example when reading large files over slow networks. Returns:int an estimate of the number of remaining bytes that can be read (or skipped over) from this input stream without blocking. Annotations @Override

available

back to summary

public int available()

Overrides java.io.FileInputStream.available.

Doc from java.io.FileInputStream.available.

Returns an estimate of the number of remaining bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream. Returns 0 when the file position is beyond EOF. The next invocation might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

In some cases, a non-blocking read (or skip) may appear to be blocked when it is merely slow, for example when reading large files over slow networks.

Returns:int

an estimate of the number of remaining bytes that can be read (or skipped over) from this input stream without blocking.

Annotations

@Override

close	back to summary
public void close() throws IOException Overrides java.io.FileInputStream.close. Implements java.io.Closeable.close. Doc from java.io.FileInputStream.close. Closes this file input stream and releases any system resources associated with the stream. If this stream has an associated channel then the channel is closed as well. Annotations @Override Exceptions IOException: if an I/O error occurs.

back to summary

public void close() throws IOException

Overrides java.io.FileInputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.FileInputStream.close.

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

If this stream has an associated channel then the channel is closed as well.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read() throws IOException Overrides java.io.FileInputStream.read. Doc from java.io.FileInputStream.read. Reads a byte of data from this input stream. This method blocks if no input is yet available. Returns:int the next byte of data, or `-1` if the end of the file is reached. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int read() throws IOException

Overrides java.io.FileInputStream.read.

Doc from java.io.FileInputStream.read.

Reads a byte of data from this input stream. This method blocks if no input is yet available.

Returns:int

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

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(byte[] b) throws IOException Overrides java.io.FileInputStream.read. Doc from java.io.FileInputStream.read. Reads up to `b.length` bytes of data from this input stream into an array of bytes. This method blocks until some input is available. Parameters b: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 file has been reached. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int read(byte[] b) throws IOException

Overrides java.io.FileInputStream.read.

Doc from java.io.FileInputStream.read.

Reads up to b.length bytes of data from this input stream into an array of bytes. This method blocks until some input is available.

Parameters

b: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 file has been reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(byte[] buffer, int offset, int length) throws IOException Overrides java.io.FileInputStream.read. Doc from java.io.FileInputStream.read. Reads up to `len` bytes of data from this input stream into an array of bytes. If `len` is not zero, the method blocks until some input is available; otherwise, no bytes are read and `0` is returned. 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 an I/O error occurs.

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

Overrides java.io.FileInputStream.read.

Doc from java.io.FileInputStream.read.

Reads up to len bytes of data from this input stream into an array of bytes. If len is not zero, the method blocks until some input is available; otherwise, no bytes are read and 0 is returned.

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 an 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)

readRaw	back to summary
protected final int readRaw(byte[] buffer, int offset, int length) throws IOException

readyBuffer	back to summary
protected boolean readyBuffer() throws IOException Fill the uncompressed bytes buffer by reading the underlying inputStream.

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.FileInputStream.skip. Overridden to implement efficient skipping by skipping full chunks whenever possible. Parameters n:long Doc from java.io.FileInputStream.skip. the number of bytes to be skipped. Returns:long Doc from java.io.FileInputStream.skip. the actual number of bytes skipped. Annotations @Override Exceptions IOException: Doc from java.io.FileInputStream.skip. if n is negative, if the stream does not support seek, or if an I/O error occurs.

skip

back to summary

public long skip(long n) throws IOException

Overrides java.io.FileInputStream.skip.

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

Parameters

n:long

Doc from java.io.FileInputStream.skip.

the number of bytes to be skipped.

Returns:long

Doc from java.io.FileInputStream.skip.

the actual number of bytes skipped.

Annotations

@Override

Exceptions

IOException:

Doc from java.io.FileInputStream.skip.

if n is negative, if the stream does not support seek, or if an I/O error occurs.

skipRaw	back to summary
protected final long skipRaw(long amount) throws IOException

com.ning.compress.lzf.util back to summary

private final Class LZFFileInputStream.Wrapper

Class Inheritance

extends InputStream

java.lang.Object
java.io.InputStream
com.ning.compress.lzf.util.LZFFileInputStream.Wrapper

This simple wrapper is needed to re-route read calls so that they will use "raw" reads

Constructor Summary

Access	Constructor and Description
private	Wrapper()

Method Summary

Modifier and Type	Method and Description
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 int	read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.
public int	read(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	read(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 long	skip(long the number of bytes to be skipped. n) Overrides java.io.InputStream.skip. Skips over and discards `n` bytes of data from this input stream.

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

Constructor Detail

Wrapper	back to summary
private Wrapper()

Wrapper

back to summary

private Wrapper()

Method Detail

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.

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(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(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.

read back to summary

read	back to summary
public int read(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(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.

skip back to summary

skip	back to summary
public long skip(long n) throws IOException Overrides java.io.InputStream.skip. Doc from java.io.InputStream.skip. Skips over and discards `n` bytes of data from this input stream. The `skip` method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly `0`. This may result from any of a number of conditions; reaching end of file before `n` bytes have been skipped is only one possibility. The actual number of bytes skipped is returned. If `n` is negative, the `skip` method for class `InputStream` always returns 0, and no bytes are skipped. Subclasses may handle the negative value differently. Parameters n:long the number of bytes to be skipped. Returns:long the actual number of bytes skipped which might be zero. Annotations @Override Exceptions IOException: if an I/O error occurs.

public long skip(long n) throws IOException

Overrides java.io.InputStream.skip.

Doc from java.io.InputStream.skip.

Skips over and discards n bytes of data from this input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. This may result from any of a number of conditions; reaching end of file before n bytes have been skipped is only one possibility. The actual number of bytes skipped is returned. If n is negative, the skip method for class InputStream always returns 0, and no bytes are skipped. Subclasses may handle the negative value differently.

Parameters

n:long: the number of bytes to be skipped.

Returns:long

the actual number of bytes skipped which might be zero.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

public Class LZFFileInputStream

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class LZFFileInputStream.Wrapper

Constructor Summary

Method Summary

Constructor Detail

Method Detail