bayou.gzip

Class GunzipByteSource

java.lang.Object

bayou.gzip.GunzipByteSource

All Implemented Interfaces:

ByteSource

public class GunzipByteSource
extends Object
implements ByteSource

Decompress the origin ByteSource that's compressed in gzip format.

Constructor Summary

Constructors

Constructor and Description
GunzipByteSource(ByteSource origin) Create a GunzipByteSource that decompresses the `origin` source in gzip format.

Method Summary

Instance Methods
Async<ByteBuffer>	read() Read the next chunk of decompressed bytes.
Async<Void>	close() Close this source.

Methods inherited from class java.lang.Object

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

Methods inherited from interface bayou.bytes.ByteSource

asString, asString, readAll, skip, toSink

Constructor Detail

GunzipByteSource

public GunzipByteSource(ByteSource origin)

Create a GunzipByteSource that decompresses the `origin` source in gzip format.

Method Detail

read

public Async<ByteBuffer> read()
                       throws IllegalStateException

Read the next chunk of decompressed bytes.

If the origin source is not in valid gzip format, the read() action fails with ZipException.

Specified by:

read in interface ByteSource

Throws:

IllegalStateException

close

public Async<Void> close()

Description copied from interface: ByteSource

Close this source.

This method can be called multiple times; only the first call is effective.

This method should not be invoked while a read() is pending; if that's needed, see ThreadSafeByteSource for a solution.

Since ByteSource is a read-only concept, close() should not have any side effects that the caller cares about. The caller is allowed to ignore the returned Async<Void> (as if the method returns void).

The close() action should not fail; if some internal exception arises, it can be logged. Most implementations return an immediate Async.VOID, even if there are still background cleanup tasks running.

Specified by:

close in interface ByteSource