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

Modifier and Type	Field and Description
private final Check	check
private final long	compressedSizeLimit
private FinishableOutputStream	filterChain
private final int	headerSize
private final OutputStream	out
private final CountingOutputStream	outCounted
private final byte[]	tempBuf
private long	uncompressedSize

Access	Constructor and Description
public	BlockOutputStream(OutputStream out, FilterEncoder[] filters, Check check, ArrayCache arrayCache)

Method Summary

Modifier and Type	Method and Description
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.
public long	getUncompressedSize()
public long	getUnpaddedSize()
private void	validate()
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.

check	back to summary
private final Check check

compressedSizeLimit	back to summary
private final long compressedSizeLimit

filterChain	back to summary
private FinishableOutputStream filterChain

headerSize	back to summary
private final int headerSize

out	back to summary
private final OutputStream out

outCounted	back to summary
private final CountingOutputStream outCounted

tempBuf	back to summary
private final byte[] tempBuf

uncompressedSize	back to summary
private long uncompressedSize

BlockOutputStream	back to summary
public BlockOutputStream(OutputStream out, FilterEncoder[] filters, Check check, ArrayCache arrayCache) throws IOException

Method Detail

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.

getUncompressedSize	back to summary
public long getUncompressedSize()

getUnpaddedSize	back to summary
public long getUnpaddedSize()

validate	back to summary
private void validate() throws IOException

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.

pack-priv Class BlockOutputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail