Class CompressedFileFileProvider
java.lang.Object
org.apache.commons.vfs2.provider.AbstractVfsComponent
org.apache.commons.vfs2.provider.AbstractVfsContainer
org.apache.commons.vfs2.provider.AbstractFileProvider
org.apache.commons.vfs2.provider.AbstractLayeredFileProvider
org.apache.commons.vfs2.provider.compressed.CompressedFileFileProvider
- All Implemented Interfaces:
Closeable,AutoCloseable,FileProvider,VfsComponent
- Direct Known Subclasses:
Bzip2FileProvider,GzipFileProvider
A file system provider for compressed files. Provides read-only file systems.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract FileSystemcreateFileSystem(FileName name, FileObject file, FileSystemOptions fileSystemOptions) Create a FileSystem.protected FileSystemdoCreateFileSystem(String scheme, FileObject file, FileSystemOptions fileSystemOptions) Creates a layered file system.abstract Collection<Capability> Gets the file system capabilities.Methods inherited from class org.apache.commons.vfs2.provider.AbstractLayeredFileProvider
createFileSystem, findFileMethods inherited from class org.apache.commons.vfs2.provider.AbstractFileProvider
addFileSystem, close, closeFileSystem, findFileSystem, freeUnusedResources, getConfigBuilder, getFileNameParser, parseUri, setFileNameParserMethods inherited from class org.apache.commons.vfs2.provider.AbstractVfsContainer
addComponent, removeComponentMethods inherited from class org.apache.commons.vfs2.provider.AbstractVfsComponent
getContext, getLogger, init, setContext, setLogger
-
Constructor Details
-
CompressedFileFileProvider
public CompressedFileFileProvider()Constructs a new instance.
-
-
Method Details
-
createFileSystem
protected abstract FileSystem createFileSystem(FileName name, FileObject file, FileSystemOptions fileSystemOptions) throws FileSystemException Create a FileSystem.- Parameters:
name- a file name.file- a file object.fileSystemOptions- the file system options.- Returns:
- a FileSystem.
- Throws:
FileSystemException- if a file system error occurs.
-
doCreateFileSystem
protected FileSystem doCreateFileSystem(String scheme, FileObject file, FileSystemOptions fileSystemOptions) throws FileSystemException Creates a layered file system. This method is called if the file system is not cached.- Specified by:
doCreateFileSystemin classAbstractLayeredFileProvider- Parameters:
scheme- The URI scheme.file- The file to create the file system on top of.fileSystemOptions- options for new and underlying file systems.- Returns:
- The file system.
- Throws:
FileSystemException- if the file system cannot be created.
-
getCapabilities
Description copied from interface:FileProviderGets the file system capabilities.These are the same as on the file system, but available before the first file system was instantiated.
- Returns:
- a Collection of the file systems Capabilities.
-