Package org.apache.commons.compress.compressors.snappy

Class FramedSnappyCompressorOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

org.apache.commons.compress.compressors.CompressorOutputStream<OutputStream>

org.apache.commons.compress.compressors.snappy.FramedSnappyCompressorOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class FramedSnappyCompressorOutputStream
extends CompressorOutputStream<OutputStream>

CompressorOutputStream for the framing Snappy format.

Based on the "spec" in the version "Last revised: 2013-10-25"

Since:

1.14

See Also:

• Snappy framing format description

Field Summary

Fields

Modifier and Type	Field	Description
private final byte[]	buffer
private final org.apache.commons.codec.digest.PureJavaCrc32C	checksum
private final ByteUtils.ByteConsumer	consumer
private int	currentIndex
private static final int	MAX_COMPRESSED_BUFFER_SIZE
private final byte[]	oneByte
private final Parameters	params

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
FramedSnappyCompressorOutputStream(OutputStream out)	Constructs a new output stream that compresses snappy-framed-compressed data to the specified output stream.
FramedSnappyCompressorOutputStream(OutputStream out, Parameters params)	Constructs a new output stream that compresses snappy-framed-compressed data to the specified output stream.

Method Summary

Modifier and Type	Method	Description
void	close()
void	finish()	Compresses all remaining data and writes it to the stream, doesn't close the underlying stream.
private void	flushBuffer()
(package private) static long	mask(long x)
void	write(byte[] data, int off, int len)
void	write(int b)
private void	writeCrc()
private void	writeLittleEndian(int numBytes, long num)

Methods inherited from class org.apache.commons.compress.compressors.CompressorOutputStream

out

Methods inherited from class java.io.FilterOutputStream

flush, write

Methods inherited from class java.lang.Object

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

Field Details

MAX_COMPRESSED_BUFFER_SIZE

private static final int MAX_COMPRESSED_BUFFER_SIZE

See Also:

• Constant Field Values

params

private final Parameters params

checksum

private final org.apache.commons.codec.digest.PureJavaCrc32C checksum

oneByte

private final byte[] oneByte

buffer

private final byte[] buffer

currentIndex

private int currentIndex

consumer

private final ByteUtils.ByteConsumer consumer

Constructor Details

FramedSnappyCompressorOutputStream

public FramedSnappyCompressorOutputStream(OutputStream out)
                                   throws IOException

Constructs a new output stream that compresses snappy-framed-compressed data to the specified output stream.

Parameters:

out - the OutputStream to which to write the compressed data

Throws:

IOException - if writing the signature fails

FramedSnappyCompressorOutputStream

public FramedSnappyCompressorOutputStream(OutputStream out,
 Parameters params)
                                   throws IOException

Constructs a new output stream that compresses snappy-framed-compressed data to the specified output stream.

Parameters:

out - the OutputStream to which to write the compressed data

params - parameters used to fine-tune compression, in particular to balance compression ratio vs compression speed.

Throws:

IOException - if writing the signature fails

Method Details

mask

static long mask(long x)

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterOutputStream

Throws:

IOException

finish

public void finish()
            throws IOException

Compresses all remaining data and writes it to the stream, doesn't close the underlying stream.

Throws:

IOException - if an error occurs

flushBuffer

private void flushBuffer()
                  throws IOException

Throws:

IOException

write

public void write(byte[] data,
 int off,
 int len)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

write

public void write(int b)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

writeCrc

private void writeCrc()
               throws IOException

Throws:

IOException

writeLittleEndian

private void writeLittleEndian(int numBytes,
 long num)
                        throws IOException

Throws:

IOException