DeflaterInputStream (Java Platform SE 6) (original) (raw)

java.util.zip

Class DeflaterInputStream

java.lang.Object java.io.InputStream java.io.FilterInputStream java.util.zip.DeflaterInputStream

All Implemented Interfaces:

Closeable

public class DeflaterInputStream

extends FilterInputStream

Implements an input stream filter for compressing data in the "deflate" compression format.

Since:

1.6

See Also:

DeflaterOutputStream, InflaterOutputStream, InflaterInputStream

def

protected final Deflater def

Compressor for this stream.

buf

protected final byte[] buf

Input buffer for reading compressed data.

DeflaterInputStream

public DeflaterInputStream(InputStream in)

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

Parameters:

in - input stream to read the uncompressed data to

Throws:

[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang") - if in is null

DeflaterInputStream

public DeflaterInputStream(InputStream in, Deflater defl)

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

Parameters:

in - input stream to read the uncompressed data to

defl - compressor ("deflater") for this stream

Throws:

[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang") - if in or defl is null

DeflaterInputStream

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

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

Parameters:

in - input stream to read the uncompressed data to

defl - compressor ("deflater") for this stream

bufLen - compression buffer size

Throws:

[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - if bufLen is <= 0

[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang") - if in or defl is null

close

public void close() throws IOException

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

Specified by:

[close](../../../java/io/Closeable.html#close%28%29) in interface [Closeable](../../../java/io/Closeable.html "interface in java.io")

Overrides:

[close](../../../java/io/FilterInputStream.html#close%28%29) in class [FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs

See Also:

FilterInputStream.in

read

public int read() throws IOException

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

Overrides:

[read](../../../java/io/FilterInputStream.html#read%28%29) in class [FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")

Returns:

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

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs or if this stream is already closed

See Also:

FilterInputStream.in

read

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

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

Overrides:

[read](../../../java/io/FilterInputStream.html#read%28byte[], int, int%29) in class [FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")

Parameters:

b - buffer into which the data is read

off - starting offset of the data within b

len - maximum number of compressed bytes to read into b

Returns:

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

Throws:

[IndexOutOfBoundsException](../../../java/lang/IndexOutOfBoundsException.html "class in java.lang") - if len > b.length - off

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs or if this input stream is already closed

See Also:

FilterInputStream.in

skip

public long skip(long n) throws IOException

Skips over and discards data from the input stream. This method may block until the specified number of bytes are read and skipped. Note: While n is given as a long, the maximum number of bytes which can be skipped isInteger.MAX_VALUE.

Overrides:

[skip](../../../java/io/FilterInputStream.html#skip%28long%29) in class [FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")

Parameters:

n - number of bytes to be skipped

Returns:

the actual number of bytes skipped

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs or if this stream is already closed

available

public int available() throws IOException

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

Overrides:

[available](../../../java/io/FilterInputStream.html#available%28%29) in class [FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")

Returns:

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

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error occurs or if this stream is already closed

markSupported

public boolean markSupported()

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

Overrides:

[markSupported](../../../java/io/FilterInputStream.html#markSupported%28%29) in class [FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")

Returns:

false, always

See Also:

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

mark

public void mark(int limit)

This operation is not supported.

Overrides:

[mark](../../../java/io/FilterInputStream.html#mark%28int%29) in class [FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")

Parameters:

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

See Also:

FilterInputStream.in, FilterInputStream.reset()

reset

public void reset() throws IOException

This operation is not supported.

Overrides:

[reset](../../../java/io/FilterInputStream.html#reset%28%29) in class [FilterInputStream](../../../java/io/FilterInputStream.html "class in java.io")

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - always thrown

See Also:

FilterInputStream.in, FilterInputStream.mark(int)

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Scripting on this page tracks web page traffic, but does not change the content in any way.