XZ for Java 1.9 · org.tukaani.xz.LZMA2OutputStream

Field Summary

Modifier and Type	Field and Description
private final ArrayCache	arrayCache
private final byte[]	chunkHeader
pack-priv static final int	COMPRESSED_SIZE_MAX
private boolean	dictResetNeeded
private IOException	exception
private boolean	finished
private LZEncoder	lz
private LZMAEncoder	lzma
private FinishableOutputStream	out
private int	pendingSize
private final int	props
private boolean	propsNeeded
private RangeEncoderToBuffer	rc
private boolean	stateResetNeeded
private final byte[]	tempBuf

Constructor Summary

Access	Constructor and Description
pack-priv	LZMA2OutputStream(FinishableOutputStream out, LZMA2Options options, ArrayCache arrayCache)

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with this stream.
public void	finish() Overrides org.tukaani.xz.FinishableOutputStream.finish. Finish the stream without closing the underlying stream.
public void	flush() Overrides java.io.OutputStream.flush. Implements java.io.Flushable.flush. Flushes this output stream and forces any buffered output bytes to be written out.
private static int	getExtraSizeBefore(int dictSize)
pack-priv static int	getMemoryUsage(LZMA2Options options)
public void	write(int the `byte`. b) Implements abstract java.io.OutputStream.write. Writes the specified byte to this output stream.
public void	write(byte[] the data. buf, int the start offset in the data. off, int the number of bytes to write. len) Overrides java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.
private void	writeChunk()
private void	writeEndMarker()
private void	writeLZMA(int uncompressedSize, int compressedSize)
private void	writeUncompressed(int uncompressedSize)

Field Detail

arrayCache	back to summary
private final ArrayCache arrayCache

chunkHeader	back to summary
private final byte[] chunkHeader

COMPRESSED_SIZE_MAX	back to summary
pack-priv static final int COMPRESSED_SIZE_MAX

dictResetNeeded	back to summary
private boolean dictResetNeeded

exception	back to summary
private IOException exception

finished	back to summary
private boolean finished

lz	back to summary
private LZEncoder lz

lzma	back to summary
private LZMAEncoder lzma

out	back to summary
private FinishableOutputStream out

pendingSize	back to summary
private int pendingSize

props	back to summary
private final int props

propsNeeded	back to summary
private boolean propsNeeded

rc	back to summary
private RangeEncoderToBuffer rc

stateResetNeeded	back to summary
private boolean stateResetNeeded

tempBuf	back to summary
private final byte[] tempBuf

Constructor Detail

LZMA2OutputStream	back to summary
pack-priv LZMA2OutputStream(FinishableOutputStream out, LZMA2Options options, ArrayCache arrayCache)

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Doc from java.io.OutputStream.close. Closes this output stream and releases any system resources associated with this stream. The general contract of `close` is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened. Exceptions IOException: if an I/O error occurs.

public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Exceptions

IOException:: if an I/O error occurs.

finish back to summary

finish	back to summary
public void finish() throws IOException Overrides org.tukaani.xz.FinishableOutputStream.finish. Doc from org.tukaani.xz.FinishableOutputStream.finish. Finish the stream without closing the underlying stream. No more data may be written to the stream after finishing. The `finish` method of `FinishableOutputStream` does nothing. Subclasses should override it if they need finishing support, which is the case, for example, with compressors.

public void finish() throws IOException

Overrides org.tukaani.xz.FinishableOutputStream.finish.

Doc from org.tukaani.xz.FinishableOutputStream.finish.

Finish the stream without closing the underlying stream. No more data may be written to the stream after finishing.

The finish method of FinishableOutputStream does nothing. Subclasses should override it if they need finishing support, which is the case, for example, with compressors.

flush back to summary

flush	back to summary
public void flush() throws IOException Overrides java.io.OutputStream.flush. Implements java.io.Flushable.flush. Doc from java.io.OutputStream.flush. Flushes this output stream and forces any buffered output bytes to be written out. The general contract of `flush` is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination. If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive. Exceptions IOException: if an I/O error occurs.

public void flush() throws IOException

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Doc from java.io.OutputStream.flush.

Flushes this output stream and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.

If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive.

Exceptions

IOException:: if an I/O error occurs.

getExtraSizeBefore	back to summary
private static int getExtraSizeBefore(int dictSize)

getMemoryUsage	back to summary
pack-priv static int getMemoryUsage(LZMA2Options options)

write back to summary

write	back to summary
public void write(int b) throws IOException Implements abstract java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes the specified byte to this output stream. The general contract for `write` is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument `b`. The 24 high-order bits of `b` are ignored. Parameters b:int the `byte`. Exceptions IOException: if an I/O error occurs. In particular, an `IOException` may be thrown if the output stream has been closed.

public void write(int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters

b:int: the byte.

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

write back to summary

write	back to summary
public void write(byte[] buf, int off, int len) throws IOException Overrides java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream. The general contract for `write(b, off, len)` is that some of the bytes in the array `b` are written to the output stream in order; element `b[off]` is the first byte written and `b[off+len-1]` is the last byte written by this operation. If `b` is `null`, a `NullPointerException` is thrown. If `off` is negative, or `len` is negative, or `off+len` is greater than the length of the array `b`, then an `IndexOutOfBoundsException` is thrown. Parameters buf:byte[] the data. off:int the start offset in the data. len:int the number of bytes to write. Exceptions IOException: if an I/O error occurs. In particular, an `IOException` is thrown if the output stream is closed.

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

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters

buf:byte[]: the data.
off:int: the start offset in the data.
len:int: the number of bytes to write.

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.

writeChunk	back to summary
private void writeChunk() throws IOException

writeEndMarker	back to summary
private void writeEndMarker() throws IOException

writeLZMA	back to summary
private void writeLZMA(int uncompressedSize, int compressedSize) throws IOException

writeUncompressed	back to summary
private void writeUncompressed(int uncompressedSize) throws IOException

pack-priv Class LZMA2OutputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail