Decompressor (Netty API Reference (5.0.0.Alpha4))

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

BrotliDecompressor, Bzip2Decompressor, FastLzDecompressor, Lz4Decompressor, LzfDecompressor, SnappyDecompressor, ZlibDecompressor
```
public interface Decompressor
extends AutoCloseable
```
Decompressor that takes care of decompress some input.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`close()`	Close the decompressor.
`Buffer`	`decompress(Buffer input, BufferAllocator allocator)`	This method will read from the input `Buffer` and decompress into a new `Buffer` that will be allocated (if needed) from the `BufferAllocator`.
`boolean`	`isClosed()`	Return `true` if the decompressor was closed, `false` otherwise.
`boolean`	`isFinished()`	Returns true if the decompressor was finish.

- Method Detail
  - decompress
```
Buffer decompress(Buffer input,
                  BufferAllocator allocator)
           throws DecompressionException
```
    This method will read from the input Buffer and decompress into a new Buffer that will be allocated (if needed) from the BufferAllocator. If there is not enough readable data in the Buffer to process it will return null. This method should be called in a loop as long:

Parameters:: input - the Buffer that contains the data to be decompressed.; allocator - the BufferAllocator that is used to allocate a new buffer (if needed) to write the decompressed bytes too.
Returns:: the Buffer that contains the decompressed data. The caller of this method takes ownership of the buffer. The return value will be null if there is not enough data readable in the input to make any progress. In this case the user should call it again once there is more data ready to be consumed.
Throws:: DecompressionException - thrown if an decompression error was encountered or the decompressor was closed before.

isFinished
```
boolean isFinished()
```
Returns true if the decompressor was finish. This might be because the decompressor was explicitly closed or the end of the compressed stream was detected.

Returns:

true if the decompressor is done with decompressing the stream.

isClosed
```
boolean isClosed()
```
Return true if the decompressor was closed, false otherwise.

Returns:

if close() was called.

close
```
void close()
```
Close the decompressor. After this method was called isFinished() will return true as well and it is not allowed to call decompress(Buffer, BufferAllocator) anymore.

Specified by:

close in interface AutoCloseable