de.schlichtherle.io.archive.spi.ArchiveDriver Maven / Gradle / Ivy
/*
* Copyright (C) 2006-2010 Schlichtherle IT Services
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package de.schlichtherle.io.archive.spi;
import de.schlichtherle.io.File;
import de.schlichtherle.io.FileInputStream;
import de.schlichtherle.io.FileOutputStream;
import de.schlichtherle.io.archive.Archive;
import de.schlichtherle.io.rof.ReadOnlyFile;
import java.io.CharConversionException;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.OutputStream;
import javax.swing.Icon;
/**
* This "driver" interface is used in a Builder software pattern as the
* Builder or Abstract Factory which reads and writes archives of a
* particular type, e.g. ZIP, TZP, JAR, TAR, TAR.GZ, TAR.BZ2 or any other.
* Archive drivers may be shared by multiple instances of
* {@link de.schlichtherle.io.ArchiveController} and
* {@link de.schlichtherle.io.ArchiveDetector}.
*
* The following requirements must be met by any implementation:
*
* - Implementations must be thread safe and (at least virtually) immutable:
* Otherwise, the class {@link de.schlichtherle.io.File} may seem to
* behave non-deterministic and may even throw exceptions where it
* shouldn't.
*
- Implementations must not assume that they are used as singletons:
* Multiple instances of an implementation may be used for the same
* archive type.
*
- If the driver should be supported by the driver registration process of
* the class {@link de.schlichtherle.io.DefaultArchiveDetector},
* a no-arguments constructor must be provided.
*
- Although not required, since TrueZIP 6.4 it's recommended for
* implementations to implement the {@link java.io.Serializable} interface,
* too, so that {@link de.schlichtherle.io.File} instances which are
* indirectly referring to it can be serialized.
*
*
* @author Christian Schlichtherle
* @version $Id: ArchiveDriver.java 06f3ba684701 2010/11/04 01:15:55 christian $
* @since TrueZIP 6.0
*/
public interface ArchiveDriver {
/**
* Creates a new input archive for {@code archive}
* from the given read only file.
*
* Note that if an exception is thrown, the method must be reentrant!
* In addition, the exception type determines the behaviour of the classes
* {@link File}, {@link FileInputStream} and {@link FileOutputStream}
* as follows:
*
*
* Exception type
* {@link File#isFile}
* {@link File#isDirectory}
* {@link File#exists}
* {@link File#delete}
*
*
* {@link FileNotFoundException}
* {@code false}
* {@code false}
* {@code true}
* {@code true} (unless prohibited by the real file system)
*
*
* {@link IOException}
* {@code true}
* {@code false}
* {@code true}
* {@code true} (unless prohibited by the real file system)
*
*
*
* @param archive The abstract archive representation which TrueZIP's
* internal {@code ArchiveController} is processing
* - never {@code null}.
* @param rof The {@link de.schlichtherle.io.rof.ReadOnlyFile} to read the
* actual archive contents from - never {@code null}.
* Hint: If you'ld prefer to have an {@code InputStream},
* you could decorate this parameter with a
* {@link de.schlichtherle.io.rof.ReadOnlyFileInputStream}.
* @return A new input archive instance.
* @throws TransientIOException If calling this method for the same
* archive file again may finally succeed.
* This exception is associated with another {@code IOException}
* as its cause which is unwrapped and interpreted as below.
* @throws FileNotFoundException If the input archive is inaccessible
* for any reason and you would like the package
* {@code de.schlichtherle.io} to mask the archive as a
* special file which cannot get read, written or deleted.
* @throws IOException On any other I/O or data format related issue
* when reading the input archive and you would like the package
* {@code de.schlichtherle.io} to treat the archive like a
* regular file which may be read, written or deleted.
* @see InputArchive
*/
InputArchive createInputArchive(
Archive archive,
ReadOnlyFile rof)
throws IOException;
/**
* Creates a new archive entry for {@code entryName}
* for use with an {@link OutputArchive}.
*
* @param archive The abstract archive representation which TrueZIP's
* internal {@code ArchiveController} is processing
* - never {@code null}.
* @param entryName A valid archive entry name - never {@code null}.
* @param template If not {@code null}, then the newly created entry
* shall inherit as much attributes from this object as possible
* (with the exception of the name).
* This is typically used for archive copy operations.
* Note that there is no guarantee on the runtime type of this
* object; it may have been created by other drivers.
* It is safe to ignore the {@code metaData} property when
* copying entries.
* @return A new archive entry instance.
* @throws CharConversionException If {@code name} contains
* illegal characters.
* @see Requirements for Archive Entry Names
*/
ArchiveEntry createArchiveEntry(
Archive archive,
String entryName,
ArchiveEntry template)
throws CharConversionException;
/**
* Creates a new output archive for {@code archive}
* from the given output stream.
*
* @param archive The abstract archive representation which TrueZIP's
* internal {@code ArchiveController} is processing
* - never {@code null}.
* @param out The {@link OutputStream} to write the archive entries to
* - never {@code null}.
* @param source The source {@link InputArchive} if
* {@code archive} is going to get updated.
* If not {@code null}, this is guaranteed to be a product
* of this driver's {@link #createInputArchive} method.
* This may be used to copy some meta data which is specific to
* the type of archive this driver supports.
* For example, this could be used to copy the comment of a ZIP
* file.
* @return A new output archive instance.
* @throws TransientIOException If calling this method for the same
* archive file again may finally succeed.
* This exception is associated with another {@code IOException}
* as its cause which is unwrapped and interpreted as below.
* @throws FileNotFoundException If the output archive is inaccessible
* for any reason.
* @throws IOException On any other I/O or data format related issue
* when writing the output archive.
* @see OutputArchive
*/
OutputArchive createOutputArchive(
Archive archive,
OutputStream out,
InputArchive source)
throws IOException;
/**
* Returns the icon that {@link de.schlichtherle.io.swing.tree.FileTreeCellRenderer}
* should display for the given archive.
*
* @param archive The abstract archive representation which TrueZIP's
* internal {@code ArchiveController} is processing
* - never {@code null}.
* @return The icon that should be displayed for the given archive if is
* is open/expanded in the view.
* If {@code null} is returned, a default icon should be used.
*/
Icon getOpenIcon(Archive archive);
/**
* Returns the icon that {@link de.schlichtherle.io.swing.FileSystemView}
* and {@link de.schlichtherle.io.swing.tree.FileTreeCellRenderer} should
* display for the given archive.
*
* @param archive The abstract archive representation which TrueZIP's
* internal {@code ArchiveController} is processing
* - never {@code null}.
* @return The icon that should be displayed for the given archive if is
* is closed/collapsed in the view.
* If {@code null} is returned, a default icon should be used.
*/
Icon getClosedIcon(Archive archive);
/**
* Archive drivers will be put into hash maps as keys,
* so be sure to implement this properly.
* Note that this is just a reinforcement of the general contract for
* {@link Object#equals} and the best possible implementation is the
* default implementation in {@code Object} which is most
* discriminating.
*
* @since TrueZIP 6.4
*/
boolean equals(Object o);
/**
* Archive drivers will be put into hash maps as keys,
* so be sure to implement this properly.
* Note that this is just a reinforcement of the general contract for
* {@link Object#hashCode} and the best possible implementation is the
* default implementation in {@code Object} which is most
* discriminating.
*
* @since TrueZIP 6.4
*/
int hashCode();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy