Top Description Fields Constructors Methods
net.jpountz.lz4

public final Class LZ4BlockInputStream

extends FilterInputStream
Class Inheritance
Static Imports
net.jpountz.lz4.LZ4BlockOutputStream.COMPRESSION_LEVEL_BASE, .LZ4BlockOutputStream.COMPRESSION_METHOD_LZ4, .LZ4BlockOutputStream.COMPRESSION_METHOD_RAW, .LZ4BlockOutputStream.DEFAULT_SEED, .LZ4BlockOutputStream.HEADER_LENGTH, .LZ4BlockOutputStream.MAGIC, .LZ4BlockOutputStream.MAGIC_LENGTH
InputStream implementation to decode data written with LZ4BlockOutputStream. This class is not thread-safe and does not support mark(int)/reset().
See Also
LZ4BlockOutputStream

Field Summary

Modifier and TypeField and Description
private byte[]
buffer

private final Checksum
checksum

private byte[]
compressedBuffer

private final LZ4FastDecompressor
decompressor

Deprecated as a consequence of LZ4FastDecompressor being deprecated.
private boolean
finished

private int
o

private int
originalLen

Inherited from java.io.FilterInputStream:
in

Constructor Summary

AccessConstructor and Description
public
LZ4BlockInputStream(InputStream
the InputStream to poll
in, LZ4FastDecompressor
the decompressor instance to use
decompressor, Checksum
the Checksum instance to use, must be equivalent to the instance which has been used to write the stream
checksum)

Deprecated as a consequence of LZ4FastDecompressor being deprecated.
Create a new InputStream.
public
LZ4BlockInputStream(InputStream in, LZ4FastDecompressor decompressor)

Deprecated as a consequence of LZ4FastDecompressor being deprecated.
Create a new instance using XXHash32 for checksuming.
public
LZ4BlockInputStream(InputStream in)

Create a new instance which uses the fastest LZ4FastDecompressor available.

Method Summary

Modifier and TypeMethod and Description
public int
available()

Overrides java.io.FilterInputStream.available.

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream.
public void
mark(int
the maximum limit of bytes that can be read before the mark position becomes invalid.
readlimit)

Overrides java.io.FilterInputStream.mark.

Marks the current position in this input stream.
public boolean
markSupported()

Overrides java.io.FilterInputStream.markSupported.

Tests if this input stream supports the mark and reset methods.
public int
read()

Overrides java.io.FilterInputStream.read.

Reads the next byte of data from the input stream.
public int
read(byte[]
the buffer into which the data is read.
b, int
the start offset in array b at which the data is written.
off, int
the maximum number of bytes to read.
len)

Overrides java.io.FilterInputStream.read.

Reads up to len bytes of data from this input stream into an array of bytes.
public int
read(byte[]
the buffer into which the data is read.
b)

Overrides java.io.FilterInputStream.read.

Reads up to b.length bytes of data from this input stream into an array of bytes.
private void
readFully(byte[] b, int len)

private void
refill()

public void
reset()

Overrides java.io.FilterInputStream.reset.

Repositions this stream to the position at the time the mark method was last called on this input stream.
public long
skip(long
the number of bytes to be skipped.
n)

Overrides java.io.FilterInputStream.skip.

Skips over and discards n bytes of data from the input stream.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.io.FilterInputStream:
close

Field Detail

bufferback to summary
private byte[] buffer
checksumback to summary
private final Checksum checksum
compressedBufferback to summary
private byte[] compressedBuffer
decompressorback to summary
private final LZ4FastDecompressor decompressor

Deprecated

as a consequence of LZ4FastDecompressor being deprecated. See corresponding docs for further information.

finishedback to summary
private boolean finished
oback to summary
private int o
originalLenback to summary
private int originalLen

Constructor Detail

LZ4BlockInputStreamback to summary
public LZ4BlockInputStream(InputStream in, LZ4FastDecompressor decompressor, Checksum checksum)

Deprecated

as a consequence of LZ4FastDecompressor being deprecated. See corresponding docs for further information.

Create a new InputStream.

Parameters
in:InputStream

the InputStream to poll

decompressor:LZ4FastDecompressor

the decompressor instance to use

checksum:Checksum

the Checksum instance to use, must be equivalent to the instance which has been used to write the stream

LZ4BlockInputStreamback to summary
public LZ4BlockInputStream(InputStream in, LZ4FastDecompressor decompressor)

Deprecated

as a consequence of LZ4FastDecompressor being deprecated. See corresponding docs for further information.

Create a new instance using XXHash32 for checksuming.

See Also
LZ4BlockInputStream(InputStream, LZ4FastDecompressor, Checksum), StreamingXXHash32#asChecksum()
LZ4BlockInputStreamback to summary
public LZ4BlockInputStream(InputStream in)

Create a new instance which uses the fastest LZ4FastDecompressor available.

See Also
LZ4Factory#fastestInstance(), LZ4BlockInputStream(InputStream, LZ4FastDecompressor)

Method Detail

availableback to summary
public int available() throws IOException

Overrides java.io.FilterInputStream.available.

Doc from java.io.FilterInputStream.available.

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream. The next caller 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.

Returns:int

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

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
markback to summary
public void mark(int readlimit)

Overrides java.io.FilterInputStream.mark.

Doc from java.io.FilterInputStream.mark.

Marks the current position in this input stream. A subsequent call to the reset method repositions this stream at the last marked position so that subsequent reads re-read the same bytes.

The readlimit argument tells this input stream to allow that many bytes to be read before the mark position gets invalidated.

Parameters
readlimit:int

the maximum limit of bytes that can be read before the mark position becomes invalid.

Annotations
@SuppressWarnings:sync-override
@Override
markSupportedback to summary
public boolean markSupported()

Overrides java.io.FilterInputStream.markSupported.

Doc from java.io.FilterInputStream.markSupported.

Tests if this input stream supports the mark and reset methods.

Returns:boolean

true if this stream type supports the mark and reset method; false otherwise.

Annotations
@Override
readback to summary
public int read() throws IOException

Overrides java.io.FilterInputStream.read.

Doc from java.io.FilterInputStream.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.
readback to summary
public int read(byte[] b, int off, int len) throws IOException

Overrides java.io.FilterInputStream.read.

Doc from java.io.FilterInputStream.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
b:byte[]

the buffer into which the data is read.

off:int

the start offset in array b at which the data is written.

len: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.
readback to summary
public int read(byte[] b) throws IOException

Overrides java.io.FilterInputStream.read.

Doc from java.io.FilterInputStream.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 stream has been reached.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
readFullyback to summary
private void readFully(byte[] b, int len) throws IOException
refillback to summary
private void refill() throws IOException
resetback to summary
public void reset() throws IOException

Overrides java.io.FilterInputStream.reset.

Doc from java.io.FilterInputStream.reset.

Repositions this stream to the position at the time the mark method was last called on this input stream.

Stream marks are intended to be used in situations where you need to read ahead a little to see what's in the stream. Often this is most easily done by invoking some general parser. If the stream is of the type handled by the parse, it just chugs along happily. If the stream is not of that type, the parser should toss an exception when it fails. If this happens within readlimit bytes, it allows the outer code to reset the stream and try another parser.

Annotations
@SuppressWarnings:sync-override
@Override
Exceptions
IOException:
if this stream has not been marked or if the mark has been invalidated.
skipback to summary
public long skip(long n) throws IOException

Overrides java.io.FilterInputStream.skip.

Doc from java.io.FilterInputStream.skip.

Skips over and discards n bytes of data from the input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. The actual number of bytes skipped is returned.

Parameters
n:long

the number of bytes to be skipped.

Returns:long

the actual number of bytes skipped.

Annotations
@Override
Exceptions
IOException:
if in.skip(n) throws an IOException.
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override