Package com.ning.compress.lzf
Class LZFOutputStream
- java.lang.Object
-
- java.io.OutputStream
-
- java.io.FilterOutputStream
-
- com.ning.compress.lzf.LZFOutputStream
-
- All Implemented Interfaces:
Closeable
,Flushable
,AutoCloseable
,Channel
,WritableByteChannel
public class LZFOutputStream extends FilterOutputStream implements WritableByteChannel
DecoratorOutputStream
implementation that will compress output using LZF compression algorithm, given uncompressed input to write. Its counterpart isLZFInputStream
; although in some waysLZFCompressingInputStream
can be seen as the opposite.- Author:
- jon hartlaub, Tatu Saloranta
- See Also:
LZFInputStream
,LZFCompressingInputStream
-
-
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.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
-
Fields inherited from class java.io.FilterOutputStream
out
-
-
Constructor Summary
Constructors Constructor Description LZFOutputStream(ChunkEncoder encoder, OutputStream outputStream)
LZFOutputStream(ChunkEncoder encoder, OutputStream outputStream, int bufferSize, BufferRecycler bufferRecycler)
LZFOutputStream(ChunkEncoder encoder, OutputStream outputStream, BufferRecycler bufferRecycler)
LZFOutputStream(OutputStream outputStream)
LZFOutputStream(OutputStream outputStream, BufferRecycler bufferRecycler)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
checkNotClosed()
void
close()
LZFOutputStream
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.OutputStream
getUnderlyingOutputStream()
Method that can be used to find underlyingOutputStream
that we write encoded LZF encoded data into, after compressing it.boolean
isOpen()
LZFOutputStream
setFinishBlockOnFlush(boolean b)
Method for defining whether call toflush()
will also complete current block (similar to callingfinishBlock()
) or not.void
write(byte[] buffer, int offset, int length)
void
write(int singleByte)
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 java.io.FilterOutputStream
write
-
Methods inherited from class java.io.OutputStream
nullOutputStream
-
-
-
-
Field Detail
-
_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)
-
-
Constructor Detail
-
LZFOutputStream
public LZFOutputStream(OutputStream outputStream)
-
LZFOutputStream
public LZFOutputStream(ChunkEncoder encoder, OutputStream outputStream)
-
LZFOutputStream
public LZFOutputStream(OutputStream outputStream, BufferRecycler bufferRecycler)
-
LZFOutputStream
public LZFOutputStream(ChunkEncoder encoder, OutputStream outputStream, BufferRecycler bufferRecycler)
-
LZFOutputStream
public LZFOutputStream(ChunkEncoder encoder, OutputStream outputStream, int bufferSize, BufferRecycler bufferRecycler)
-
-
Method Detail
-
setFinishBlockOnFlush
public LZFOutputStream setFinishBlockOnFlush(boolean b)
Method for defining whether call toflush()
will also complete current block (similar to callingfinishBlock()
) or not.
-
write
public void write(int singleByte) throws IOException
- Overrides:
write
in classFilterOutputStream
- Throws:
IOException
-
write
public void write(byte[] buffer, int offset, int length) throws IOException
- Overrides:
write
in classFilterOutputStream
- Throws:
IOException
-
write
public void write(InputStream in) throws IOException
- Throws:
IOException
-
write
public void write(FileChannel in) throws IOException
- Throws:
IOException
-
write
public int write(ByteBuffer src) throws IOException
- Specified by:
write
in interfaceWritableByteChannel
- Throws:
IOException
-
flush
public void flush() throws IOException
- Specified by:
flush
in interfaceFlushable
- Overrides:
flush
in classFilterOutputStream
- Throws:
IOException
-
close
public void close() throws IOException
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceChannel
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classFilterOutputStream
- Throws:
IOException
-
getUnderlyingOutputStream
public OutputStream getUnderlyingOutputStream()
Method that can be used to find underlyingOutputStream
that we write encoded LZF encoded data into, after compressing it. Will never return null; although underlying stream may be closed (if this stream has been closed).
-
getFinishBlockOnFlush
public boolean getFinishBlockOnFlush()
Accessor for checking whether call to "flush()" will first finish the current block or not.
-
finishBlock
public LZFOutputStream 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
-
checkNotClosed
protected void checkNotClosed() throws IOException
- Throws:
IOException
-
-