Modifier and Type	Class and Description
public static enum	Encoder.Mode ... See encode.h, typedef enum BrotliEncoderMode Important Note The ordinal value of the modes should be the same as the constant values in encode.h
public static class	Encoder.Parameters Brotli encoder settings.

Modifier and Type	Field and Description
private ByteBuffer	buffer
pack-priv boolean	closed
private final WritableByteChannel	destination
private final List<PreparedDictionary>	dictionaries
private final EncoderJNI.Wrapper	encoder
pack-priv final ByteBuffer	inputBuffer

Access	Constructor and Description
pack-priv	Encoder(WritableByteChannel underlying destination destination, Encoder.Parameters encoding parameters params, int read buffer size inputBufferSize) Creates a Encoder wrapper.

Method Summary

Modifier and Type	Method and Description
public void	attachDictionary(PreparedDictionary dictionary)
pack-priv void	close()
public static byte[]	compress(byte[] data, int offset, int length, Encoder.Parameters params)
public static byte[]	compress(byte[] data)
public static byte[]	compress(byte[] data, Encoder.Parameters params)
public static byte[]	compress(byte[] data, int offset, int length)
public boolean	Returns: true if there is space in inputBuffer. encode(EncoderJNI.Operation op)
private void	fail(String message)
public void	flush()
public static PreparedDictionary	Returns: `PreparedDictionary` instance prepareDictionary(ByteBuffer raw / serialized dictionary data; MUST be direct dictionary, int dictionary data type sharedDictionaryType) Prepares raw or serialized dictionary for being used by encoder.
pack-priv boolean	Returns: true if all encoder output is consumed pushOutput(boolean repeat pushing until all output is consumed force)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

buffer	back to summary
private ByteBuffer buffer

closed	back to summary
pack-priv boolean closed

destination	back to summary
private final WritableByteChannel destination

dictionaries	back to summary
private final List<PreparedDictionary> dictionaries

encoder	back to summary
private final EncoderJNI.Wrapper encoder

inputBuffer	back to summary
pack-priv final ByteBuffer inputBuffer

Encoder	back to summary
pack-priv Encoder(WritableByteChannel destination, Encoder.Parameters params, int inputBufferSize) throws IOException Creates a Encoder wrapper. Parameters destination:WritableByteChannel underlying destination params:Encoder.Parameters encoding parameters inputBufferSize:int read buffer size

Method Detail

attachDictionary	back to summary
public void attachDictionary(PreparedDictionary dictionary) throws IOException Annotations @Upstream

close	back to summary
pack-priv void close() throws IOException Annotations @Upstream

compress	back to summary
public static byte[] compress(byte[] data, int offset, int length, Encoder.Parameters params) throws IOException Annotations @Upstream

compress	back to summary
public static byte[] compress(byte[] data) throws IOException Annotations @Local

compress	back to summary
public static byte[] compress(byte[] data, Encoder.Parameters params) throws IOException Annotations @Upstream

compress	back to summary
public static byte[] compress(byte[] data, int offset, int length) throws IOException Annotations @Upstream

encode	back to summary
public boolean encode(EncoderJNI.Operation op) throws IOException Returns:boolean true if there is space in inputBuffer. Annotations @Local @Upstream

fail	back to summary
private void fail(String message) throws IOException Annotations @Upstream

flush	back to summary
public void flush() throws IOException Annotations @Local @Upstream

prepareDictionary back to summary

prepareDictionary	back to summary
public static PreparedDictionary prepareDictionary(ByteBuffer dictionary, int sharedDictionaryType) Prepares raw or serialized dictionary for being used by encoder. Parameters dictionary:ByteBuffer raw / serialized dictionary data; MUST be direct sharedDictionaryType:int dictionary data type Returns:PreparedDictionary `PreparedDictionary` instance Annotations @Upstream

public static PreparedDictionary prepareDictionary(ByteBuffer dictionary, int sharedDictionaryType)

Prepares raw or serialized dictionary for being used by encoder.

Parameters

dictionary:ByteBuffer: raw / serialized dictionary data; MUST be direct
sharedDictionaryType:int: dictionary data type

Returns:PreparedDictionary

PreparedDictionary instance

Annotations

@Upstream

pushOutput	back to summary
pack-priv boolean pushOutput(boolean force) throws IOException Parameters force:boolean repeat pushing until all output is consumed Returns:boolean true if all encoder output is consumed Annotations @Upstream

com.aayushatharva.brotli4j.encoder back to summary

public final Enum Encoder.Mode

Class Inheritance

extends Enum<Encoder.Mode>

java.lang.Object
java.lang.Enum
com.aayushatharva.brotli4j.encoder.Encoder.Mode

... See encode.h, typedef enum BrotliEncoderMode

Important Note

The ordinal value of the modes should be the same as the constant values in encode.h

Field Summary

Modifier and Type	Field and Description
private static final Encoder.Mode[]	ALL_VALUES
public static final Encoder.Mode	FONT Compression mode used in WOFF 2.0.
public static final Encoder.Mode	GENERIC Default compression mode.
public static final Encoder.Mode	TEXT Compression mode for UTF-8 formatted text input.

Constructor Summary

Access	Constructor and Description
private	Mode()

Method Summary

Modifier and Type	Method and Description
public static Encoder.Mode	of(int value)
public static Encoder.Mode	valueOf(String name)
public static Encoder.Mode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ALL_VALUES	back to summary
private static final Encoder.Mode[] ALL_VALUES

FONT	back to summary
public static final Encoder.Mode FONT Compression mode used in WOFF 2.0.

GENERIC	back to summary
public static final Encoder.Mode GENERIC Default compression mode. In this mode compressor does not know anything in advance about the properties of the input.

TEXT	back to summary
public static final Encoder.Mode TEXT Compression mode for UTF-8 formatted text input.

Constructor Detail

Mode	back to summary
private Mode()

Method Detail

of	back to summary
public static Encoder.Mode of(int value)

valueOf	back to summary
public static Encoder.Mode valueOf(String name)

values	back to summary
public static Encoder.Mode[] values()

com.aayushatharva.brotli4j.encoder back to summary

public final Class Encoder.Parameters

Class Inheritance

extends Object

java.lang.Object
com.aayushatharva.brotli4j.encoder.Encoder.Parameters

Annotations

@Upstream
@Local

Brotli encoder settings.

Field Summary

Modifier and Type	Field and Description
public static final Encoder.Parameters	DEFAULT
private int	lgwin
private Encoder.Mode	mode
private int	quality

Constructor Summary

Access	Constructor and Description
public	Parameters()
private	Parameters(Encoder.Parameters other)

Method Summary

Modifier and Type	Method and Description
public int	lgwin()
public Encoder.Mode	mode()
public int	quality()
public Encoder.Parameters	Returns: this instance setMode(Encoder.Mode compression mode, or `null` for default mode)
public Encoder.Parameters	Returns: this instance setQuality(int compression quality, or -1 for default quality)
public Encoder.Parameters	Returns: this instance setWindow(int log2(LZ window size), or -1 for default lgwin)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DEFAULT	back to summary
public static final Encoder.Parameters DEFAULT Annotations @Local

lgwin	back to summary
private int lgwin

mode	back to summary
private Encoder.Mode mode

quality	back to summary
private int quality

Constructor Detail

Parameters	back to summary
public Parameters()

Parameters	back to summary
private Parameters(Encoder.Parameters other)

Method Detail

lgwin	back to summary
public int lgwin()

mode	back to summary
public Encoder.Mode mode()

quality	back to summary
public int quality()

setMode	back to summary
public Encoder.Parameters setMode(Encoder.Mode mode) Parameters mode:Encoder.Mode compression mode, or `null` for default Returns:Encoder.Parameters this instance

setQuality	back to summary
public Encoder.Parameters setQuality(int quality) Parameters quality:int compression quality, or -1 for default Returns:Encoder.Parameters this instance

setWindow	back to summary
public Encoder.Parameters setWindow(int lgwin) Parameters lgwin:int log2(LZ window size), or -1 for default Returns:Encoder.Parameters this instance

public Class Encoder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum Encoder.Mode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class Encoder.Parameters

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail