Package proguard.io

Class ZipWriter

  • All Implemented Interfaces:
    java.lang.AutoCloseable, DataEntryWriter
    public class ZipWriter
extends java.lang.Object
implements DataEntryWriter
    This DataEntryWriter sends data entries to the zip files specified by their parents.

    • Constructor Summary

      Constructors 
      Constructor Description
      ZipWriter​(DataEntryWriter dataEntryWriter)
      Creates a new ZipWriter that compresses all zip entries.
      ZipWriter​(StringMatcher uncompressedFilter, int uncompressedAlignment, boolean useZip64, int modificationTime, byte[] header, DataEntryWriter dataEntryWriter)
      Creates a new ZipWriter.
      ZipWriter​(StringMatcher uncompressedFilter, int uncompressedAlignment, boolean useZip64, int modificationTime, DataEntryWriter dataEntryWriter)
      Creates a new ZipWriter.
      ZipWriter​(StringMatcher uncompressedFilter, int uncompressedAlignment, boolean useZip64, StringMatcher extraUncompressedAlignmentFilter, int extraUncompressedAlignment, int modificationTime, byte[] header, DataEntryWriter dataEntryWriter)
      Creates a new ZipWriter.
      ZipWriter​(StringMatcher uncompressedFilter, int uncompressedAlignment, boolean useZip64, StringMatcher extraUncompressedAlignmentFilter, int extraUncompressedAlignment, int modificationTime, DataEntryWriter dataEntryWriter)
      Creates a new ZipWriter.
      ZipWriter​(StringMatcher uncompressedFilter, int uncompressedAlignment, StringMatcher extraUncompressedAlignmentFilter, int extraUncompressedAlignment, int modificationTime, byte[] header, DataEntryWriter dataEntryWriter)
      Creates a new ZipWriter.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Finishes writing all data entries.
      boolean createDirectory​(DataEntry dataEntry)
      Creates a directory.
      java.io.OutputStream createOutputStream​(DataEntry dataEntry)
      Creates a new output stream for writing data.
      protected ZipOutput createZipOutput​(java.io.OutputStream outputStream, byte[] header, int uncompressedAlignment, boolean useZip64, java.lang.String comment)
      Creates a zip output with the given header and parameters.
      void println​(java.io.PrintWriter pw, java.lang.String prefix)
      Prints out the structure of the data entry writer.
      boolean sameOutputStream​(DataEntry dataEntry1, DataEntry dataEntry2)
      Returns whether the two given data entries would result in the same output stream.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • currentZipOutput

        public ZipOutput currentZipOutput

    • Constructor Detail

      • ZipWriter

        public ZipWriter​(DataEntryWriter dataEntryWriter)
        Creates a new ZipWriter that compresses all zip entries.
        Parameters:
        dataEntryWriter - the data entry writer that can provide output streams for the zip archives.

      • ZipWriter

        public ZipWriter​(StringMatcher uncompressedFilter,
                 int uncompressedAlignment,
                 boolean useZip64,
                 int modificationTime,
                 DataEntryWriter dataEntryWriter)
        Creates a new ZipWriter.
        Parameters:
        uncompressedFilter - an optional filter for files that should not be compressed.
        uncompressedAlignment - the desired alignment for the data of uncompressed entries.
        useZip64 - Whether to write out the archive in zip64 format.
        modificationTime - the modification date and time of the zip entries, in DOS format.
        dataEntryWriter - the data entry writer that can provide output streams for the zip archives.

      • ZipWriter

        public ZipWriter​(StringMatcher uncompressedFilter,
                 int uncompressedAlignment,
                 boolean useZip64,
                 StringMatcher extraUncompressedAlignmentFilter,
                 int extraUncompressedAlignment,
                 int modificationTime,
                 DataEntryWriter dataEntryWriter)
        Creates a new ZipWriter.
        Parameters:
        uncompressedFilter - an optional filter for files that should not be compressed.
        uncompressedAlignment - the desired alignment for the data of uncompressed entries.
        useZip64 - Whether to write out the archive in zip64 format.
        extraUncompressedAlignmentFilter - an optional filter for files that should not be compressed and use a different alignment.
        extraUncompressedAlignment - the desired alignment for the data of entries matching extraAlignmentFilter.
        modificationTime - the modification date and time of the zip entries, in DOS format.
        dataEntryWriter - the data entry writer that can provide output streams for the zip archives.

      • ZipWriter

        public ZipWriter​(StringMatcher uncompressedFilter,
                 int uncompressedAlignment,
                 boolean useZip64,
                 int modificationTime,
                 byte[] header,
                 DataEntryWriter dataEntryWriter)
        Creates a new ZipWriter.
        Parameters:
        uncompressedFilter - an optional filter for files that should not be compressed.
        uncompressedAlignment - the desired alignment for the data of uncompressed entries.
        useZip64 - Whether to write out the archive in zip64 format.
        modificationTime - the modification date and time of the zip entries, in DOS format.
        dataEntryWriter - the data entry writer that can provide output streams for the zip archives.

      • ZipWriter

        public ZipWriter​(StringMatcher uncompressedFilter,
                 int uncompressedAlignment,
                 StringMatcher extraUncompressedAlignmentFilter,
                 int extraUncompressedAlignment,
                 int modificationTime,
                 byte[] header,
                 DataEntryWriter dataEntryWriter)
        Creates a new ZipWriter.
        Parameters:
        uncompressedFilter - an optional filter for files that should not be compressed.
        uncompressedAlignment - the desired alignment for the data of uncompressed entries.
        extraUncompressedAlignmentFilter - an optional filter for files that should not be compressed and use a different alignment.
        extraUncompressedAlignment - the desired alignment for the data of entries matching extraAlignmentFilter.
        modificationTime - the modification date and time of the zip entries, in DOS format.
        dataEntryWriter - the data entry writer that can provide output streams for the zip archives.

      • ZipWriter

        public ZipWriter​(StringMatcher uncompressedFilter,
                 int uncompressedAlignment,
                 boolean useZip64,
                 StringMatcher extraUncompressedAlignmentFilter,
                 int extraUncompressedAlignment,
                 int modificationTime,
                 byte[] header,
                 DataEntryWriter dataEntryWriter)
        Creates a new ZipWriter.
        Parameters:
        uncompressedFilter - an optional filter for files that should not be compressed.
        uncompressedAlignment - the desired alignment for the data of uncompressed entries.
        useZip64 - Whether to write out the archive in zip64 format.
        extraUncompressedAlignmentFilter - an optional filter for files that should not be compressed and use a different alignment.
        extraUncompressedAlignment - the desired alignment for the data of entries matching extraAlignmentFilter.
        modificationTime - the modification date and time of the zip entries, in DOS format.
        dataEntryWriter - the data entry writer that can provide output streams for the zip archives.

    • Method Detail

      • createDirectory

        public boolean createDirectory​(DataEntry dataEntry)
                        throws java.io.IOException
        Description copied from interface: DataEntryWriter
        Creates a directory.
        Specified by:
        createDirectory in interface DataEntryWriter
        Parameters:
        dataEntry - the data entry for which the directory is to be created.
        Returns:
        whether the directory has been created.
        Throws:
        java.io.IOException

      • sameOutputStream

        public boolean sameOutputStream​(DataEntry dataEntry1,
                                DataEntry dataEntry2)
                         throws java.io.IOException
        Description copied from interface: DataEntryWriter
        Returns whether the two given data entries would result in the same output stream.
        Specified by:
        sameOutputStream in interface DataEntryWriter
        Parameters:
        dataEntry1 - the first data entry.
        dataEntry2 - the second data entry.
        Throws:
        java.io.IOException

      • createOutputStream

        public java.io.OutputStream createOutputStream​(DataEntry dataEntry)
                                        throws java.io.IOException
        Description copied from interface: DataEntryWriter
        Creates a new output stream for writing data. The caller is responsible for closing the stream.
        Specified by:
        createOutputStream in interface DataEntryWriter
        Parameters:
        dataEntry - the data entry for which the output stream is to be created.
        Returns:
        the output stream. The stream may be null to indicate that the data entry should not be written.
        Throws:
        java.io.IOException

      • close

        public void close()
           throws java.io.IOException
        Description copied from interface: DataEntryWriter
        Finishes writing all data entries.

        Implementations typically create graphs of writers that can split and merge again, possibly even with cycles.

        For splits and merges, implementations need to be idempotent; once closed, subsequent attempts to close a writer have no effect. If needed, the wrapper NonClosingDataEntryWriter can avoid closing a branch prematurely.

        For cycles, implementations must perform any custom behavior, then delegate DataEntryWriter.close() invocations, and only finally clean up. It is possible that delegates call DataEntryWriter.createOutputStream(DataEntry) while DataEntryWriter.close() is in progress.

        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface DataEntryWriter
        Throws:
        java.io.IOException

      • println

        public void println​(java.io.PrintWriter pw,
                    java.lang.String prefix)
        Description copied from interface: DataEntryWriter
        Prints out the structure of the data entry writer.
        Specified by:
        println in interface DataEntryWriter
        Parameters:
        pw - the print stream to which the structure should be printed.
        prefix - a prefix for every printed line.

      • createZipOutput

        protected ZipOutput createZipOutput​(java.io.OutputStream outputStream,
                                    byte[] header,
                                    int uncompressedAlignment,
                                    boolean useZip64,
                                    java.lang.String comment)
                             throws java.io.IOException
        Creates a zip output with the given header and parameters.
        Throws:
        java.io.IOException