de.carne.nio.compression.spi

Class Encoder

java.lang.Object

de.carne.nio.compression.Compression

de.carne.nio.compression.spi.Encoder

public abstract class Encoder
extends Compression

Base class for compression encoders

Constructor Summary

Constructors

Constructor and Description
Encoder()

Method Summary

Modifier and Type	Method and Description
abstract int	closeEncoding(java.nio.channels.WritableByteChannel dst) Close the encoding data stream and write any needed termination mark.
abstract int	encode(java.nio.ByteBuffer src, java.nio.channels.WritableByteChannel dst) Encode data.

Methods inherited from class de.carne.nio.compression.Compression

beginProcessing, endProcessing, name, processingTime, rateIn, rateOut, reset, totalIn, totalOut

Methods inherited from class java.lang.Object

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

Constructor Detail

Encoder

public Encoder()

Method Detail

encode

public abstract int encode(java.nio.ByteBuffer src,
                           java.nio.channels.WritableByteChannel dst)
                    throws java.io.IOException

Encode data.

Parameters:

src - The ByteBuffer providing the data to encode.

dst - The WritableByteChannel receiving the encoded bytes.

Returns:

The number of encoded bytes.

Throws:

java.io.IOException - if an I/O error occurs.

closeEncoding

public abstract int closeEncoding(java.nio.channels.WritableByteChannel dst)
                           throws java.io.IOException

Close the encoding data stream and write any needed termination mark.

Parameters:

dst - The WritableByteChannel receiving the encoded bytes.

Returns:

The number of encoded bytes.

Throws:

java.io.IOException - if an I/O error occurs.