@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)

Package de.schlichtherle.truezip.file

Provides uniform, transparent, thread-safe, read/write access to archive files as if they were just plain directories in a file system path by means of the TFile* classes and their dependent classes.

See: Description

Class Summary

Class	Description
TApplication<E extends Exception>	A template class which aids in establishing the typical setup-work-sync life cycle of a TrueZIP application.
TArchiveDetector	Detects a prospective archive file and declares its file system type by mapping its file name suffix to an archive driver.
TConfig	A container for configuration options with global or inheritable thread local scope.
TFile	A replacement for the class File which provides transparent read/write access to archive files and their entries as if they were (virtual) directories and files.
TFileComparator	Compares two files by their status and path name so that directories are always ordered before other files.
TFileInputStream	A replacement for the class FileInputStream for reading plain old files or entries in an archive file.
TFileOutputStream	A replacement for the class FileOutputStream for writing plain old files or entries in an archive file.
TFileReader	A replacement for the class FileReader for reading plain old files or entries in an archive file.
TFileWriter	A replacement for the class FileWriter for writing plain old files or entries in an archive file.
TVFS	Static utility methods for virtual file system operations with global scope.

Enum Summary

Enum	Description
ExpertFeature.Level	The experience level required to safely use an expert feature.
ExpertFeature.Reason	The reason why a feature should only be used by an expert.

Annotation Types Summary

Annotation Type	Description
ExpertFeature	Indicates a feature which requires a certain experience level for safe use.

Package de.schlichtherle.truezip.file Description

Provides uniform, transparent, thread-safe, read/write access to archive files as if they were just plain directories in a file system path by means of the TFile* classes and their dependent classes.

This is the primary API for JSE 6 compliant TrueZIP applications: Like the API of the module TrueZIP Path, this API is just a facade for the module TrueZIP Kernel. In contrast to the TrueZIP Path API however, this API is limited to access the platform file system and any archive files within the platform file system. In contrast to the TrueZIP Kernel API, both APIs are designed to be easy to learn and convenient to use while providing a great level of flexibility. Because all virtual file system state is managed by the TrueZIP Kernel module, this module can concurrently access the same file systems than the TrueZIP Path module.

For example, an application could access an entry within an archive file using a TFile like this:

 File entry = new TFile("archive.zip/dir/HälloWörld.txt");
 Writer writer = new TFileWriter(entry);
 try {
     writer.write("Hello world!\n");
 } finally {
     writer.close();
 }
 

This example presumes that the JARs of the file system driver modules TrueZIP Driver File and TrueZIP Driver TAR are present on the run time class path.

Mind that a TFile is a File, so you can use it polymorphically. However, you cannot use it with a plain File(In|Out)putStream or a plain File(Reader|Writer) to access prospective archive entries because these classes were not designed for this task. You have to use a TFile(In|Out)putStream or a TFile(Reader|Writer) instead.

Author:

Christian Schlichtherle