Package org.iq80.snappy

Class AbstractSnappyInputStream

java.lang.Object

java.io.InputStream

org.iq80.snappy.AbstractSnappyInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

SnappyFramedInputStream, SnappyInputStream

abstract class AbstractSnappyInputStream
extends InputStream

A common base class for frame based snappy input streams.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static enum	AbstractSnappyInputStream.FrameAction
static final class	AbstractSnappyInputStream.FrameData
static final class	AbstractSnappyInputStream.FrameMetaData

Field Summary

Fields

Modifier and Type	Field	Description
private byte[]	buffer	Buffer is a reference to the real buffer of uncompressed data for the current block: uncompressed if the block is compressed, or input if it is not.
private boolean	closed	Indicates if this instance has been closed.
private boolean	eof	Indicates if we have reached the EOF on in.
private final byte[]	frameHeader
private final InputStream	in
private byte[]	input	A single frame read from the underlying InputStream.
private int	position	The next position to read from buffer.
private final BufferRecycler	recycler
private byte[]	uncompressed	The decompressed data from input.
private int	valid	The position in input to read to.
private final boolean	verifyChecksums

Constructor Summary

Constructors

Constructor	Description
AbstractSnappyInputStream(InputStream in, int maxBlockSize, int frameHeaderSize, boolean verifyChecksums, byte[] expectedHeader)	Creates a Snappy input stream to read data from the specified underlying input stream.

Method Summary

Modifier and Type	Method	Description
private void	allocateBuffersBasedOnSize(int size)
int	available()
void	close()
private boolean	ensureBuffer()
protected abstract AbstractSnappyInputStream.FrameData	getFrameData(byte[] frameHeader, byte[] content, int length)	Take the frame header and the content of the frame to describe metadata about the content.
protected abstract AbstractSnappyInputStream.FrameMetaData	getFrameMetaData(byte[] frameHeader)	Use the content of the frameHeader to describe what type of frame we have and the action to take.
int	read()
int	read(byte[] output, int offset, int length)
private boolean	readBlockHeader()

Methods inherited from class java.io.InputStream

mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Field Details

in

private final InputStream in

frameHeader

private final byte[] frameHeader

verifyChecksums

private final boolean verifyChecksums

recycler

private final BufferRecycler recycler

input

private byte[] input

A single frame read from the underlying InputStream.

uncompressed

private byte[] uncompressed

The decompressed data from input.

closed

private boolean closed

Indicates if this instance has been closed.

eof

private boolean eof

Indicates if we have reached the EOF on in.

valid

private int valid

The position in input to read to.

position

private int position

The next position to read from buffer.

buffer

private byte[] buffer

Buffer is a reference to the real buffer of uncompressed data for the current block: uncompressed if the block is compressed, or input if it is not.

Constructor Details

AbstractSnappyInputStream

public AbstractSnappyInputStream(InputStream in,
 int maxBlockSize,
 int frameHeaderSize,
 boolean verifyChecksums,
 byte[] expectedHeader)
                          throws IOException

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

Parameters:

in - the underlying input stream

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

expectedHeader - the expected stream header

Throws:

IOException

Method Details

allocateBuffersBasedOnSize

private void allocateBuffersBasedOnSize(int size)

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

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException

ensureBuffer

private boolean ensureBuffer()
                      throws IOException

Throws:

IOException

getFrameMetaData

protected abstract AbstractSnappyInputStream.FrameMetaData getFrameMetaData(byte[] frameHeader)
                                                                     throws IOException

Use the content of the frameHeader to describe what type of frame we have and the action to take.

Throws:

IOException

getFrameData

protected abstract AbstractSnappyInputStream.FrameData getFrameData(byte[] frameHeader,
 byte[] content,
 int length)

Take the frame header and the content of the frame to describe metadata about the content.

Parameters:

frameHeader - The frame header.

content - The content of the of the frame. Content begins at index 0.

length - The length of the content.

Returns:

Metadata about the content of the frame.

readBlockHeader

private boolean readBlockHeader()
                         throws IOException

Throws:

IOException