de.schlichtherle.truezip.fs.archive.zip.JarDriver 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.fs.archive.zip;

import de.schlichtherle.truezip.socket.IOPoolProvider;
import de.schlichtherle.truezip.zip.DateTimeConverter;
import de.schlichtherle.truezip.zip.ZipEntry;
import java.nio.charset.Charset;
import javax.annotation.concurrent.Immutable;

/**
 * An archive driver for Java Archive files (JAR).
 * JAR files use the UTF-8 character set for the encoding of entry
 * names and comments.
 * They also apply the date/time conversion rules according to
 * {@link DateTimeConverter#JAR}.
 * This configuration makes this driver applicable for all countries.
 * However, it pretty much constraints the interoperability of this driver to
 * Java applications and Info-ZIP.
 * Therefore, while you should not use this driver to access plain old
 * ZIP files, you should definitely use it for custom application file formats
 * 
 * Other than this, JAR files are treated like plain old ZIP files.
 * In particular, this class does not check or ensure a certain
 * directory structure or the existance of certain entries (e.g.
 * {@code META-INF/MANIFEST.MF}) within a JAR file.
 * 

 * This driver does not check the CRC value of any entries in existing
 * archives - use {@link CheckedJarDriver} instead.
 * 
 * Sub-classes must be thread-safe and should be immutable!
 *
 * @author  Christian Schlichtherle
 */
@Immutable
public class JarDriver extends ZipDriver {

    /**
     * The character set for entry names and comments in JAR files, which is
     * {@code "UTF-8"}.
     */
    public static final Charset JAR_CHARSET = Charset.forName("UTF-8");

    /**
     * Constructs a new JAR file driver.
     * This constructor uses {@link #JAR_CHARSET} for encoding entry names
     * and comments.
     *
     * @param provider the provider for the I/O buffer pool.
     */
    public JarDriver(IOPoolProvider provider) {
        super(provider, JAR_CHARSET);
    }

    /**
     * Returns a new JAR archive entry with the given {@code name}.
     *
     * @param  name the entry name.
     * @return {@code new JarDriverEntry(name)}
     */
    @Override
    public JarDriverEntry newEntry(String name) {
        return new JarDriverEntry(name);
    }

    /**
     * Returns a new JAR archive entry with the given {@code name} and all
     * other properties copied from the given template.
     *
     * @param  name the entry name.
     * @return {@code new JarDriverEntry(name, template)}
     */
    @Override
    public JarDriverEntry newEntry(String name, ZipEntry template) {
        return new JarDriverEntry(name, template);
    }
}