org.apache.hc.client5.http.entity

Class DeflateInputStream

java.lang.Object

java.io.InputStream

org.apache.hc.client5.http.entity.DeflateInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class DeflateInputStream
extends InputStream

Deflate input stream. This class includes logic needed for various Rfc's in order to reasonably implement the "deflate" compression style.

Constructor Summary

Constructors

Constructor and Description
DeflateInputStream(InputStream wrapped)

Method Summary

Modifier and Type	Method and Description
int	available() Get available.
void	close() Close.
void	mark(int readLimit) Mark.
boolean	markSupported() Check if mark is supported.
int	read() Read a byte.
int	read(byte[] b) Read lots of bytes.
int	read(byte[] b, int off, int len) Read lots of specific bytes.
void	reset() Reset.
long	skip(long n) Skip

Methods inherited from class java.lang.Object

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

Constructor Detail

DeflateInputStream

public DeflateInputStream(InputStream wrapped)
                   throws IOException

Throws:

IOException

Method Detail

available

public int available()
              throws IOException

Get available.

Overrides:

available in class InputStream

Returns:

an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or 0 when it reaches the end of the input stream.

Throws:

IOException - if an I/O error occurs.

close

public void close()
           throws IOException

Close.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException - if an I/O error occurs.

mark

public void mark(int readLimit)

Mark.

Overrides:

mark in class InputStream

Parameters:

readLimit - the maximum limit of bytes that can be read before the mark position becomes invalid.

See Also:

InputStream.reset()

markSupported

public boolean markSupported()

Check if mark is supported.

Overrides:

markSupported in class InputStream

Returns:

true if this stream instance supports the mark and reset methods; false otherwise.

See Also:

InputStream.mark(int), InputStream.reset()

read

public int read()
         throws IOException

Read a byte.

Specified by:

read in class InputStream

Returns:

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

Throws:

IOException - if an I/O error occurs.

read

public int read(byte[] b)
         throws IOException

Read lots of bytes.

Overrides:

read in class InputStream

Parameters:

b - the buffer into which the data is read.

Returns:

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.

Throws:

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

See Also:

InputStream.read(byte[], int, int)

read

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

Read lots of specific bytes.

Overrides:

read in class InputStream

Parameters:

b - the buffer into which the data is read.

off - the start offset in array b at which the data is written.

len - the maximum number of bytes to read.

Returns:

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.

Throws:

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.

See Also:

InputStream.read()

reset

public void reset()
           throws IOException

Reset.

Overrides:

reset in class InputStream

Throws:

IOException - if this stream has not been marked or if the mark has been invalidated.

See Also:

InputStream.mark(int), IOException

skip

public long skip(long n)
          throws IOException

Skip

Overrides:

skip in class InputStream

Parameters:

n - the number of bytes to be skipped.

Returns:

the actual number of bytes skipped.

Throws:

IOException - if the stream does not support seek, or if some other I/O error occurs.