Class LZFFileOutputStream

java.lang.Object

java.io.OutputStream

java.io.FileOutputStream

com.ning.compress.lzf.util.LZFFileOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, Channel, WritableByteChannel

public class LZFFileOutputStream
extends FileOutputStream
implements WritableByteChannel

Helper class that allows use of LZF compression even if a library requires use of FileOutputStream.

Note that use of this class is not recommended unless you absolutely must use a FileOutputStream instance; otherwise basic LZFOutputStream (which uses aggregation for underlying streams) is more appropriate

Implementation note: much of the code is just copied from LZFOutputStream, so care must be taken to keep implementations in sync if there are fixes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	LZFFileOutputStream.Wrapper	This simple wrapper is needed to re-route read calls so that they will use "raw" writes

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	_cfgFinishBlockOnFlush	Configuration setting that governs whether basic 'flush()' should first complete a block or not.
private final ChunkEncoder	_encoder
protected byte[]	_outputBuffer
protected boolean	_outputStreamClosed	Flag that indicates if we have already called '_outputStream.close()' (to avoid calling it multiple times)
protected int	_position
private final BufferRecycler	_recycler
private final LZFFileOutputStream.Wrapper	_wrapper	Wrapper object we use to allow decoder to write directly to the stream, without ending in infinite loop...
private static final int	OUTPUT_BUFFER_SIZE

Constructor Summary

Constructors

Constructor	Description
LZFFileOutputStream(ChunkEncoder encoder, File file)
LZFFileOutputStream(ChunkEncoder encoder, FileDescriptor fdObj)
LZFFileOutputStream(ChunkEncoder encoder, FileDescriptor fdObj, BufferRecycler bufferRecycler)
LZFFileOutputStream(ChunkEncoder encoder, File file, boolean append)
LZFFileOutputStream(ChunkEncoder encoder, File file, boolean append, BufferRecycler bufferRecycler)
LZFFileOutputStream(ChunkEncoder encoder, File file, BufferRecycler bufferRecycler)
LZFFileOutputStream(ChunkEncoder encoder, String name)
LZFFileOutputStream(ChunkEncoder encoder, String name, boolean append)
LZFFileOutputStream(ChunkEncoder encoder, String name, boolean append, BufferRecycler bufferRecycler)
LZFFileOutputStream(ChunkEncoder encoder, String name, BufferRecycler bufferRecycler)
LZFFileOutputStream(File file)
LZFFileOutputStream(FileDescriptor fdObj)
LZFFileOutputStream(File file, boolean append)
LZFFileOutputStream(String name)
LZFFileOutputStream(String name, boolean append)

Method Summary

Modifier and Type	Method	Description
protected void	checkNotClosed()
void	close()
LZFFileOutputStream	finishBlock()	Method that can be used to force completion of the current block, which means that all buffered data will be compressed into an LZF block.
void	flush()
boolean	getFinishBlockOnFlush()	Accessor for checking whether call to "flush()" will first finish the current block or not
boolean	isOpen()
protected void	rawWrite(byte[] buffer, int offset, int length)
LZFFileOutputStream	setFinishBlockOnFlush(boolean b)	Method for defining whether call to flush() will also complete current block (similar to calling finishBlock()) or not.
void	write(byte[] b)
void	write(byte[] buffer, int offset, int length)
void	write(int b)
void	write(InputStream in)
int	write(ByteBuffer src)
void	write(FileChannel in)
protected void	writeCompressedBlock()	Compress and write the current block to the OutputStream

Methods inherited from class FileOutputStream

getChannel, getFD

Methods inherited from class OutputStream

nullOutputStream

Methods inherited from class Object

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

Field Details

OUTPUT_BUFFER_SIZE

private static final int OUTPUT_BUFFER_SIZE

See Also:

• Constant Field Values

_encoder

private final ChunkEncoder _encoder

_recycler

private final BufferRecycler _recycler

_outputBuffer

protected byte[] _outputBuffer

_position

protected int _position

_cfgFinishBlockOnFlush

protected boolean _cfgFinishBlockOnFlush

Configuration setting that governs whether basic 'flush()' should first complete a block or not.

Default value is 'true'.

_outputStreamClosed

protected boolean _outputStreamClosed

Flag that indicates if we have already called '_outputStream.close()' (to avoid calling it multiple times)

_wrapper

private final LZFFileOutputStream.Wrapper _wrapper

Wrapper object we use to allow decoder to write directly to the stream, without ending in infinite loop...

Constructor Details

LZFFileOutputStream

public LZFFileOutputStream(File file)
                    throws FileNotFoundException

Throws:

FileNotFoundException

LZFFileOutputStream

public LZFFileOutputStream(File file,
 boolean append)
                    throws FileNotFoundException

Throws:

FileNotFoundException

LZFFileOutputStream

public LZFFileOutputStream(FileDescriptor fdObj)

LZFFileOutputStream

public LZFFileOutputStream(String name)
                    throws FileNotFoundException

Throws:

FileNotFoundException

LZFFileOutputStream

public LZFFileOutputStream(String name,
 boolean append)
                    throws FileNotFoundException

Throws:

FileNotFoundException

LZFFileOutputStream

public LZFFileOutputStream(ChunkEncoder encoder,
 File file)
                    throws FileNotFoundException

Throws:

FileNotFoundException

LZFFileOutputStream

public LZFFileOutputStream(ChunkEncoder encoder,
 File file,
 boolean append)
                    throws FileNotFoundException

Throws:

FileNotFoundException

LZFFileOutputStream

public LZFFileOutputStream(ChunkEncoder encoder,
 FileDescriptor fdObj)

LZFFileOutputStream

public LZFFileOutputStream(ChunkEncoder encoder,
 String name)
                    throws FileNotFoundException

Throws:

FileNotFoundException

LZFFileOutputStream

public LZFFileOutputStream(ChunkEncoder encoder,
 String name,
 boolean append)
                    throws FileNotFoundException

Throws:

FileNotFoundException

LZFFileOutputStream

public LZFFileOutputStream(ChunkEncoder encoder,
 File file,
 BufferRecycler bufferRecycler)
                    throws FileNotFoundException

Throws:

FileNotFoundException

LZFFileOutputStream

public LZFFileOutputStream(ChunkEncoder encoder,
 File file,
 boolean append,
 BufferRecycler bufferRecycler)
                    throws FileNotFoundException

Throws:

FileNotFoundException

LZFFileOutputStream

public LZFFileOutputStream(ChunkEncoder encoder,
 FileDescriptor fdObj,
 BufferRecycler bufferRecycler)

LZFFileOutputStream

public LZFFileOutputStream(ChunkEncoder encoder,
 String name,
 BufferRecycler bufferRecycler)
                    throws FileNotFoundException

Throws:

FileNotFoundException

LZFFileOutputStream

public LZFFileOutputStream(ChunkEncoder encoder,
 String name,
 boolean append,
 BufferRecycler bufferRecycler)
                    throws FileNotFoundException

Throws:

FileNotFoundException

Method Details

setFinishBlockOnFlush

public LZFFileOutputStream setFinishBlockOnFlush(boolean b)

Method for defining whether call to flush() will also complete current block (similar to calling finishBlock()) or not.

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface Closeable

Overrides:

close in class FileOutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class FileOutputStream

Throws:

IOException

write

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

Overrides:

write in class FileOutputStream

Throws:

IOException

write

public void write(int b)
           throws IOException

Overrides:

write in class FileOutputStream

Throws:

IOException

write

public void write(InputStream in)
           throws IOException

Throws:

IOException

write

public int write(ByteBuffer src)
          throws IOException

Specified by:

write in interface WritableByteChannel

Throws:

IOException

write

public void write(FileChannel in)
           throws IOException

Throws:

IOException

getFinishBlockOnFlush

public boolean getFinishBlockOnFlush()

Accessor for checking whether call to "flush()" will first finish the current block or not

finishBlock

public LZFFileOutputStream finishBlock()
                                throws IOException

Method that can be used to force completion of the current block, which means that all buffered data will be compressed into an LZF block. This typically results in lower compression ratio as larger blocks compress better; but may be necessary for network connections to ensure timely sending of data.

Throws:

IOException

writeCompressedBlock

protected void writeCompressedBlock()
                             throws IOException

Compress and write the current block to the OutputStream

Throws:

IOException

rawWrite

protected void rawWrite(byte[] buffer,
 int offset,
 int length)
                 throws IOException

Throws:

IOException

checkNotClosed

protected void checkNotClosed()
                       throws IOException

Throws:

IOException