OpenJDK 27 · java.util.zip.DeflaterInputStream · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
protected final byte[]	buf Input buffer for reading compressed data.
protected final Deflater	def Compressor for this stream.
private byte[]	rbuf Temporary read buffer.
private boolean	reachEOF End of the underlying input stream has been reached.
private boolean	usesDefaultDeflater Default compressor is used.

Access	Constructor and Description
public	DeflaterInputStream(InputStream input stream to read the uncompressed data to in) Creates a new input stream and compressor with the default compression level and a default buffer size.
public	DeflaterInputStream(InputStream input stream to read the uncompressed data to in, Deflater compressor ("deflater") for this stream defl) Creates a new input stream with the specified compressor and a default buffer size.
public	DeflaterInputStream(InputStream input stream to read the uncompressed data to in, Deflater compressor ("deflater") for this stream defl, int compression buffer size bufLen) Creates a new input stream with the specified compressor and buffer size.

Method Summary

Modifier and Type	Method and Description
public int	Returns: zero after the end of the underlying input stream has been reached, otherwise always returns 1 available() Overrides java.io.FilterInputStream.available. Returns 0 after EOF has been reached, otherwise always return 1.
public void	close() Overrides java.io.FilterInputStream.close. Implements java.io.Closeable.close. Closes this input stream and its underlying input stream, discarding any pending uncompressed data.
private void	ensureOpen() Check to make sure that this stream has not been closed.
public void	mark(int maximum bytes that can be read before invalidating the position marker limit) Overrides java.io.FilterInputStream.mark. This operation is not supported.
public boolean	Returns: false, always markSupported() Overrides java.io.FilterInputStream.markSupported. Always returns `false` because this input stream does not support the `mark()` and `reset()` methods.
public int	Returns: a single byte of compressed data, or -1 if the end of the uncompressed input stream is reached read() Overrides java.io.FilterInputStream.read. Reads a single byte of compressed data from the input stream.
public int	Returns: the actual number of bytes read, or -1 if the end of the uncompressed input stream is reached read(byte[] buffer into which the data is read b, int starting offset of the data within `b` off, int maximum number of compressed bytes to read into `b` len) Overrides java.io.FilterInputStream.read. Reads compressed data into a byte array.
public void	reset() Overrides java.io.FilterInputStream.reset. This operation is not supported.
public long	Returns: the actual number of bytes skipped, which might be zero skip(long number of bytes to be skipped. If `n` is zero then no bytes are skipped. n) Overrides java.io.FilterInputStream.skip. Skips over and discards data from the input stream.

Inherited from java.io.FilterInputStream:: read

Field Detail

buf	back to summary
protected final byte[] buf Input buffer for reading compressed data.

def	back to summary
protected final Deflater def Compressor for this stream.

rbuf	back to summary
private byte[] rbuf Temporary read buffer.

reachEOF	back to summary
private boolean reachEOF End of the underlying input stream has been reached.

usesDefaultDeflater	back to summary
private boolean usesDefaultDeflater Default compressor is used.

Constructor Detail

DeflaterInputStream back to summary

DeflaterInputStream	back to summary
public DeflaterInputStream(InputStream in) Creates a new input stream and compressor with the default compression level and a default buffer size. The compressor will be closed when this input stream is closed. Parameters in:InputStream input stream to read the uncompressed data to Exceptions NullPointerException: if `in` is null

public DeflaterInputStream(InputStream in)

Creates a new input stream and compressor with the default compression level and a default buffer size.

The compressor will be closed when this input stream is closed.

Parameters

in:InputStream: input stream to read the uncompressed data to

Exceptions

NullPointerException:: if in is null

DeflaterInputStream back to summary

DeflaterInputStream	back to summary
public DeflaterInputStream(InputStream in, Deflater defl) Creates a new input stream with the specified compressor and a default buffer size. Closing this input stream will not close the given compressor. Parameters in:InputStream input stream to read the uncompressed data to defl:Deflater compressor ("deflater") for this stream Exceptions NullPointerException: if `in` or `defl` is null

public DeflaterInputStream(InputStream in, Deflater defl)

Creates a new input stream with the specified compressor and a default buffer size.

Closing this input stream will not close the given compressor.

Parameters

in:InputStream: input stream to read the uncompressed data to
defl:Deflater: compressor ("deflater") for this stream

Exceptions

NullPointerException:: if in or defl is null

DeflaterInputStream back to summary

DeflaterInputStream	back to summary
public DeflaterInputStream(InputStream in, Deflater defl, int bufLen) Creates a new input stream with the specified compressor and buffer size. Closing this input stream will not close the given compressor. Parameters in:InputStream input stream to read the uncompressed data to defl:Deflater compressor ("deflater") for this stream bufLen:int compression buffer size Exceptions IllegalArgumentException: if `bufLen <= 0` NullPointerException: if `in` or `defl` is null

public DeflaterInputStream(InputStream in, Deflater defl, int bufLen)

Creates a new input stream with the specified compressor and buffer size.

Closing this input stream will not close the given compressor.

Parameters

in:InputStream: input stream to read the uncompressed data to
defl:Deflater: compressor ("deflater") for this stream
bufLen:int: compression buffer size

Exceptions

IllegalArgumentException:: if bufLen <= 0
NullPointerException:: if in or defl is null

Method Detail

available	back to summary
public int available() throws IOException Overrides java.io.FilterInputStream.available. Returns 0 after EOF has been reached, otherwise always return 1. Programs should not count on this method to return the actual number of bytes that could be read without blocking Returns:int zero after the end of the underlying input stream has been reached, otherwise always returns 1 Annotations @Override Exceptions IOException: if an I/O error occurs or if this stream is already closed

available

back to summary

public int available() throws IOException

Overrides java.io.FilterInputStream.available.

Returns 0 after EOF has been reached, otherwise always return 1.

Programs should not count on this method to return the actual number of bytes that could be read without blocking

Returns:int

zero after the end of the underlying input stream has been reached, otherwise always returns 1

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs or if this stream is already closed

close	back to summary
public void close() throws IOException Overrides java.io.FilterInputStream.close. Implements java.io.Closeable.close. Closes this input stream and its underlying input stream, discarding any pending uncompressed data. Annotations @Override Exceptions IOException: if an I/O error occurs

back to summary

public void close() throws IOException

Overrides java.io.FilterInputStream.close.

Implements java.io.Closeable.close.

Closes this input stream and its underlying input stream, discarding any pending uncompressed data.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

ensureOpen	back to summary
private void ensureOpen() throws IOException Check to make sure that this stream has not been closed.

mark	back to summary
public void mark(int limit) Overrides java.io.FilterInputStream.mark. This operation is not supported. Parameters limit:int maximum bytes that can be read before invalidating the position marker Annotations @Override

mark

back to summary

public void mark(int limit)

Overrides java.io.FilterInputStream.mark.

This operation is not supported.

Parameters

limit:int: maximum bytes that can be read before invalidating the position marker

Annotations

@Override

markSupported back to summary

markSupported	back to summary
public boolean markSupported() Overrides java.io.FilterInputStream.markSupported. Always returns `false` because this input stream does not support the `mark()` and `reset()` methods. Returns:boolean false, always Annotations @Override

public boolean markSupported()

Overrides java.io.FilterInputStream.markSupported.

Always returns false because this input stream does not support the mark() and reset() methods.

Returns:boolean

false, always

Annotations

@Override

read	back to summary
public int read() throws IOException Overrides java.io.FilterInputStream.read. Reads a single byte of compressed data from the input stream. This method will block until some input can be read and compressed. Returns:int a single byte of compressed data, or -1 if the end of the uncompressed input stream is reached Annotations @Override Exceptions IOException: if an I/O error occurs or if this stream is already closed

read

back to summary

public int read() throws IOException

Overrides java.io.FilterInputStream.read.

Reads a single byte of compressed data from the input stream. This method will block until some input can be read and compressed.

Returns:int

a single byte of compressed data, or -1 if the end of the uncompressed input stream is reached

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs or if this stream is already closed

read back to summary

read	back to summary
public int read(byte[] b, int off, int len) throws IOException Overrides java.io.FilterInputStream.read. Reads compressed data into a byte array. This method will block until some input can be read and compressed. Parameters b:byte[] buffer into which the data is read off:int starting offset of the data within `b` len:int maximum number of compressed bytes to read into `b` Returns:int the actual number of bytes read, or -1 if the end of the uncompressed input stream is reached Annotations @Override Exceptions IOException: if an I/O error occurs or if this input stream is already closed NullPointerException: if `b` is null IndexOutOfBoundsException: if `len > b.length - off`

public int read(byte[] b, int off, int len) throws IOException

Overrides java.io.FilterInputStream.read.

Reads compressed data into a byte array. This method will block until some input can be read and compressed.

Parameters

b:byte[]: buffer into which the data is read
off:int: starting offset of the data within b
len:int: maximum number of compressed bytes to read into b

Returns:int

the actual number of bytes read, or -1 if the end of the uncompressed input stream is reached

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs or if this input stream is already closed
NullPointerException:: if b is null
IndexOutOfBoundsException:: if len > b.length - off

reset	back to summary
public void reset() throws IOException Overrides java.io.FilterInputStream.reset. This operation is not supported. Annotations @Override Exceptions IOException: always thrown

reset

back to summary

public void reset() throws IOException

Overrides java.io.FilterInputStream.reset.

This operation is not supported.

Annotations

@Override

Exceptions

IOException:: always thrown

skip back to summary

skip	back to summary
public long skip(long n) throws IOException Overrides java.io.FilterInputStream.skip. Skips over and discards data from the input stream. This method may block until the specified number of bytes are skipped or end of stream is reached. Implementation Note This method skips at most `Integer.MAX_VALUE` bytes. Parameters n:long number of bytes to be skipped. If `n` is zero then no bytes are skipped. Returns:long the actual number of bytes skipped, which might be zero Annotations @Override Exceptions IOException: if an I/O error occurs or if this stream is already closed IllegalArgumentException: if `n < 0`

public long skip(long n) throws IOException

Overrides java.io.FilterInputStream.skip.

Skips over and discards data from the input stream. This method may block until the specified number of bytes are skipped or end of stream is reached.

Implementation Note

This method skips at most Integer.MAX_VALUE bytes.

Parameters

n:long: number of bytes to be skipped. If n is zero then no bytes are skipped.

Returns:long

the actual number of bytes skipped, which might be zero

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs or if this stream is already closed
IllegalArgumentException:: if n < 0

public Class DeflaterInputStream

Compressor Usage

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail