Class ZipFileSystem
java.lang.Object
org.apache.commons.vfs2.provider.AbstractVfsComponent
org.apache.commons.vfs2.provider.AbstractFileSystem
org.apache.commons.vfs2.provider.zip.ZipFileSystem
- All Implemented Interfaces:
Closeable,AutoCloseable,FileSystem,VfsComponent
- Direct Known Subclasses:
JarFileSystem
A read-only file system for ZIP and JAR files.
-
Constructor Summary
ConstructorsConstructorDescriptionZipFileSystem(AbstractFileName rootFileName, FileObject parentLayer, FileSystemOptions fileSystemOptions) Constructs a new instance. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidaddCapabilities(Collection<Capability> caps) Returns the capabilities of this file system.protected FileObjectcreateFile(AbstractFileName name) Creates a file object.protected ZipFilecreateZipFile(File file) Creates a Zip file.protected ZipFileObjectcreateZipFileObject(AbstractFileName fileName, ZipEntry entry) Creates a new Zip file object.protected voidCloses the underlying link used to access the files.protected CharsetGets the Charset, defaults toStandardCharsets.UTF_8, the value used inZipFile.protected FileObjectgetFileFromCache(FileName name) Gets a cached file.protected ZipFileGets the zip file.voidinit()Initializes this component.protected voidputFileToCache(FileObject file) Adds a file object to the cache.protected voidremoveFileFromCache(FileName name) remove a cached file.toString()Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileSystem
addJunction, addListener, close, closeCommunicationLink, decorateFileObject, doReplicateFile, fireFileChanged, fireFileCreated, fireFileDeleted, getAttribute, getFileSystemManager, getFileSystemOptions, getLastModTimeAccuracy, getParentLayer, getRoot, getRootName, getRootURI, hasCapability, isOpen, isReleaseable, notifyAllStreamsClosed, removeJunction, removeListener, replicateFile, resolveFile, resolveFile, setAttributeMethods inherited from class org.apache.commons.vfs2.provider.AbstractVfsComponent
getContext, getLogger, setContext, setLogger
-
Constructor Details
-
ZipFileSystem
public ZipFileSystem(AbstractFileName rootFileName, FileObject parentLayer, FileSystemOptions fileSystemOptions) throws FileSystemException Constructs a new instance.- Parameters:
rootFileName- The root file name of this file system.parentLayer- The parent layer of this file system.fileSystemOptions- Options to build this file system.- Throws:
FileSystemException- If the parent layer does not exist, or on error replicating the file.
-
-
Method Details
-
addCapabilities
Returns the capabilities of this file system.- Specified by:
addCapabilitiesin classAbstractFileSystem- Parameters:
caps- collections of Capabilities, can be immutable.
-
createFile
Creates a file object.- Specified by:
createFilein classAbstractFileSystem- Parameters:
name- name referencing the new file.- Returns:
- new created FileObject.
- Throws:
FileSystemException
-
createZipFile
Creates a Zip file.- Parameters:
file- the underlying file.- Returns:
- a Zip file.
- Throws:
FileSystemException- if a file system error occurs.
-
createZipFileObject
protected ZipFileObject createZipFileObject(AbstractFileName fileName, ZipEntry entry) throws FileSystemException Creates a new Zip file object.- Parameters:
fileName- the underlying file.entry- the Zip entry.- Returns:
- a new ZipFileObject.
- Throws:
FileSystemException- if a file system error occurs.
-
doCloseCommunicationLink
Description copied from class:AbstractFileSystemCloses the underlying link used to access the files.- Overrides:
doCloseCommunicationLinkin classAbstractFileSystem
-
getCharset
Gets the Charset, defaults toStandardCharsets.UTF_8, the value used inZipFile.- Returns:
- the Charset.
-
getFileFromCache
Gets a cached file.- Overrides:
getFileFromCachein classAbstractFileSystem- Parameters:
name- name to search for.- Returns:
- file object or null if not found.
-
getZipFile
Gets the zip file.- Returns:
- the zip file.
- Throws:
FileSystemException- if a file system error occurs.
-
init
Description copied from class:AbstractFileSystemInitializes this component.- Specified by:
initin interfaceVfsComponent- Overrides:
initin classAbstractFileSystem- Throws:
FileSystemException- if an error occurs.
-
putFileToCache
Adds a file object to the cache.- Overrides:
putFileToCachein classAbstractFileSystem- Parameters:
file- the file to add.
-
removeFileFromCache
remove a cached file.- Overrides:
removeFileFromCachein classAbstractFileSystem- Parameters:
name- The file name to remove.
-
toString
-