Package org.brotli.wrapper.enc

Class Encoder

java.lang.Object

org.brotli.wrapper.enc.Encoder

Direct Known Subclasses:

BrotliEncoderChannel

public class Encoder
extends Object

Base class for OutputStream / Channel implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Encoder.Mode	https://www.brotli.org/encode.html#aa6f See encode.h, typedef enum BrotliEncoderMode Important: The ordinal value of the modes should be the same as the constant values in encode.h
static final class	Encoder.Parameters	Brotli encoder settings.

Field Summary

Fields

Modifier and Type	Field	Description
private ByteBuffer	buffer
(package private) boolean	closed
private final WritableByteChannel	destination
private final List<PreparedDictionary>	dictionaries
private final EncoderJNI.Wrapper	encoder
(package private) final ByteBuffer	inputBuffer

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)
(package private) void	close()
static byte[]	compress(byte[] data)
static byte[]	compress(byte[] data, Encoder.Parameters params)	Encodes the given data buffer.
(package private) boolean	encode(EncoderJNI.Operation op)
private void	fail(String message)
(package private) void	flush()
static PreparedDictionary	prepareDictionary(ByteBuffer dictionary, int sharedDictionaryType)	Prepares raw or serialized dictionary for being used by encoder.
(package private) boolean	pushOutput(boolean force)

Methods inherited from class java.lang.Object

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

Field Details

destination

private final WritableByteChannel destination

dictionaries

private final List<PreparedDictionary> dictionaries

encoder

private final EncoderJNI.Wrapper encoder

buffer

private ByteBuffer buffer

inputBuffer

final ByteBuffer inputBuffer

closed

boolean closed

Constructor Details

Encoder

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

fail

private void fail(String message)
           throws IOException

Throws:

IOException

attachDictionary

public void attachDictionary(PreparedDictionary dictionary)
                      throws IOException

Throws:

IOException

pushOutput

boolean pushOutput(boolean force)
            throws IOException

Parameters:

force - repeat pushing until all output is consumed

Returns:

true if all encoder output is consumed

Throws:

IOException

encode

boolean encode(EncoderJNI.Operation op)
        throws IOException

Returns:

true if there is space in inputBuffer.

Throws:

IOException

flush

void flush()
    throws IOException

Throws:

IOException

close

void close()
    throws IOException

Throws:

IOException

compress

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

Encodes the given data buffer.

Throws:

IOException

compress

public static byte[] compress(byte[] data)
                       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