Class ArchiveInputStream<E extends ArchiveEntry>
java.lang.Object
java.io.InputStream
java.io.FilterInputStream
org.apache.commons.compress.archivers.ArchiveInputStream<E>
- Type Parameters:
E
- The type ofArchiveEntry
produced.
- All Implemented Interfaces:
Closeable
,AutoCloseable
- Direct Known Subclasses:
ArArchiveInputStream
,ArjArchiveInputStream
,CpioArchiveInputStream
,DumpArchiveInputStream
,TarArchiveInputStream
,ZipArchiveInputStream
Archive input streams MUST override the
FilterInputStream.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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final int
private long
The number of bytes read in this streamprivate Charset
private final byte[]
Fields inherited from class java.io.FilterInputStream
in
-
Constructor Summary
ConstructorsModifierConstructorDescriptionConstructs a new instance.protected
ArchiveInputStream
(InputStream inputStream, String charsetName) Constructs a new instance.private
ArchiveInputStream
(InputStream inputStream, Charset charset) Constructs a new instance. -
Method Summary
Modifier and TypeMethodDescriptionboolean
canReadEntryData
(ArchiveEntry archiveEntry) Whether this stream is able to read the given entry.protected void
count
(int read) Increments the counter of already read bytes.protected void
count
(long read) Increments the counter of already read bytes.void
Performs the given action for each element of the stream until all elements have been processed or the action throws an exception.long
Gets the current number of bytes read from this stream.Gets the Charest.int
getCount()
Deprecated.abstract E
Gets the next Archive Entry in this Stream.org.apache.commons.io.function.IOIterator
<E> iterator()
void
mark
(int readlimit) Does nothing.boolean
Always returns false.protected void
pushedBackBytes
(long pushedBack) Decrements the counter of already read bytes.int
read()
Reads a byte of data.void
reset()
Does nothing.
-
Field Details
-
BYTE_MASK
private static final int BYTE_MASK- See Also:
-
single
private final byte[] single -
bytesRead
private long bytesReadThe number of bytes read in this stream -
charset
-
-
Constructor Details
-
ArchiveInputStream
public ArchiveInputStream()Constructs a new instance. -
ArchiveInputStream
Constructs a new instance.- Parameters:
inputStream
- the underlying input stream, ornull
if this instance is to be created without an underlying stream.charset
- charset.- Since:
- 1.26.0
-
ArchiveInputStream
Constructs a new instance.- Parameters:
inputStream
- the underlying input stream, ornull
if this instance is to be created without an underlying stream.charsetName
- charset name.- Since:
- 1.26.0
-
-
Method Details
-
canReadEntryData
Whether this stream is able to read the given entry.Some archive formats support variants or details that are not supported (yet).
- Parameters:
archiveEntry
- the entry to test- Returns:
- This implementation always returns true.
- Since:
- 1.1
-
count
protected void count(int read) Increments the counter of already read bytes. Doesn't increment if the EOF has been hit (read == -1)- Parameters:
read
- the number of bytes read
-
count
protected void count(long read) Increments the counter of already read bytes. Doesn't increment if the EOF has been hit (read == -1)- Parameters:
read
- the number of bytes read- Since:
- 1.1
-
forEach
Performs the given action for each element of the stream until all elements have been processed or the action throws an exception. Actions are performed in the order of iteration. Exceptions thrown by the action are relayed to the caller.The behavior of this method is unspecified if the action performs side-effects that modify the underlying source of elements, unless an overriding class has specified a concurrent modification policy.
- Parameters:
action
- The action to be performed for each element- Throws:
IOException
- if an I/O error occurs.NullPointerException
- if the specified action is null- Since:
- 2.17.0
-
getBytesRead
public long getBytesRead()Gets the current number of bytes read from this stream.- Returns:
- the number of read bytes
- Since:
- 1.1
-
getCharset
Gets the Charest.- Returns:
- the Charest.
-
getCount
Deprecated.this method may yield wrong results for large archives, usegetBytesRead()
instead.Gets the current number of bytes read from this stream.- Returns:
- the number of read bytes
-
getNextEntry
Gets the next Archive Entry in this Stream.- Returns:
- the next entry, or
null
if there are no more entries. - Throws:
IOException
- if the next entry could not be read.
-
iterator
-
mark
public void mark(int readlimit) Does nothing. TODO [COMPRESS-670] Support mark() and reset() in ArchiveInputStream.- Overrides:
mark
in classFilterInputStream
- Parameters:
readlimit
- ignored.
-
markSupported
public boolean markSupported()Always returns false. TODO [COMPRESS-670] Support mark() and reset() in ArchiveInputStream.- Overrides:
markSupported
in classFilterInputStream
- Returns:
- Always returns false.
-
pushedBackBytes
protected void pushedBackBytes(long pushedBack) Decrements the counter of already read bytes.- Parameters:
pushedBack
- the number of bytes pushed back.- Since:
- 1.1
-
read
Reads a byte of data. This method will block until enough input is available. Simply calls theFilterInputStream.read(byte[], int, int)
method. MUST be overridden if theFilterInputStream.read(byte[], int, int)
method is not overridden; may be overridden otherwise.- Overrides:
read
in classFilterInputStream
- Returns:
- the byte read, or -1 if end of input is reached
- Throws:
IOException
- if an I/O error has occurred
-
reset
Does nothing. TODO [COMPRESS-670] Support mark() and reset() in ArchiveInputStream.- Overrides:
reset
in classFilterInputStream
- Throws:
IOException
- not thrown here but may be thrown from a subclass.
-
getBytesRead()
instead.