org.iq80.snappy

Class SnappyOutputStream

java.lang.Object

java.io.OutputStream

org.iq80.snappy.SnappyOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

Deprecated.

Use SnappyFramedOutputStream which implements the standard x-snappy-framed specification.

@Deprecated
public class SnappyOutputStream
extends OutputStream

This class implements an output stream for writing Snappy compressed data. The output format is the stream header "snappy\0" followed by one or more compressed blocks of data, each of which is preceded by a seven byte header.

The first byte of the header is a flag indicating if the block is compressed or not. A value of 0x00 means uncompressed, and 0x01 means compressed.

The second and third bytes are the size of the block in the stream as a big endian number. This value is never zero as empty blocks are never written. The maximum allowed length is 32k (1 << 15).

The remaining four byes are crc32c checksum of the user input data masked with the following function: ((crc >>> 15) | (crc << 17)) + 0xa282ead8

An uncompressed block is simply copied from the input, thus guaranteeing that the output is never larger than the input (not including the header).

NOTE:This data produced by this class is not compatible with the x-snappy-framed specification. It can only be read by SnappyInputStream.

Field Summary

Fields

Modifier and Type	Field and Description
static double	MIN_COMPRESSION_RATIO Deprecated. Write out the uncompressed content if the compression ratio (compressed length / raw length) exceeds this value.

Constructor Summary

Constructors

Constructor and Description
SnappyOutputStream(OutputStream out) Deprecated. Creates a Snappy output stream to write data to the specified underlying output stream.

Method Summary

Modifier and Type	Method and Description
protected int	calculateCRC32C(byte[] data, int offset, int length) Deprecated. Calculates a CRC32C checksum over the data.
void	close()
void	flush()
static SnappyOutputStream	newChecksumFreeBenchmarkOutputStream(OutputStream out) Deprecated. Creates a Snappy output stream with block checksums disabled.
void	write(byte[] input, int offset, int length)
void	write(int b)
protected void	writeBlock(OutputStream out, byte[] data, int offset, int length, boolean compressed, int crc32c) Deprecated. Write a frame (block) to out.
protected void	writeHeader(OutputStream out) Deprecated. Writes the implementation specific header or "marker bytes" to out.

Methods inherited from class java.io.OutputStream

write

Methods inherited from class java.lang.Object

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

Field Detail

MIN_COMPRESSION_RATIO

public static final double MIN_COMPRESSION_RATIO

Deprecated.

Write out the uncompressed content if the compression ratio (compressed length / raw length) exceeds this value.

See Also:

Constant Field Values

Constructor Detail

SnappyOutputStream

public SnappyOutputStream(OutputStream out)
                   throws IOException

Deprecated.

Creates a Snappy output stream to write data to the specified underlying output stream.

Parameters:

out - the underlying output stream

Throws:

IOException

Method Detail

newChecksumFreeBenchmarkOutputStream

public static SnappyOutputStream newChecksumFreeBenchmarkOutputStream(OutputStream out)
                                                               throws IOException

Deprecated.

Creates a Snappy output stream with block checksums disabled. This is only useful for apples-to-apples benchmarks with other compressors that do not perform block checksums.

Parameters:

out - the underlying output stream

Throws:

IOException

writeHeader

protected void writeHeader(OutputStream out)
                    throws IOException

Deprecated.

Writes the implementation specific header or "marker bytes" to out.

Parameters:

out - The underlying OutputStream.

Throws:

IOException

calculateCRC32C

protected int calculateCRC32C(byte[] data,
                              int offset,
                              int length)

Deprecated.

Calculates a CRC32C checksum over the data.

This can be overridden to provider alternative implementations (such as returning 0 if checksums are not desired).

Returns:

The CRC32 checksum.

writeBlock

protected void writeBlock(OutputStream out,
                          byte[] data,
                          int offset,
                          int length,
                          boolean compressed,
                          int crc32c)
                   throws IOException

Deprecated.

Write a frame (block) to out.

Parameters:

out - The OutputStream to write to.

data - The data to write.

offset - The offset in data to start at.

length - The length of data to use.

compressed - Indicates if data is the compressed or raw content. This is based on whether the compression ratio desired is reached.

crc32c - The calculated checksum.

Throws:

IOException

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] input,
                  int offset,
                  int length)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

flush

public final void flush()
                 throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public final void close()
                 throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException