de.schlichtherle.truezip.zip.ZipFileParameters Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of truezip-driver-zip Show documentation

The file system driver family for ZIP and related archive file types. Add the JAR artifact of this module to the run time class path to make its file system drivers available for service location in the client API modules.

There is a newer version: 7.7.10

Show newest version

/*
 * Copyright (C) 2005-2013 Schlichtherle IT Services.
 * All rights reserved. Use is subject to license terms.
 */
package de.schlichtherle.truezip.zip;

/**
 * Provides parameters for reading ZIP files.
 * 
 * Warning: This interface is not intended for public use
 * - its API may change at will without prior notification!
 * 
 * @param    The type of the created ZIP entries.
 * @since   TrueZIP 7.3
 * @author  Christian Schlichtherle
 */
public interface ZipFileParameters
extends ZipCharsetParameters, ZipEntryFactory {

    /**
     * Returns the flag for allowing a preamble.
     * 

     * If this method returns {@code true}, then a ZIP file is allowed to
     * contain arbitrary data as its preamble before the actual ZIP file data.
     * Self Extracting Archives typically use a preamble to store the
     * application code that is required to extract the ZIP file contents.
     * 

     * If this method returns {@code false}, the a ZIP file must start with
     * either a Local File Header (LFH) signature,
     * a ZIP64 End Of Central Directory Record (EOCDR) signature or an End Of
     * Central Directory Record (EOCDR) signature.
     *
     * @return The flag for allowing a preamble.
     */
    boolean getPreambled();

    /**
     * Returns the flag for allowing a postamble of arbitrary length.
     * 

     * If this method returns {@code true}, then a ZIP file is allowed to
     * contain arbitrary data of arbitrary length as its postamble after the
     * actual ZIP file data.
     * Note that searching for an arbitrary length postamble can seriously
     * degrade the performance when reading a false positive ZIP file, i.e.
     * an arbitrary file which is not compatible to the ZIP File Format
     * Specification, because then the entire file needs to get searched for
     * an End Of Central Directory Record (EOCDR) signature.
     * A valid use case are self extracting ZIP files with very large
     * postambles to host the extraction code.
     * 
     * If this method returns {@code false}, then a ZIP file may still have a
     * postamble, but it must not exceed 64KB size, including the End Of
     * Central Directory record with the ZIP file comment.
     * This causes the reading of a false positive ZIP file to fail fast.
     *
     * @return The flag for allowing a postamble of arbitrary length.
     */
    boolean getPostambled();
}