de.jarnbjo.jsnappy

Class SnzInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

de.jarnbjo.jsnappy.SnzInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

SnzMTInputStream

public class SnzInputStream
extends FilterInputStream

This class implements a stream filter for reading compressed data in the SNZ file format.

The data format is compatible to the snzip tool, which is available as a patch to the official Snappy source code.

Since:

1.0

Author:

Tor-Einar Jarnbjo

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
SnzInputStream(InputStream in) Creates a new SnzInputStream, reading from the provided InputStream in.

Method Summary

Methods

Modifier and Type	Method and Description
int	getBlockSize() Returns the block size of the snz stream.
int	read() Reads a single byte from the uncompressed stream.
int	read(byte[] b) Fills the byte array with data from the uncompressed stream.
int	read(byte[] b, int offset, int length) Fills the byte array with data from the uncompressed stream starting at the specified offset and no more than length bytes.

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

SnzInputStream

public SnzInputStream(InputStream in)

Creates a new SnzInputStream, reading from the provided InputStream in.

Parameters:

in -

Method Detail

getBlockSize

public int getBlockSize()
                 throws IOException

Returns the block size of the snz stream.

Returns:

snz stream block size

Throws:

IOException

read

public int read()
         throws IOException

Reads a single byte from the uncompressed stream.

Overrides:

read in class FilterInputStream

Returns:

the read byte or -1 if end of stream is reached

Throws:

FormatViolationException - if the input data is invalid

IOException

read

public int read(byte[] b)
         throws IOException

Fills the byte array with data from the uncompressed stream.

Overrides:

read in class FilterInputStream

Returns:

the number of bytes read or -1 if end of stream is reached

Throws:

FormatViolationException - if the input data is invalid

IOException

read

public int read(byte[] b,
       int offset,
       int length)
         throws IOException

Fills the byte array with data from the uncompressed stream starting at the specified offset and no more than length bytes.

Overrides:

read in class FilterInputStream

Parameters:

b - destination array

offset - offset into the byte array, on which the data is written

Returns:

the number of bytes read or -1 if end of stream is reached

Throws:

FormatViolationException - if the input data is invalid

IOException