Package com.aayushatharva.brotli4j.encoder

Class Encoder

java.lang.Object

com.aayushatharva.brotli4j.encoder.Encoder

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

BrotliEncoderChannel

public class Encoder
extends Object
implements AutoCloseable

Base class for OutputStream / Channel implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Encoder.Mode	... See encode.h, typedef enum BrotliEncoderMode
static final class	Encoder.Parameters	Brotli encoder settings.

Constructor Summary

Constructors

Constructor	Description
Encoder(WritableByteChannel destination, Encoder.Parameters params, int inputBufferSize)	Creates a Encoder wrapper.

Method Summary

Modifier and Type	Method	Description
void	attachDictionary(PreparedDictionary dictionary)
void	close()
static byte[]	compress(byte[] data)
static byte[]	compress(byte[] data, int offset, int length)
static byte[]	compress(byte[] data, int offset, int length, Encoder.Parameters params)
static byte[]	compress(byte[] data, Encoder.Parameters params)
boolean	encode(EncoderJNI.Operation op)
void	flush()
static PreparedDictionary	prepareDictionary(ByteBuffer dictionary, int sharedDictionaryType)	Prepares raw or serialized dictionary for being used by encoder.

Methods inherited from class java.lang.Object

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

Constructor Details

Encoder

public Encoder(WritableByteChannel destination,
 Encoder.Parameters params,
 int inputBufferSize)
        throws IOException

Creates a Encoder wrapper.

Parameters:

destination - underlying destination

params - encoding parameters

inputBufferSize - read buffer size

Throws:

IOException

Method Details

compress

public static byte[] compress(byte[] data,
 int offset,
 int length,
 Encoder.Parameters params)
                       throws IOException

Throws:

IOException

compress

public static byte[] compress(byte[] data)
                       throws IOException

Throws:

IOException

compress

public static byte[] compress(byte[] data,
 Encoder.Parameters params)
                       throws IOException

Throws:

IOException

compress

public static byte[] compress(byte[] data,
 int offset,
 int length)
                       throws IOException

Throws:

IOException

prepareDictionary

public static PreparedDictionary prepareDictionary(ByteBuffer dictionary,
 int sharedDictionaryType)

Prepares raw or serialized dictionary for being used by encoder.

Parameters:

dictionary - raw / serialized dictionary data; MUST be direct

sharedDictionaryType - dictionary data type

Returns:

PreparedDictionary instance

attachDictionary

public void attachDictionary(PreparedDictionary dictionary)
                      throws IOException

Throws:

IOException

encode

public boolean encode(EncoderJNI.Operation op)
               throws IOException

Returns:

true if there is space in inputBuffer.

Throws:

IOException

flush

public void flush()
           throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException