Top Description Constructors Methods
com.ning.compress

public abstract Class Uncompressor

extends Object
Class Inheritance
Known Direct Subclasses
com.ning.compress.gzip.GZIPUncompressor, com.ning.compress.lzf.LZFUncompressor
Imports
java.io.IOException

Abstract class that defines "push" style API for various uncompressors (aka decompressors or decoders). Implementations are alternatives to stream based uncompressors (such as com.ning.compress.lzf.LZFInputStream) in cases where "push" operation is important and/or blocking is not allowed; for example, when handling asynchronous HTTP responses.

Note that API does not define the way that listener is attached: this is typically passed through to constructor of the implementation.

Author
Tatu Saloranta ([email protected])

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public abstract void
complete()

Method called to indicate that all data to uncompress has already been fed.

public abstract boolean

Returns:

True, if caller should process and feed more data; false if caller is not interested in more data and processing should be terminated. (and complete should be called immediately)
feedCompressedData
(byte[] comp, int offset, int len)

Method called to feed more compressed data to be uncompressed, and sent to possible listeners.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Uncompressorback to summary
public Uncompressor()

Method Detail

completeback to summary
public abstract void complete() throws IOException

Method called to indicate that all data to uncompress has already been fed. This typically results in last block of data being uncompressed, and results being sent to listener(s); but may also throw an exception if incomplete block was passed.

feedCompressedDataback to summary
public abstract boolean feedCompressedData(byte[] comp, int offset, int len) throws IOException

Method called to feed more compressed data to be uncompressed, and sent to possible listeners.

Note

return value was added (from void to boolean) in 0.9.9

Returns:boolean

True, if caller should process and feed more data; false if caller is not interested in more data and processing should be terminated. (and complete should be called immediately)