Apache Commons Compress 1.26.0 · org.apache.commons.compress.compressors.xz.XZCompressorOutputStream

Modifier and Type	Field and Description
private final XZOutputStream	out

Access	Constructor and Description
public	XZCompressorOutputStream(final OutputStream the stream to wrap outputStream) Creates a new XZ compressor using the default LZMA2 options.
public	XZCompressorOutputStream(final OutputStream the stream to wrap outputStream, final int the preset preset) Creates a new XZ compressor using the specified LZMA2 preset level.

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() Finishes compression without closing the underlying stream.
public void	flush() Overrides java.io.OutputStream.flush. Implements java.io.Flushable.flush. Flushes the encoder and calls `outputStream.flush()`.
public void	write(final byte[] the data. buf, final int the start offset in the data. off, final 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.
public void	write(final int the `byte`. b) Implements abstract java.io.OutputStream.write. Writes the specified byte to this output stream.

Field Detail

out	back to summary
private final XZOutputStream out

Constructor Detail

XZCompressorOutputStream back to summary

XZCompressorOutputStream	back to summary
public XZCompressorOutputStream(final OutputStream outputStream) throws IOException Creates a new XZ compressor using the default LZMA2 options. This is equivalent to `XZCompressorOutputStream(outputStream, 6)`. Parameters outputStream:OutputStream the stream to wrap Exceptions IOException: on error

public XZCompressorOutputStream(final OutputStream outputStream) throws IOException

Creates a new XZ compressor using the default LZMA2 options. This is equivalent to XZCompressorOutputStream(outputStream, 6).

Parameters

outputStream:OutputStream: the stream to wrap

Exceptions

IOException:: on error

XZCompressorOutputStream	back to summary
public XZCompressorOutputStream(final OutputStream outputStream, final int preset) throws IOException Creates a new XZ compressor using the specified LZMA2 preset level. The presets 0-3 are fast presets with medium compression. The presets 4-6 are fairly slow presets with high compression. The default preset is 6. The presets 7-9 are like the preset 6 but use bigger dictionaries and have higher compressor and decompressor memory requirements. Unless the uncompressed size of the file exceeds 8 MiB, 16 MiB, or 32 MiB, it is waste of memory to use the presets 7, 8, or 9, respectively. Parameters outputStream:OutputStream the stream to wrap preset:int the preset Exceptions IOException: on error

XZCompressorOutputStream

back to summary

public XZCompressorOutputStream(final OutputStream outputStream, final int preset) throws IOException

Creates a new XZ compressor using the specified LZMA2 preset level.

The presets 0-3 are fast presets with medium compression. The presets 4-6 are fairly slow presets with high compression. The default preset is 6.

The presets 7-9 are like the preset 6 but use bigger dictionaries and have higher compressor and decompressor memory requirements. Unless the uncompressed size of the file exceeds 8 MiB, 16 MiB, or 32 MiB, it is waste of memory to use the presets 7, 8, or 9, respectively.

Parameters

outputStream:OutputStream: the stream to wrap
preset:int: the preset

Exceptions

IOException:: on error

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. Annotations @Override 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.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

finish	back to summary
public void finish() throws IOException Finishes compression without closing the underlying stream. No more data can be written to this stream after finishing. Exceptions IOException: on error

finish

back to summary

public void finish() throws IOException

Finishes compression without closing the underlying stream. No more data can be written to this stream after finishing.

Exceptions

IOException:: on error

flush back to summary

flush	back to summary
public void flush() throws IOException Overrides java.io.OutputStream.flush. Implements java.io.Flushable.flush. Flushes the encoder and calls `outputStream.flush()`. All buffered pending data will then be decompressible from the output stream. Calling this function very often may increase the compressed file size a lot. Annotations @Override Exceptions IOException: Doc from java.io.OutputStream.flush. if an I/O error occurs.

public void flush() throws IOException

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Flushes the encoder and calls outputStream.flush(). All buffered pending data will then be decompressible from the output stream. Calling this function very often may increase the compressed file size a lot.

Annotations

@Override

Exceptions

IOException:

Doc from java.io.OutputStream.flush.

if an I/O error occurs.

write back to summary

write	back to summary
public void write(final byte[] buf, final int off, final 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. Annotations @Override Exceptions IOException: if an I/O error occurs. In particular, an `IOException` is thrown if the output stream is closed.

public void write(final byte[] buf, final int off, final 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.

Annotations

@Override

Exceptions

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

write back to summary

write	back to summary
public void write(final 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`. Annotations @Override 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(final 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.

Annotations

@Override

Exceptions

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

public Class XZCompressorOutputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail