Apache Commons Compress 1.26.0 · org.apache.commons.compress.archivers.ArchiveInputStream

Archive input streams MUST override the read(byte[], int, int) - or read() - method so that reading from the stream generates EOF for the end of data in each entry as well as at the end of the file proper.

The getNextEntry() method is used to reset the input stream ready for reading the data from the next entry.

The input stream classes must also implement a method with the signature:

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

which is used by the ArchiveStreamFactory to autodetect the archive type from the first few bytes of a stream.

Field Summary

Modifier and Type	Field and Description
private static final int	BYTE_MASK
private long	bytesRead The number of bytes read in this stream
private Charset	charset
private final byte[]	single

Inherited from java.io.FilterInputStream:: in

Constructor Summary

Access	Constructor and Description
public	ArchiveInputStream() Constructs a new instance.
private	ArchiveInputStream(final InputStream the underlying input stream, or `null` if this instance is to be created without an underlying stream. inputStream, final Charset charset. charset) Constructs a new instance.
protected	ArchiveInputStream(final InputStream the underlying input stream, or `null` if this instance is to be created without an underlying stream. inputStream, final String charset name. charsetName) Constructs a new instance.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: This implementation always returns true. canReadEntryData(final ArchiveEntry the entry to test archiveEntry) Whether this stream is able to read the given entry.
protected void	count(final int the number of bytes read read) Increments the counter of already read bytes.
protected void	count(final long the number of bytes read read) Increments the counter of already read bytes.
public long	Returns: the number of read bytes getBytesRead() Gets the current number of bytes read from this stream.
public Charset	Returns: the Charest. getCharset() Gets the Charest.
public int	Returns: the number of read bytes getCount() Deprecated this method may yield wrong results for large archives, use `getBytesRead()` instead. Gets the current number of bytes read from this stream.
public abstract E	Returns: the next entry, or `null` if there are no more entries getNextEntry() Gets the next Archive Entry in this Stream.
protected void	pushedBackBytes(final long the number of bytes pushed back. pushedBack) Decrements the counter of already read bytes.
public int	Returns: the byte read, or -1 if end of input is reached read() Overrides java.io.FilterInputStream.read. Reads a byte of data.

Inherited from java.io.FilterInputStream:: available close mark markSupported read read reset skip

Field Detail

BYTE_MASK	back to summary
private static final int BYTE_MASK

bytesRead	back to summary
private long bytesRead The number of bytes read in this stream

charset	back to summary
private Charset charset

single	back to summary
private final byte[] single

Constructor Detail

ArchiveInputStream	back to summary
public ArchiveInputStream() Constructs a new instance.

ArchiveInputStream back to summary

ArchiveInputStream	back to summary
private ArchiveInputStream(final InputStream inputStream, final Charset charset) Constructs a new instance. Parameters inputStream:InputStream the underlying input stream, or `null` if this instance is to be created without an underlying stream. charset:Charset charset. Since 1.26.0

private ArchiveInputStream(final InputStream inputStream, final Charset charset)

Constructs a new instance.

Parameters

inputStream:InputStream: the underlying input stream, or null if this instance is to be created without an underlying stream.
charset:Charset: charset.

Since

1.26.0

ArchiveInputStream back to summary

ArchiveInputStream	back to summary
protected ArchiveInputStream(final InputStream inputStream, final String charsetName) Constructs a new instance. Parameters inputStream:InputStream the underlying input stream, or `null` if this instance is to be created without an underlying stream. charsetName:String charset name. Since 1.26.0

protected ArchiveInputStream(final InputStream inputStream, final String charsetName)

Constructs a new instance.

Parameters

inputStream:InputStream: the underlying input stream, or null if this instance is to be created without an underlying stream.
charsetName:String: charset name.

Since

1.26.0

Method Detail

canReadEntryData	back to summary
public boolean canReadEntryData(final ArchiveEntry archiveEntry) Whether this stream is able to read the given entry. Some archive formats support variants or details that are not supported (yet). Parameters archiveEntry:ArchiveEntry the entry to test Returns:boolean This implementation always returns true. Since 1.1

canReadEntryData

back to summary

public boolean canReadEntryData(final ArchiveEntry archiveEntry)

Whether this stream is able to read the given entry.

Some archive formats support variants or details that are not supported (yet).

Parameters

archiveEntry:ArchiveEntry: the entry to test

Returns:boolean

This implementation always returns true.

Since

1.1

count	back to summary
protected void count(final int read) Increments the counter of already read bytes. Doesn't increment if the EOF has been hit (read == -1) Parameters read:int the number of bytes read

count

back to summary

protected void count(final int read)

Increments the counter of already read bytes. Doesn't increment if the EOF has been hit (read == -1)

Parameters

read:int: the number of bytes read

count	back to summary
protected void count(final long read) Increments the counter of already read bytes. Doesn't increment if the EOF has been hit (read == -1) Parameters read:long the number of bytes read Since 1.1

count

back to summary

protected void count(final long read)

Increments the counter of already read bytes. Doesn't increment if the EOF has been hit (read == -1)

Parameters

read:long: the number of bytes read

Since

1.1

getBytesRead	back to summary
public long getBytesRead() Gets the current number of bytes read from this stream. Returns:long the number of read bytes Since 1.1

getBytesRead

back to summary

public long getBytesRead()

Gets the current number of bytes read from this stream.

Returns:long: the number of read bytes
Since: 1.1

getCharset	back to summary
public Charset getCharset() Gets the Charest. Returns:Charset the Charest.

getCharset

back to summary

public Charset getCharset()

Gets the Charest.

Returns:Charset: the Charest.

getCount back to summary

getCount	back to summary
public int getCount() Deprecated this method may yield wrong results for large archives, use `getBytesRead()` instead. Gets the current number of bytes read from this stream. Returns:int the number of read bytes Annotations @Deprecated

public int getCount()

Deprecated

this method may yield wrong results for large archives, use getBytesRead() instead.

Gets the current number of bytes read from this stream.

Returns:int

the number of read bytes

Annotations

@Deprecated

getNextEntry back to summary

getNextEntry	back to summary
public abstract E getNextEntry() throws IOException Gets the next Archive Entry in this Stream. Returns:E the next entry, or `null` if there are no more entries Exceptions IOException: if the next entry could not be read

public abstract E getNextEntry() throws IOException

Gets the next Archive Entry in this Stream.

Returns:E

the next entry, or null if there are no more entries

Exceptions

IOException:: if the next entry could not be read

pushedBackBytes	back to summary
protected void pushedBackBytes(final long pushedBack) Decrements the counter of already read bytes. Parameters pushedBack:long the number of bytes pushed back. Since 1.1

pushedBackBytes

back to summary

protected void pushedBackBytes(final long pushedBack)

Decrements the counter of already read bytes.

Parameters

pushedBack:long: the number of bytes pushed back.

Since

1.1

read back to summary

read	back to summary
public int read() throws IOException Overrides java.io.FilterInputStream.read. Reads a byte of data. This method will block until enough input is available. Simply calls the `read(byte[], int, int)` method. MUST be overridden if the `read(byte[], int, int)` method is not overridden; may be overridden otherwise. Returns:int the byte read, or -1 if end of input is reached Annotations @Override Exceptions IOException: if an I/O error has occurred

public int read() throws IOException

Overrides java.io.FilterInputStream.read.

Reads a byte of data. This method will block until enough input is available. Simply calls the read(byte[], int, int) method. MUST be overridden if the read(byte[], int, int) method is not overridden; may be overridden otherwise.

Returns:int

the byte read, or -1 if end of input is reached

Annotations

@Override

Exceptions

IOException:: if an I/O error has occurred

public abstract Class ArchiveInputStream<E extends org.apache.commons.compress.archivers.ArchiveEntry>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail