org.xerial.snappy

Class SnappyFramedInputStream

java.lang.Object

java.io.InputStream

org.xerial.snappy.SnappyFramedInputStream

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, ReadableByteChannel

public final class SnappyFramedInputStream
extends InputStream
implements ReadableByteChannel

Implements the x-snappy-framed as an InputStream and ReadableByteChannel.

Since:

1.1.0

Author:

Brett Okken

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SnappyFramedInputStream.FrameData
static class	SnappyFramedInputStream.FrameMetaData

Constructor Summary

Constructors

Constructor and Description
SnappyFramedInputStream(InputStream in) Creates a Snappy input stream to read data from the specified underlying input stream.
SnappyFramedInputStream(InputStream in, boolean verifyChecksums) Creates a Snappy input stream to read data from the specified underlying input stream.
SnappyFramedInputStream(InputStream in, boolean verifyChecksums, BufferPool bufferPool) Creates a Snappy input stream to read data from the specified underlying input stream.
SnappyFramedInputStream(InputStream in, BufferPool bufferPool) Creates a Snappy input stream to read data from the specified underlying input stream.
SnappyFramedInputStream(ReadableByteChannel in) Creates a Snappy input stream to read data from the specified underlying channel.
SnappyFramedInputStream(ReadableByteChannel in, boolean verifyChecksums) Creates a Snappy input stream to read data from the specified underlying channel.
SnappyFramedInputStream(ReadableByteChannel in, boolean verifyChecksums, BufferPool bufferPool) Creates a Snappy input stream to read data from the specified underlying channel.
SnappyFramedInputStream(ReadableByteChannel in, BufferPool bufferPool) Creates a Snappy input stream to read data from the specified underlying channel.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
boolean	isOpen()
int	read()
int	read(byte[] output, int offset, int length)
int	read(ByteBuffer dst)
long	transferTo(OutputStream os) Transfers the entire content of this InputStream to os.
long	transferTo(WritableByteChannel wbc) Transfers the entire content of this ReadableByteChannel to wbc.

Methods inherited from class java.io.InputStream

mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

SnappyFramedInputStream

public SnappyFramedInputStream(InputStream in)
                        throws IOException

Creates a Snappy input stream to read data from the specified underlying input stream.

Uses DefaultPoolFactory to obtain BufferPool for buffers.

Parameters:

in - the underlying input stream. Must not be null.

Throws:

IOException

SnappyFramedInputStream

public SnappyFramedInputStream(InputStream in,
                               BufferPool bufferPool)
                        throws IOException

Creates a Snappy input stream to read data from the specified underlying input stream.

Parameters:

in - the underlying input stream. Must not be null.

bufferPool - Used to obtain buffer instances. Must not be null.

Throws:

IOException

SnappyFramedInputStream

public SnappyFramedInputStream(InputStream in,
                               boolean verifyChecksums)
                        throws IOException

Creates a Snappy input stream to read data from the specified underlying input stream.

Uses DefaultPoolFactory to obtain BufferPool for buffers.

Parameters:

in - the underlying input stream. Must not be null.

verifyChecksums - if true, checksums in input stream will be verified

Throws:

IOException

SnappyFramedInputStream

public SnappyFramedInputStream(InputStream in,
                               boolean verifyChecksums,
                               BufferPool bufferPool)
                        throws IOException

Creates a Snappy input stream to read data from the specified underlying input stream.

Parameters:

in - the underlying input stream. Must not be null.

verifyChecksums - if true, checksums in input stream will be verified

bufferPool - Used to obtain buffer instances. Must not be null.

Throws:

IOException

SnappyFramedInputStream

public SnappyFramedInputStream(ReadableByteChannel in,
                               BufferPool bufferPool)
                        throws IOException

Creates a Snappy input stream to read data from the specified underlying channel.

Parameters:

in - the underlying readable channel. Must not be null.

bufferPool - Used to obtain buffer instances. Must not be null.

Throws:

IOException

SnappyFramedInputStream

public SnappyFramedInputStream(ReadableByteChannel in)
                        throws IOException

Creates a Snappy input stream to read data from the specified underlying channel.

Uses DefaultPoolFactory to obtain BufferPool for buffers.

Parameters:

in - the underlying readable channel. Must not be null.

Throws:

IOException

SnappyFramedInputStream

public SnappyFramedInputStream(ReadableByteChannel in,
                               boolean verifyChecksums)
                        throws IOException

Creates a Snappy input stream to read data from the specified underlying channel.

Uses DefaultPoolFactory to obtain BufferPool for buffers.

Parameters:

in - the underlying readable channel. Must not be null.

verifyChecksums - if true, checksums in input stream will be verified

Throws:

IOException

SnappyFramedInputStream

public SnappyFramedInputStream(ReadableByteChannel in,
                               boolean verifyChecksums,
                               BufferPool bufferPool)
                        throws IOException

Creates a Snappy input stream to read data from the specified underlying channel.

Parameters:

in - the underlying readable channel. Must not be null.

verifyChecksums - if true, checksums in input stream will be verified

bufferPool - Used to obtain buffer instances. Must not be null.

Throws:

IOException

Method Detail

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

read

public int read(ByteBuffer dst)
         throws IOException

Specified by:

read in interface ReadableByteChannel

Throws:

IOException

transferTo

public long transferTo(OutputStream os)
                throws IOException

Transfers the entire content of this InputStream to os. This potentially limits the amount of buffering required to decompress content.

Unlike read(byte[], int, int), this method does not need to be called multiple times. A single call will transfer all available content. Any calls after the source has been exhausted will result in a return value of 0.

Parameters:

os - The destination to write decompressed content to.

Returns:

The number of bytes transferred.

Throws:

IOException

Since:

1.1.1

transferTo

public long transferTo(WritableByteChannel wbc)
                throws IOException

Transfers the entire content of this ReadableByteChannel to wbc. This potentially limits the amount of buffering required to decompress content.

Unlike read(ByteBuffer), this method does not need to be called multiple times. A single call will transfer all available content. Any calls after the source has been exhausted will result in a return value of 0.

Parameters:

wbc - The destination to write decompressed content to.

Returns:

The number of bytes transferred.

Throws:

IOException

Since:

1.1.1

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Overrides:

close in class InputStream

Throws:

IOException