akka.stream.impl.io.compression

Class Compressor

java.lang.Object

akka.stream.impl.io.compression.Compressor

Direct Known Subclasses:

DeflateCompressor

public abstract class Compressor
extends java.lang.Object

INTERNAL API

A stateful object representing ongoing compression.

Constructor Summary

Constructors

Constructor and Description
Compressor()

Method Summary

Modifier and Type	Method and Description
abstract void	close() Make sure any resources have been released
abstract ByteString	compress(ByteString input) Compresses the given input and returns compressed data.
abstract ByteString	compressAndFinish(ByteString input) Combines `compress` + `finish`
abstract ByteString	compressAndFlush(ByteString input) Combines `compress` + `flush`
abstract ByteString	finish() Closes this compressed stream and return the remaining compressed data.
abstract ByteString	flush() Flushes any output data and returns the currently remaining compressed data.

Methods inherited from class java.lang.Object

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

Constructor Detail

Compressor

public Compressor()

Method Detail

compress

public abstract ByteString compress(ByteString input)

Compresses the given input and returns compressed data. The implementation can and will choose to buffer output data to improve compression. Use flush or compressAndFlush to make sure that all input data has been compressed and pending output data has been returned.

Parameters:

input - (undocumented)

Returns:

(undocumented)

flush

public abstract ByteString flush()

Flushes any output data and returns the currently remaining compressed data.

Returns:

(undocumented)

finish

public abstract ByteString finish()

Closes this compressed stream and return the remaining compressed data. After calling this method, this Compressor cannot be used any further.

Returns:

(undocumented)

compressAndFlush

public abstract ByteString compressAndFlush(ByteString input)

Combines `compress` + `flush`

compressAndFinish

public abstract ByteString compressAndFinish(ByteString input)

Combines `compress` + `finish`

close

public abstract void close()

Make sure any resources have been released