de.jarnbjo.jsnappy

Class SnzOutputStream

java.lang.Object

java.io.OutputStream

de.jarnbjo.jsnappy.SnzOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class SnzOutputStream
extends OutputStream

This class implements a stream filter for writing 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

Modifier and Type	Field and Description
static int	DEFAULT_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
SnzOutputStream(OutputStream out) Creates a new compressing output stream with the default buffer size.
SnzOutputStream(OutputStream out, int bufferSize) Creates a new compressing output stream with the specified buffer size.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Flushes the remaining data into a new compressed block, writes an end-of-stream marker and closes the underlaying output stream.
int	getCompressionEffort() Returns the compression effort used by this stream.
void	setCompressionEffort(int effort) Sets the compression effort used by this stream from 1 (fastest, less compression) to 100 (slowest, best compression).
void	write(byte[] data) Writes the content of data to the compressed output stream.
void	write(byte[] data, int offset, int length) Writes length bytes of data to the compressed stream from data, starting at index offset.
void	write(int data) Writes the byte to the compressed output stream.

Methods inherited from class java.io.OutputStream

flush

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

See Also:

Constant Field Values

Constructor Detail

SnzOutputStream

public SnzOutputStream(OutputStream out)
                throws IOException

Creates a new compressing output stream with the default buffer size.

Parameters:

out - target output stream

Throws:

IOException

SnzOutputStream

public SnzOutputStream(OutputStream out,
               int bufferSize)
                throws IOException

Creates a new compressing output stream with the specified buffer size.

Parameters:

out - target output stream

bufferSize - buffer size must be a power of 2 between 2**0 and 2**29

Throws:

IOException

Method Detail

write

public void write(int data)
           throws IOException

Writes the byte to the compressed output stream.

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] data)
           throws IOException

Writes the content of data to the compressed output stream.

Overrides:

write in class OutputStream

Throws:

IOException

write

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

Writes length bytes of data to the compressed stream from data, starting at index offset.

Overrides:

write in class OutputStream

Throws:

IOException

getCompressionEffort

public int getCompressionEffort()

Returns the compression effort used by this stream. The effort defaults to 1 (fastest, less compression).

Returns:

setCompressionEffort

public void setCompressionEffort(int effort)

Sets the compression effort used by this stream from 1 (fastest, less compression) to 100 (slowest, best compression). If the effort is changed after the stream has been written to, the new effort will take effect on the next packet processed internally and may so affect data already written to the stream.

Parameters:

effort -

close

public void close()
           throws IOException

Flushes the remaining data into a new compressed block, writes an end-of-stream marker and closes the underlaying output stream.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException