Package io.netty.handler.codec.compression

Class LzfDecompressor

java.lang.Object

io.netty.handler.codec.compression.LzfDecompressor

All Implemented Interfaces:

Decompressor, java.lang.AutoCloseable

@UnstableApi
public final class LzfDecompressor
extends java.lang.Object

Uncompresses a ByteBuf encoded with the LZF format.

See original LZF package and LZF format for full description.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LzfDecompressor.Builder

Nested classes/interfaces inherited from interface io.netty.handler.codec.compression.Decompressor

Decompressor.AbstractDecompressorBuilder, Decompressor.Status

Field Summary

Fields

Modifier and Type	Field	Description
protected ByteBufAllocator	allocator

Method Summary

Modifier and Type	Method	Description
void	addInput(ByteBuf buf)	Add a new input buffer.
static LzfDecompressor.Builder	builder()
void	close()	Close this decompressor, cleaning up any associated resources.
void	endOfInput()	Notify the decompressor that the end of input has been reached.
Decompressor.Status	status()	Get the current status.
ByteBuf	takeOutput()	Take a decompressed buffer from this decompressor.

Methods inherited from class java.lang.Object

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

Field Detail

allocator

protected final ByteBufAllocator allocator

Method Detail

status

public Decompressor.Status status()
                           throws DecompressionException

Description copied from interface: Decompressor

Get the current status. Like the other operations on this class, calling this method is not permitted if the decompressor has failed or was closed.

Returns:

The current status

Throws:

DecompressionException

endOfInput

public void endOfInput()
                throws DecompressionException

Description copied from interface: Decompressor

Notify the decompressor that the end of input has been reached. Some implementations may flush remaining data or throw an exception if the input is truncated, but most implementations do nothing. Only permitted for Decompressor.Status.NEED_INPUT.

Throws:

DecompressionException

builder

@UnstableApi
public static LzfDecompressor.Builder builder()

addInput

public final void addInput(ByteBuf buf)
                    throws DecompressionException

Description copied from interface: Decompressor

Add a new input buffer. Only permitted for Decompressor.Status.NEED_INPUT.

Specified by:

addInput in interface Decompressor

Parameters:

buf - The input buffer. Buffer ownership transfers to the decompressor (also on exception).

Throws:

DecompressionException

takeOutput

public final ByteBuf takeOutput()
                         throws DecompressionException

Description copied from interface: Decompressor

Take a decompressed buffer from this decompressor. Only permitted for Decompressor.Status.NEED_OUTPUT. Buffer ownership transfers to the caller.

Specified by:

takeOutput in interface Decompressor

Returns:

The decompressed buffer. May be empty.

Throws:

DecompressionException

close

public void close()

Description copied from interface: Decompressor

Close this decompressor, cleaning up any associated resources. This method is idempotent.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface Decompressor