Class DefensiveDecompressor

java.lang.Object

io.netty.handler.codec.compression.DefensiveDecompressor

All Implemented Interfaces:

Decompressor, AutoCloseable

final class DefensiveDecompressor
extends Object
implements Decompressor

Most decompressor implementations play fast and loose with Decompressor API contracts. This wrapper makes sure callers follow that contract.

Nested Class Summary

Nested classes/interfaces inherited from interface Decompressor

Decompressor.AbstractDecompressorBuilder, Decompressor.Status

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	closed
private final Decompressor	delegate
private boolean	failed
private Decompressor.Status	status

Constructor Summary

Constructors

Constructor	Description
DefensiveDecompressor(Decompressor delegate)

Method Summary

Modifier and Type	Method	Description
void	addInput(ByteBuf buf)	Add a new input buffer.
private void	checkReady()
private void	checkState(Decompressor.Status expected)
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 Object

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

Field Details

delegate

private final Decompressor delegate

status

private Decompressor.Status status

closed

private boolean closed

failed

private boolean failed

Constructor Details

DefensiveDecompressor

DefensiveDecompressor(Decompressor delegate)

Method Details

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.

Specified by:

status in interface Decompressor

Returns:

The current status

Throws:

DecompressionException

addInput

public 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

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.

Specified by:

endOfInput in interface Decompressor

Throws:

DecompressionException

takeOutput

public 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 AutoCloseable

Specified by:

close in interface Decompressor

checkReady

private void checkReady()

checkState

private void checkState(Decompressor.Status expected)