Package org.apache.commons.vfs2.provider.compressed

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

public abstract class CompressedFileFileProvider
extends AbstractLayeredFileProvider

A file system provider for compressed files. Provides read-only file systems.

Constructor Summary

Constructors

Constructor	Description
CompressedFileFileProvider()	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
protected abstract FileSystem	createFileSystem(FileName name, FileObject file, FileSystemOptions fileSystemOptions)	Create a FileSystem.
protected FileSystem	doCreateFileSystem(String scheme, FileObject file, FileSystemOptions fileSystemOptions)	Creates a layered file system.
abstract Collection<Capability>	getCapabilities()	Gets the file system capabilities.

Methods inherited from class org.apache.commons.vfs2.provider.AbstractLayeredFileProvider

createFileSystem, findFile

Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileProvider

addFileSystem, close, closeFileSystem, findFileSystem, freeUnusedResources, getConfigBuilder, getFileNameParser, parseUri, setFileNameParser

Methods inherited from class org.apache.commons.vfs2.provider.AbstractVfsContainer

addComponent, removeComponent

Methods inherited from class org.apache.commons.vfs2.provider.AbstractVfsComponent

getContext, getLogger, init, setContext, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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:

doCreateFileSystem in class AbstractLayeredFileProvider

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

public abstract Collection<Capability> getCapabilities()

Description copied from interface: FileProvider

Gets 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.