Bzip2Decompressor (Netty API Reference (5.0.0.Alpha4))

java.lang.Object
- io.netty5.handler.codec.compression.Bzip2Decompressor

All Implemented Interfaces:

Decompressor, AutoCloseable
```
public final class Bzip2Decompressor
extends Object
implements Decompressor
```
Uncompresses a Buffer encoded with the Bzip2 format. See Bzip2.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`	Close the decompressor.
`Buffer`	`decompress(Buffer in, 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 and only if the end of the compressed stream has been reached.
`static Supplier<Bzip2Decompressor>`	`newFactory()`	Returns a factory for `Bzip2Decompressor`s.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - newFactory
```
public static Supplier<Bzip2Decompressor> newFactory()
```
    Returns a factory for Bzip2Decompressors.
    
    Returns:
    
    a factory.
  - decompress
```
public Buffer decompress(Buffer in,
                         BufferAllocator allocator)
                  throws DecompressionException
```
    Description copied from interface: Decompressor
    
    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:

Specified by:: decompress in interface Decompressor
Parameters:: in - 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
```
public boolean isFinished()
```
Returns true if and only if the end of the compressed stream has been reached.

Specified by:

isFinished in interface Decompressor

Returns:

true if the decompressor is done with decompressing the stream.

close
```
public void close()
```
Description copied from interface: Decompressor

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

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Decompressor

isClosed
```
public boolean isClosed()
```
Description copied from interface: Decompressor

Return true if the decompressor was closed, false otherwise.

Specified by:

isClosed in interface Decompressor

Returns:

if Decompressor.close() was called.