Package org.apache.commons.vfs2.provider.zip

Class ZipFileProvider

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

All Implemented Interfaces:

Closeable, AutoCloseable, FileProvider, VfsComponent

Direct Known Subclasses:

JarFileProvider

public class ZipFileProvider
extends AbstractLayeredFileProvider

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

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Collection<Capability>	capabilities	The list of capabilities this provider supports

Constructor Summary

Constructors

Constructor	Description
ZipFileProvider()	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.
FileSystemConfigBuilder	getConfigBuilder()	Gets config builder.

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

Field Details

capabilities

protected static final Collection<Capability> capabilities

The list of capabilities this provider supports

Constructor Details

ZipFileProvider

public ZipFileProvider()

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.

getConfigBuilder

public FileSystemConfigBuilder getConfigBuilder()

Gets config builder.

Specified by:

getConfigBuilder in interface FileProvider

Overrides:

getConfigBuilder in class AbstractFileProvider

Returns:

A config builder for ZipFileProvider.

See Also:

• AbstractFileProvider.getConfigBuilder()