Package net.jpountz.lz4

Class LZ4BlockInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

net.jpountz.lz4.LZ4BlockInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class LZ4BlockInputStream
extends FilterInputStream

InputStream implementation to decode data written with LZ4BlockOutputStream. This class is not thread-safe and does not support mark(int)/reset().

Use LZ4BlockInputStream.Builder.withAcceptOversizedBlocks(boolean) only for trusted inputs that may contain noncanonical legacy LZ4 blocks. Enabling it restores acceptance of blocks whose compressed length is greater than or equal to the original length, which may permit large attacker-controlled allocations.

See Also:

• LZ4BlockOutputStream

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	LZ4BlockInputStream.Builder	Builder for LZ4BlockInputStream

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
LZ4BlockInputStream(InputStream in)	Deprecated. Use newBuilder() instead.
LZ4BlockInputStream(InputStream in, boolean stopOnEmptyBlock)	Deprecated. Use newBuilder() instead.
LZ4BlockInputStream(InputStream in, LZ4FastDecompressor fastDecompressor)	Deprecated. Use newBuilder() instead.
LZ4BlockInputStream(InputStream in, LZ4FastDecompressor fastDecompressor, Checksum checksum)	Deprecated. Use newBuilder() instead.
LZ4BlockInputStream(InputStream in, LZ4FastDecompressor fastDecompressor, Checksum checksum, boolean stopOnEmptyBlock)	Deprecated. Use newBuilder() instead.

Method Summary

Modifier and Type	Method	Description
int	available()
void	mark(int readlimit)
boolean	markSupported()
static LZ4BlockInputStream.Builder	newBuilder()	Creates a new LZ4 block input stream builder.
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)
String	toString()

Methods inherited from class java.io.FilterInputStream

close

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

LZ4BlockInputStream

@Deprecated
public LZ4BlockInputStream(InputStream in,
 LZ4FastDecompressor fastDecompressor,
 Checksum checksum,
 boolean stopOnEmptyBlock)

Deprecated.

Use newBuilder() instead.

Creates a new LZ4 input stream to read from the specified underlying InputStream.

Parameters:

in - the InputStream to poll

fastDecompressor - the LZ4FastDecompressor instance to use

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

stopOnEmptyBlock - whether read is stopped on an empty block

LZ4BlockInputStream

@Deprecated
public LZ4BlockInputStream(InputStream in,
 LZ4FastDecompressor fastDecompressor,
 Checksum checksum)

Deprecated.

Use newBuilder() instead.

Creates a new LZ4 input stream to read from the specified underlying InputStream.

Parameters:

in - the InputStream to poll

fastDecompressor - the LZ4FastDecompressor instance to use

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

See Also:

• LZ4BlockInputStream(InputStream, LZ4FastDecompressor, Checksum, boolean)

LZ4BlockInputStream

@Deprecated
public LZ4BlockInputStream(InputStream in,
 LZ4FastDecompressor fastDecompressor)

Deprecated.

Use newBuilder() instead.

Creates a new LZ4 input stream to read from the specified underlying InputStream, using XXHash32 for checksuming.

Parameters:

in - the InputStream to poll

fastDecompressor - the LZ4FastDecompressor instance to use

See Also:

• LZ4BlockInputStream(InputStream, LZ4FastDecompressor, Checksum, boolean)
• StreamingXXHash32.asChecksum()

LZ4BlockInputStream

@Deprecated
public LZ4BlockInputStream(InputStream in,
 boolean stopOnEmptyBlock)

Deprecated.

Use newBuilder() instead.

Creates a new LZ4 input stream to read from the specified underlying InputStream, using XXHash32 for checksuming.

Parameters:

in - the InputStream to poll

stopOnEmptyBlock - whether read is stopped on an empty block

See Also:

• LZ4BlockInputStream(InputStream, LZ4FastDecompressor, Checksum, boolean)
• LZ4Factory.fastestInstance()
• StreamingXXHash32.asChecksum()

LZ4BlockInputStream

@Deprecated
public LZ4BlockInputStream(InputStream in)

Deprecated.

Use newBuilder() instead.

Creates a new LZ4 input stream to read from the specified underlying InputStream, using XXHash32 for checksuming.

Parameters:

in - the InputStream to poll

See Also:

• LZ4BlockInputStream(InputStream, LZ4FastDecompressor)
• LZ4Factory.fastestInstance()

Method Details

newBuilder

public static LZ4BlockInputStream.Builder newBuilder()

Creates a new LZ4 block input stream builder. The following are defaults:

• decompressor - LZ4Factory.fastestInstance().safeDecompressor()
• checksum - XXHash32
• stopOnEmptyBlock - true
• acceptOversizedBlocks - false

Returns:

new instance of LZ4BlockInputStream.Builder to be used to configure and build new LZ4 input stream

available

public int available()
              throws IOException

Overrides:

available in class FilterInputStream

Throws:

IOException

read

public int read()
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public int read(byte[] b,
 int off,
 int len)
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class FilterInputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class FilterInputStream

mark

public void mark(int readlimit)

Overrides:

mark in class FilterInputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class FilterInputStream

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object