Package net.jpountz.lz4

Class LZ4BlockInputStream.Builder

java.lang.Object

net.jpountz.lz4.LZ4BlockInputStream.Builder

Enclosing class:

LZ4BlockInputStream

public static final class LZ4BlockInputStream.Builder
extends Object

Builder for LZ4BlockInputStream

Method Summary

Modifier and Type	Method	Description
LZ4BlockInputStream	build(InputStream in)	Creates a new LZ4 input stream to read from the specified InputStream with specified parameters
LZ4BlockInputStream.Builder	withAcceptOversizedBlocks(boolean acceptOversizedBlocks)	Registers whether the builder should accept oversized blocks whose compressed length is greater than or equal to the original length.
LZ4BlockInputStream.Builder	withChecksum(Checksum checksum)	Registers Checksum to be used by the builder
LZ4BlockInputStream.Builder	withDecompressor(LZ4FastDecompressor fastDecompressor)	Registers LZ4FastDecompressor to be used by the builder as a decompressor.
LZ4BlockInputStream.Builder	withDecompressor(LZ4SafeDecompressor safeDecompressor)	Registers LZ4SafeDecompressor to be used by the builder as a decompressor.
LZ4BlockInputStream.Builder	withStopOnEmptyBlock(boolean stopOnEmptyBlock)	Registers value of stopOnEmptyBlock to be used by the builder

Methods inherited from class java.lang.Object

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

Method Details

withStopOnEmptyBlock

public LZ4BlockInputStream.Builder withStopOnEmptyBlock(boolean stopOnEmptyBlock)

Registers value of stopOnEmptyBlock to be used by the builder

Parameters:

stopOnEmptyBlock - whether read is stopped on an empty block

Returns:

current builder instance

withAcceptOversizedBlocks

public LZ4BlockInputStream.Builder withAcceptOversizedBlocks(boolean acceptOversizedBlocks)

Registers whether the builder should accept oversized blocks whose compressed length is greater than or equal to the original length.

Only enable this for trusted inputs. Accepting such blocks may permit large attacker-controlled allocations.

Parameters:

acceptOversizedBlocks - whether oversized blocks should be accepted

Returns:

current builder instance

Since:

1.11.2

withDecompressor

public LZ4BlockInputStream.Builder withDecompressor(LZ4FastDecompressor fastDecompressor)

Registers LZ4FastDecompressor to be used by the builder as a decompressor. Overrides one set by withDecompressor(LZ4SafeDecompressor)

Parameters:

fastDecompressor - the LZ4FastDecompressor instance to use

Returns:

current builder instance

withDecompressor

public LZ4BlockInputStream.Builder withDecompressor(LZ4SafeDecompressor safeDecompressor)

Registers LZ4SafeDecompressor to be used by the builder as a decompressor. Overrides one set by withDecompressor(LZ4FastDecompressor)

Parameters:

safeDecompressor - the LZ4SafeDecompressor instance to use.

Returns:

current builder instance

withChecksum

public LZ4BlockInputStream.Builder withChecksum(Checksum checksum)

Registers Checksum to be used by the builder

Note: Since checksum objects are stateful, if you set one explicitly here, the builder can only be used once.

Parameters:

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

Returns:

current builder instance

build

public LZ4BlockInputStream build(InputStream in)

Creates a new LZ4 input stream to read from the specified InputStream with specified parameters

Parameters:

in - the InputStream to poll

Returns:

new instance of LZ4BlockInputStream using parameters set in the builder and provided InputStream

See Also:

• withChecksum(Checksum)
• withDecompressor(LZ4FastDecompressor)
• withDecompressor(LZ4SafeDecompressor)
• withStopOnEmptyBlock(boolean)
• withAcceptOversizedBlocks(boolean)