Module ibm.jzos

Package com.ibm.jzos

Class ZCompressorInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.ibm.jzos.ZCompressorInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class ZCompressorInputStream
extends FilterInputStream

A subclass of InputStream that will expand data from an enclosed InputStream containing data that was compressed by the same z/Architecture compression dictionaries. Not thread safe.

Since:

2.4.4

See Also:

• ZCompressor

Constructor Summary

Constructors

Constructor	Description
ZCompressorInputStream(ZCompressor compressor, InputStream in)	Create a new input stream with default buffer size.
ZCompressorInputStream(ZCompressor compressor, InputStream in, int buflen)	Create a new input stream with the specified buffer size.

Method Summary

Modifier and Type	Method	Description
int	available()	Returns an estimate of the number of bytes that can be read.
void	close()
long	getTotalExpandedBytes()	Answer the total number of bytes expanded so far.
long	getTotalSourceBytes()	Answer the total number of compressed bytes read so far.
void	mark(int limit)	Does nothing, not supported.
boolean	markSupported()	Always returns false, mark/reset is not supported.
int	read()
int	read(byte[] b)
int	read(byte[] readBuf, int readBufOff, int readBufLen)
void	releaseZCompressorOnClose(boolean value)	Sets a flag that will cause the ZCompressor resources to be released when this OutputStream is closed.
void	reset()	This method is not supported and always throws an IOException.
long	skip(long n)	This method is not supported and always throws an IOException.

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

ZCompressorInputStream

public ZCompressorInputStream(ZCompressor compressor,
 InputStream in)

Create a new input stream with default buffer size.

Parameters:

compressor - the ZCompressor object used to expand data

in - the InputStream containing compressed data

ZCompressorInputStream

public ZCompressorInputStream(ZCompressor compressor,
 InputStream in,
 int buflen)

Create a new input stream with the specified buffer size.

Parameters:

compressor - the ZCompressor object used to expand data

in - the InputStream containing compressed data

buflen - the length of internal compression and expansion buffers

Method Details

releaseZCompressorOnClose

public void releaseZCompressorOnClose(boolean value)

Sets a flag that will cause the ZCompressor resources to be released when this OutputStream is closed. Defaults to false.

getTotalSourceBytes

public long getTotalSourceBytes()

Answer the total number of compressed bytes read so far.

Returns:

the total number of compressed bytes read so far

getTotalExpandedBytes

public long getTotalExpandedBytes()

Answer the total number of bytes expanded so far.

Returns:

the total number of bytes expanded so far

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterInputStream

Throws:

IOException

See Also:

• InputStream.close()

read

public int read()
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

See Also:

• InputStream.read()

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

See Also:

• InputStream.read(byte[])

read

public int read(byte[] readBuf,
 int readBufOff,
 int readBufLen)
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

See Also:

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

skip

public long skip(long n)
          throws IOException

This method is not supported and always throws an IOException.

Overrides:

skip in class FilterInputStream

Throws:

IOException - always throws IOException since skip() is not supported

See Also:

• InputStream.skip(long)

available

public int available()
              throws IOException

Returns an estimate of the number of bytes that can be read. Note that this is not in any way an estimate of the amount of expanded data available. A positive integer does indicate, however that more is available.

Overrides:

available in class FilterInputStream

Throws:

IOException

See Also:

• InputStream.available()

markSupported

public boolean markSupported()

Always returns false, mark/reset is not supported.

Overrides:

markSupported in class FilterInputStream

See Also:

• InputStream.markSupported()

mark

public void mark(int limit)

Does nothing, not supported.

Overrides:

mark in class FilterInputStream

See Also:

• InputStream.mark(int)

reset

public void reset()
           throws IOException

This method is not supported and always throws an IOException.

Overrides:

reset in class FilterInputStream

Throws:

IOException - since mark/reset is not supported

See Also:

• InputStream.reset()