org.brotli:dec 0.1.2 · org.brotli.dec.BrotliInputStream

Modifier and Type	Field and Description
private byte[]	buffer Internal buffer used for efficient byte-by-byte reading.
private int	bufferOffset Next unused byte offset.
public static final int	DEFAULT_INTERNAL_BUFFER_SIZE
private int	remainingBufferBytes Number of decoded but still unused bytes in internal buffer.
private final State	state Decoder state.

Access	Constructor and Description
public	BrotliInputStream(InputStream underlying data source source) Creates a `InputStream` wrapper that decompresses brotli data.
public	BrotliInputStream(InputStream compressed data source source, int size of internal buffer used in case of byte-by-byte reading byteReadBufferSize) Creates a `InputStream` wrapper that decompresses brotli data.
public	BrotliInputStream(InputStream compressed data source source, int size of internal buffer used in case of byte-by-byte reading byteReadBufferSize, byte[] custom dictionary data; `null` if not used customDictionary) Creates a `InputStream` wrapper that decompresses brotli data.

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Closes this input stream and releases any system resources associated with the stream.
public int	read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.
public int	read(byte[] the buffer into which the data is read. destBuffer, int the start offset in array `b` at which the data is written. destOffset, int the maximum number of bytes to read. destLen) Overrides java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes.

Inherited from java.io.InputStream:: available mark markSupported nullInputStream read readAllBytes readNBytes readNBytes reset skip skipNBytes transferTo

Field Detail

buffer	back to summary
private byte[] buffer Internal buffer used for efficient byte-by-byte reading.

bufferOffset	back to summary
private int bufferOffset Next unused byte offset.

DEFAULT_INTERNAL_BUFFER_SIZE	back to summary
public static final int DEFAULT_INTERNAL_BUFFER_SIZE

remainingBufferBytes	back to summary
private int remainingBufferBytes Number of decoded but still unused bytes in internal buffer.

state	back to summary
private final State state Decoder state.

Constructor Detail

BrotliInputStream back to summary

BrotliInputStream	back to summary
public BrotliInputStream(InputStream source) throws IOException Creates a `InputStream` wrapper that decompresses brotli data. For byte-by-byte reading (`read()`) internal buffer with `DEFAULT_INTERNAL_BUFFER_SIZE` size is allocated and used. Will block the thread until first kilobyte of data of source is available. Parameters source:InputStream underlying data source Exceptions IOException: in case of corrupted data or source stream problems

public BrotliInputStream(InputStream source) throws IOException

Creates a InputStream wrapper that decompresses brotli data.

For byte-by-byte reading (read()) internal buffer with DEFAULT_INTERNAL_BUFFER_SIZE size is allocated and used.

Will block the thread until first kilobyte of data of source is available.

Parameters

source:InputStream: underlying data source

Exceptions

IOException:: in case of corrupted data or source stream problems

BrotliInputStream back to summary

BrotliInputStream	back to summary
public BrotliInputStream(InputStream source, int byteReadBufferSize) throws IOException Creates a `InputStream` wrapper that decompresses brotli data. For byte-by-byte reading (`read()`) internal buffer of specified size is allocated and used. Will block the thread until first kilobyte of data of source is available. Parameters source:InputStream compressed data source byteReadBufferSize:int size of internal buffer used in case of byte-by-byte reading Exceptions IOException: in case of corrupted data or source stream problems

public BrotliInputStream(InputStream source, int byteReadBufferSize) throws IOException

Creates a InputStream wrapper that decompresses brotli data.

For byte-by-byte reading (read()) internal buffer of specified size is allocated and used.

Will block the thread until first kilobyte of data of source is available.

Parameters

source:InputStream: compressed data source
byteReadBufferSize:int: size of internal buffer used in case of byte-by-byte reading

Exceptions

IOException:: in case of corrupted data or source stream problems

BrotliInputStream back to summary

BrotliInputStream	back to summary
public BrotliInputStream(InputStream source, int byteReadBufferSize, byte[] customDictionary) throws IOException Creates a `InputStream` wrapper that decompresses brotli data. For byte-by-byte reading (`read()`) internal buffer of specified size is allocated and used. Will block the thread until first kilobyte of data of source is available. Parameters source:InputStream compressed data source byteReadBufferSize:int size of internal buffer used in case of byte-by-byte reading customDictionary:byte[] custom dictionary data; `null` if not used Exceptions IOException: in case of corrupted data or source stream problems

public BrotliInputStream(InputStream source, int byteReadBufferSize, byte[] customDictionary) throws IOException

Creates a InputStream wrapper that decompresses brotli data.

For byte-by-byte reading (read()) internal buffer of specified size is allocated and used.

Will block the thread until first kilobyte of data of source is available.

Parameters

source:InputStream: compressed data source
byteReadBufferSize:int: size of internal buffer used in case of byte-by-byte reading
customDictionary:byte[]: custom dictionary data; null if not used

Exceptions

IOException:: in case of corrupted data or source stream problems

Method Detail

close	back to summary
public void close() throws IOException Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Doc from java.io.InputStream.close. Closes this input stream and releases any system resources associated with the stream. Annotations @Override Exceptions IOException: if an I/O error occurs.

back to summary

public void close() throws IOException

Overrides java.io.InputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.InputStream.close.

Closes this input stream and releases any system resources associated with the stream.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read() throws IOException Implements abstract java.io.InputStream.read. Doc from java.io.InputStream.read. Reads the next byte of data from the input stream. The value byte is returned as an `int` in the range `0` to `255`. If no byte is available because the end of the stream has been reached, the value `-1` is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. Returns:int the next byte of data, or `-1` if the end of the stream is reached. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(byte[] destBuffer, int destOffset, int destLen) throws IOException Overrides java.io.InputStream.read. Doc from java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes. An attempt is made to read as many as `len` bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown. If `len` is zero, then no bytes are read and `0` is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value `-1` is returned; otherwise, at least one byte is read and stored into `b`. The first byte read is stored into element `b[off]`, the next one into `b[off+1]`, and so on. The number of bytes read is, at most, equal to `len`. Let k be the number of bytes actually read; these bytes will be stored in elements `b[off]` through `b[off+`k`-1]`, leaving elements `b[off+`k`]` through `b[off+len-1]` unaffected. In every case, elements `b[0]` through `b[off-1]` and elements `b[off+len]` through `b[b.length-1]` are unaffected. Parameters destBuffer:byte[] the buffer into which the data is read. destOffset:int the start offset in array `b` at which the data is written. destLen:int the maximum number of bytes to read. Returns:int the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the stream has been reached. Annotations @Override Exceptions IOException: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

public int read(byte[] destBuffer, int destOffset, int destLen) throws IOException

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off-1] and elements b[off+len] through b[b.length-1] are unaffected.

Parameters

destBuffer:byte[]: the buffer into which the data is read.
destOffset:int: the start offset in array b at which the data is written.
destLen:int: the maximum number of bytes to read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Annotations

@Override

Exceptions

IOException:: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

public Class BrotliInputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail