Class TarFileProvider

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.tar.TarFileProvider

All Implemented Interfaces:

Closeable, AutoCloseable, FileProvider, VfsComponent

public class TarFileProvider
extends AbstractLayeredFileProvider

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

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Collection<Capability>	capabilities	The provider's capabilities

Constructor Summary

Constructors

Constructor	Description
TarFileProvider()	Constructs a new instance.

Method Summary

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

Methods inherited from class AbstractLayeredFileProvider

createFileSystem, findFile

Methods inherited from class AbstractFileProvider

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

Methods inherited from class AbstractVfsContainer

addComponent, removeComponent

Methods inherited from class AbstractVfsComponent

getContext, getLogger, init, setContext, setLogger

Methods inherited from class Object

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

Field Details

capabilities

protected static final Collection<Capability> capabilities

The provider's capabilities

Constructor Details

TarFileProvider

public TarFileProvider()

Constructs a new instance.

Method Details

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