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

Modifier and Type	Field and Description
private final CountingInputStream	countingStream
private final InputStream	in

Access	Constructor and Description
public	XZCompressorInputStream(final InputStream where to read the compressed data inputStream) Creates a new input stream that decompresses XZ-compressed data from the specified input stream.
public	XZCompressorInputStream(final InputStream where to read the compressed data inputStream, final boolean if true, decompress until the end of the input; if false, stop after the first .xz stream and leave the input position to point to the next byte after the .xz stream decompressConcatenated) Creates a new input stream that decompresses XZ-compressed data from the specified input stream.
public	XZCompressorInputStream(final InputStream where to read the compressed data inputStream, final boolean if true, decompress until the end of the input; if false, stop after the first .xz stream and leave the input position to point to the next byte after the .xz stream decompressConcatenated, final int memory limit used when reading blocks. If the estimated memory limit is exceeded on `read()`, a `MemoryLimitException` is thrown. memoryLimitInKb) Creates a new input stream that decompresses XZ-compressed data from the specified input stream.

Method Summary

Modifier and Type	Method and Description
public int	available() Overrides java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected.
public void	close() Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Closes this input stream and releases any system resources associated with the stream.
public long	getCompressedCount() Implements org.apache.commons.compress.utils.InputStreamStatistics.getCompressedCount. Gets the amount of raw or compressed bytes read by the stream.
public static boolean	Returns: true if signature matches the .xz magic bytes, false otherwise matches(final byte[] the bytes to check signature, final int the number of bytes to check length) Checks if the signature matches what is expected for a .xz file.
public int	read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.
public int	read(final byte[] the buffer into which the data is read. buf, final int the start offset in array `b` at which the data is written. off, final int the maximum number of bytes to read. len) Overrides java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes.
public long	skip(final long the number of bytes to be skipped. n) Overrides java.io.InputStream.skip. Skips over and discards `n` bytes of data from this input stream.

Inherited from org.apache.commons.compress.compressors.CompressorInputStream:: count count getBytesRead getCount getUncompressedCount pushedBackBytes

Field Detail

countingStream	back to summary
private final CountingInputStream countingStream

in	back to summary
private final InputStream in

Constructor Detail

XZCompressorInputStream back to summary

XZCompressorInputStream	back to summary
public XZCompressorInputStream(final InputStream inputStream) throws IOException Creates a new input stream that decompresses XZ-compressed data from the specified input stream. This doesn't support concatenated .xz files. Parameters inputStream:InputStream where to read the compressed data Exceptions IOException: if the input is not in the .xz format, the input is corrupt or truncated, the .xz headers specify options that are not supported by this implementation, or the underlying `inputStream` throws an exception

public XZCompressorInputStream(final InputStream inputStream) throws IOException

Creates a new input stream that decompresses XZ-compressed data from the specified input stream. This doesn't support concatenated .xz files.

Parameters

inputStream:InputStream: where to read the compressed data

Exceptions

IOException:: if the input is not in the .xz format, the input is corrupt or truncated, the .xz headers specify options that are not supported by this implementation, or the underlying inputStream throws an exception

XZCompressorInputStream back to summary

XZCompressorInputStream	back to summary
public XZCompressorInputStream(final InputStream inputStream, final boolean decompressConcatenated) throws IOException Creates a new input stream that decompresses XZ-compressed data from the specified input stream. Parameters inputStream:InputStream where to read the compressed data decompressConcatenated:boolean if true, decompress until the end of the input; if false, stop after the first .xz stream and leave the input position to point to the next byte after the .xz stream Exceptions IOException: if the input is not in the .xz format, the input is corrupt or truncated, the .xz headers specify options that are not supported by this implementation, or the underlying `inputStream` throws an exception

public XZCompressorInputStream(final InputStream inputStream, final boolean decompressConcatenated) throws IOException

Creates a new input stream that decompresses XZ-compressed data from the specified input stream.

Parameters

inputStream:InputStream: where to read the compressed data
decompressConcatenated:boolean: if true, decompress until the end of the input; if false, stop after the first .xz stream and leave the input position to point to the next byte after the .xz stream

Exceptions

IOException:: if the input is not in the .xz format, the input is corrupt or truncated, the .xz headers specify options that are not supported by this implementation, or the underlying inputStream throws an exception

XZCompressorInputStream back to summary

XZCompressorInputStream	back to summary
public XZCompressorInputStream(final InputStream inputStream, final boolean decompressConcatenated, final int memoryLimitInKb) throws IOException Creates a new input stream that decompresses XZ-compressed data from the specified input stream. Parameters inputStream:InputStream where to read the compressed data decompressConcatenated:boolean if true, decompress until the end of the input; if false, stop after the first .xz stream and leave the input position to point to the next byte after the .xz stream memoryLimitInKb:int memory limit used when reading blocks. If the estimated memory limit is exceeded on `read()`, a `MemoryLimitException` is thrown. Exceptions IOException: if the input is not in the .xz format, the input is corrupt or truncated, the .xz headers specify options that are not supported by this implementation, or the underlying `inputStream` throws an exception Since 1.14

public XZCompressorInputStream(final InputStream inputStream, final boolean decompressConcatenated, final int memoryLimitInKb) throws IOException

Creates a new input stream that decompresses XZ-compressed data from the specified input stream.

Parameters

inputStream:InputStream: where to read the compressed data
decompressConcatenated:boolean: if true, decompress until the end of the input; if false, stop after the first .xz stream and leave the input position to point to the next byte after the .xz stream
memoryLimitInKb:int: memory limit used when reading blocks. If the estimated memory limit is exceeded on read(), a MemoryLimitException is thrown.

Exceptions

IOException:: if the input is not in the .xz format, the input is corrupt or truncated, the .xz headers specify options that are not supported by this implementation, or the underlying inputStream throws an exception

Since

1.14

Method Detail

available back to summary

available	back to summary
public int available() throws IOException Overrides java.io.InputStream.available. Doc from java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes. Note that while some implementations of `InputStream` will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream. A subclass's implementation of this method may choose to throw an `IOException` if this input stream has been closed by invoking the `close()` method. Returns:int an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or `0` when it reaches the end of the input stream. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int available() throws IOException

Overrides java.io.InputStream.available.

Doc from java.io.InputStream.available.

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

Note that while some implementations of InputStream will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream.

A subclass's implementation of this method may choose to throw an IOException if this input stream has been closed by invoking the close() method.

Returns:int

an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or 0 when it reaches the end of the input stream.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

close	back to summary
public void close() throws IOException Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Doc from java.io.InputStream.close. Closes this input stream and releases any system resources associated with the stream. Annotations @Override Exceptions IOException: if an I/O error occurs.

back to summary

public void close() throws IOException

Overrides java.io.InputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.InputStream.close.

Closes this input stream and releases any system resources associated with the stream.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

getCompressedCount	back to summary
public long getCompressedCount() Implements org.apache.commons.compress.utils.InputStreamStatistics.getCompressedCount. Doc from org.apache.commons.compress.utils.InputStreamStatistics.getCompressedCount. Gets the amount of raw or compressed bytes read by the stream. Returns:long the amount of raw or compressed bytes read by the stream. Annotations @Override Since 1.17

getCompressedCount

back to summary

public long getCompressedCount()

Implements org.apache.commons.compress.utils.InputStreamStatistics.getCompressedCount.

Doc from org.apache.commons.compress.utils.InputStreamStatistics.getCompressedCount.

Gets the amount of raw or compressed bytes read by the stream.

Returns:long

the amount of raw or compressed bytes read by the stream.

Annotations

@Override

Since

1.17

matches	back to summary
public static boolean matches(final byte[] signature, final int length) Checks if the signature matches what is expected for a .xz file. Parameters signature:byte[] the bytes to check length:int the number of bytes to check Returns:boolean true if signature matches the .xz magic bytes, false otherwise

matches

back to summary

public static boolean matches(final byte[] signature, final int length)

Checks if the signature matches what is expected for a .xz file.

Parameters

signature:byte[]: the bytes to check
length:int: the number of bytes to check

Returns:boolean

true if signature matches the .xz magic bytes, false otherwise

read back to summary

read	back to summary
public int read() throws IOException Implements abstract java.io.InputStream.read. Doc from java.io.InputStream.read. Reads the next byte of data from the input stream. The value byte is returned as an `int` in the range `0` to `255`. If no byte is available because the end of the stream has been reached, the value `-1` is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. Returns:int the next byte of data, or `-1` if the end of the stream is reached. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(final byte[] buf, final int off, final int len) throws IOException Overrides java.io.InputStream.read. Doc from java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes. An attempt is made to read as many as `len` bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown. If `len` is zero, then no bytes are read and `0` is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value `-1` is returned; otherwise, at least one byte is read and stored into `b`. The first byte read is stored into element `b[off]`, the next one into `b[off+1]`, and so on. The number of bytes read is, at most, equal to `len`. Let k be the number of bytes actually read; these bytes will be stored in elements `b[off]` through `b[off+`k`-1]`, leaving elements `b[off+`k`]` through `b[off+len-1]` unaffected. In every case, elements `b[0]` through `b[off-1]` and elements `b[off+len]` through `b[b.length-1]` are unaffected. Parameters buf:byte[] the buffer into which the data is read. off:int the start offset in array `b` at which the data is written. len:int the maximum number of bytes to read. Returns:int the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the stream has been reached. Annotations @Override Exceptions IOException: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

public int read(final byte[] buf, final int off, final int len) throws IOException

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off-1] and elements b[off+len] through b[b.length-1] are unaffected.

Parameters

buf:byte[]: the buffer into which the data is read.
off:int: the start offset in array b at which the data is written.
len:int: the maximum number of bytes to read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Annotations

@Override

Exceptions

IOException:: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

skip back to summary

skip	back to summary
public long skip(final long n) throws IOException Overrides java.io.InputStream.skip. Doc from java.io.InputStream.skip. Skips over and discards `n` bytes of data from this input stream. The `skip` method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly `0`. This may result from any of a number of conditions; reaching end of file before `n` bytes have been skipped is only one possibility. The actual number of bytes skipped is returned. If `n` is negative, the `skip` method for class `InputStream` always returns 0, and no bytes are skipped. Subclasses may handle the negative value differently. Parameters n:long the number of bytes to be skipped. Returns:long the actual number of bytes skipped which might be zero. Annotations @Override Exceptions IOException: if an I/O error occurs.

public long skip(final long n) throws IOException

Overrides java.io.InputStream.skip.

Doc from java.io.InputStream.skip.

Skips over and discards n bytes of data from this input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. This may result from any of a number of conditions; reaching end of file before n bytes have been skipped is only one possibility. The actual number of bytes skipped is returned. If n is negative, the skip method for class InputStream always returns 0, and no bytes are skipped. Subclasses may handle the negative value differently.

Parameters

n:long: the number of bytes to be skipped.

Returns:long

the actual number of bytes skipped which might be zero.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

public Class XZCompressorInputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail