Package org.apache.commons.compress.archivers

Class ArchiveInputStream

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable
    Direct Known Subclasses:
    ArArchiveInputStream, ArjArchiveInputStream, CpioArchiveInputStream, DumpArchiveInputStream, TarArchiveInputStream, ZipArchiveInputStream
    public abstract class ArchiveInputStream
extends java.io.InputStream
    Archive input streams MUST override the InputStream.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.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean canReadEntryData​(ArchiveEntry archiveEntry)
      Whether this stream is able to read the given entry.
      long getBytesRead()
      Returns the current number of bytes read from this stream.
      int getCount()
      Deprecated.
      this method may yield wrong results for large archives, use #getBytesRead instead
      abstract ArchiveEntry getNextEntry()
      Returns the next Archive Entry in this Stream.
      int read()
      Reads a byte of data.

      • Methods inherited from class java.io.InputStream

        available, close, mark, markSupported, nullInputStream, read, read, readAllBytes, readNBytes, readNBytes, reset, skip, transferTo

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ArchiveInputStream

        public ArchiveInputStream()

    • Method Detail

      • getNextEntry

        public abstract ArchiveEntry getNextEntry()
                                   throws java.io.IOException
        Returns the next Archive Entry in this Stream.
        Returns:
        the next entry, or null if there are no more entries
        Throws:
        java.io.IOException - if the next entry could not be read

      • read

        public int read()
         throws java.io.IOException
        Reads a byte of data. This method will block until enough input is available. Simply calls the InputStream.read(byte[], int, int) method. MUST be overridden if the InputStream.read(byte[], int, int) method is not overridden; may be overridden otherwise.
        Specified by:
        read in class java.io.InputStream
        Returns:
        the byte read, or -1 if end of input is reached
        Throws:
        java.io.IOException - if an I/O error has occurred

      • getCount

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

      • getBytesRead

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

      • canReadEntryData

        public boolean canReadEntryData​(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 - the entry to test
        Returns:
        This implementation always returns true.
        Since:
        1.1