Brotli4j 1.16.0 · com.aayushatharva.brotli4j.encoder.BrotliEncoderChannel

Modifier and Type	Field and Description
private static final int	DEFAULT_BUFFER_SIZE The default internal buffer size used by the decoder.
private final Object	mutex

Access	Constructor and Description
public	BrotliEncoderChannel(WritableByteChannel underlying destination destination, Encoder.Parameters encoding settings params, int intermediate buffer size bufferSize) Creates a BrotliEncoderChannel
public	BrotliEncoderChannel(WritableByteChannel underlying destination destination, Encoder.Parameters encoding settings params) Creates a BrotliEncoderChannel
public	BrotliEncoderChannel(WritableByteChannel underlying destination destination) Creates a BrotliEncoderChannel

Method Summary

Modifier and Type	Method and Description
public void	attachDictionary(PreparedDictionary dictionary) Overrides com.aayushatharva.brotli4j.encoder.Encoder.attachDictionary.
public void	close() Overrides com.aayushatharva.brotli4j.encoder.Encoder.close. Implements java.nio.channels.Channel.close. Closes this channel.
public boolean	isOpen() Implements java.nio.channels.Channel.isOpen. Tells whether or not this channel is open.
public int	write(ByteBuffer The buffer from which bytes are to be retrieved src) Implements java.nio.channels.WritableByteChannel.write. Writes a sequence of bytes to this channel from the given buffer.

Inherited from com.aayushatharva.brotli4j.encoder.Encoder:: compress compress compress compress encode flush prepareDictionary pushOutput

Field Detail

DEFAULT_BUFFER_SIZE	back to summary
private static final int DEFAULT_BUFFER_SIZE The default internal buffer size used by the decoder.

mutex	back to summary
private final Object mutex

Constructor Detail

BrotliEncoderChannel	back to summary
public BrotliEncoderChannel(WritableByteChannel destination, Encoder.Parameters params, int bufferSize) throws IOException Creates a BrotliEncoderChannel Parameters destination:WritableByteChannel underlying destination params:Encoder.Parameters encoding settings bufferSize:int intermediate buffer size Exceptions IOException: If any failure during initialization

BrotliEncoderChannel

back to summary

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

Creates a BrotliEncoderChannel

Parameters

destination:WritableByteChannel: underlying destination
params:Encoder.Parameters: encoding settings
bufferSize:int: intermediate buffer size

Exceptions

IOException:: If any failure during initialization

BrotliEncoderChannel	back to summary
public BrotliEncoderChannel(WritableByteChannel destination, Encoder.Parameters params) throws IOException Creates a BrotliEncoderChannel Parameters destination:WritableByteChannel underlying destination params:Encoder.Parameters encoding settings Exceptions IOException: If any failure during initialization

BrotliEncoderChannel

back to summary

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

Creates a BrotliEncoderChannel

Parameters

destination:WritableByteChannel: underlying destination
params:Encoder.Parameters: encoding settings

Exceptions

IOException:: If any failure during initialization

BrotliEncoderChannel	back to summary
public BrotliEncoderChannel(WritableByteChannel destination) throws IOException Creates a BrotliEncoderChannel Parameters destination:WritableByteChannel underlying destination Exceptions IOException: If any failure during initialization

BrotliEncoderChannel

back to summary

public BrotliEncoderChannel(WritableByteChannel destination) throws IOException

Creates a BrotliEncoderChannel

Parameters

destination:WritableByteChannel: underlying destination

Exceptions

IOException:: If any failure during initialization

Method Detail

attachDictionary	back to summary
public void attachDictionary(PreparedDictionary dictionary) throws IOException Overrides com.aayushatharva.brotli4j.encoder.Encoder.attachDictionary. Annotations @Override

attachDictionary

back to summary

public void attachDictionary(PreparedDictionary dictionary) throws IOException

Overrides com.aayushatharva.brotli4j.encoder.Encoder.attachDictionary.

Annotations

@Override

close back to summary

close	back to summary
public void close() throws IOException Overrides com.aayushatharva.brotli4j.encoder.Encoder.close. Implements java.nio.channels.Channel.close. Doc from java.nio.channels.Channel.close. Closes this channel. After a channel is closed, any further attempt to invoke I/O operations upon it will cause a `ClosedChannelException` to be thrown. If this channel is already closed then invoking this method has no effect. This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect. Annotations @Override Exceptions IOException: If an I/O error occurs

public void close() throws IOException

Overrides com.aayushatharva.brotli4j.encoder.Encoder.close.

Implements java.nio.channels.Channel.close.

Doc from java.nio.channels.Channel.close.

Closes this channel.

After a channel is closed, any further attempt to invoke I/O operations upon it will cause a ClosedChannelException to be thrown.

If this channel is already closed then invoking this method has no effect.

This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

isOpen back to summary

isOpen	back to summary
public boolean isOpen() Implements java.nio.channels.Channel.isOpen. Doc from java.nio.channels.Channel.isOpen. Tells whether or not this channel is open. Returns:boolean `true` if, and only if, this channel is open Annotations @Override

public boolean isOpen()

Implements java.nio.channels.Channel.isOpen.

Doc from java.nio.channels.Channel.isOpen.

Tells whether or not this channel is open.

Returns:boolean

true if, and only if, this channel is open

Annotations

@Override

write back to summary

write	back to summary
public int write(ByteBuffer src) throws IOException Implements java.nio.channels.WritableByteChannel.write. Doc from java.nio.channels.WritableByteChannel.write. Writes a sequence of bytes to this channel from the given buffer. An attempt is made to write up to r bytes to the channel, where r is the number of bytes remaining in the buffer, that is, `src.remaining()`, at the moment this method is invoked. Suppose that a byte sequence of length n is written, where `0` `<=` n `<=` r. This byte sequence will be transferred from the buffer starting at index p, where p is the buffer's position at the moment this method is invoked; the index of the last byte written will be p `+` n `-` `1`. Upon return the buffer's position will be equal to p `+` n; its limit will not have changed. Unless otherwise specified, a write operation will return only after writing all of the r requested bytes. Some types of channels, depending upon their state, may write only some of the bytes or possibly none at all. A socket channel in non-blocking mode, for example, cannot write any more bytes than are free in the socket's output buffer. This method may be invoked at any time. If another thread has already initiated a write operation upon this channel, however, then an invocation of this method will block until the first operation is complete. Parameters src:ByteBuffer The buffer from which bytes are to be retrieved Returns:int The number of bytes written, possibly zero Annotations @Override Exceptions IOException: If some other I/O error occurs

public int write(ByteBuffer src) throws IOException

Implements java.nio.channels.WritableByteChannel.write.

Doc from java.nio.channels.WritableByteChannel.write.

Writes a sequence of bytes to this channel from the given buffer.

An attempt is made to write up to r bytes to the channel, where r is the number of bytes remaining in the buffer, that is, src.remaining(), at the moment this method is invoked.

Suppose that a byte sequence of length n is written, where 0 <= n <= r. This byte sequence will be transferred from the buffer starting at index p, where p is the buffer's position at the moment this method is invoked; the index of the last byte written will be p + n - 1. Upon return the buffer's position will be equal to p + n; its limit will not have changed.

Unless otherwise specified, a write operation will return only after writing all of the r requested bytes. Some types of channels, depending upon their state, may write only some of the bytes or possibly none at all. A socket channel in non-blocking mode, for example, cannot write any more bytes than are free in the socket's output buffer.

This method may be invoked at any time. If another thread has already initiated a write operation upon this channel, however, then an invocation of this method will block until the first operation is complete.

Parameters

src:ByteBuffer: The buffer from which bytes are to be retrieved

Returns:int

The number of bytes written, possibly zero

Annotations

@Override

Exceptions

IOException:: If some other I/O error occurs

public Class BrotliEncoderChannel

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail