org.apache.commons.vfs2.provider.res
Class ResourceFileProvider

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

All Implemented Interfaces:

FileProvider, VfsComponent

public class ResourceFileProvider
extends AbstractFileProvider

The Resource provider.

Author:

Commons VFS team

Field Summary

protected static Collection<Capability>

capabilities The provider's capabilities

Constructor Summary

ResourceFileProvider()

Method Summary

void	closeFileSystem(FileSystem filesystem) Close the FileSystem.
FileObject	findFile(FileObject baseFile, String uri, FileSystemOptions fileSystemOptions) Locates a file object, by absolute URI.
Collection<Capability>	getCapabilities() Get the filesystem capabilities. These are the same as on the filesystem, but available before the first filesystem was instanciated.
FileSystemConfigBuilder	getConfigBuilder() Returns the FileSystemConfigBuidler.

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

addFileSystem, close, createFileSystem, 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 Detail

capabilities

protected static final Collection<Capability> capabilities

The provider's capabilities

Constructor Detail

ResourceFileProvider

public ResourceFileProvider()

Method Detail

findFile

public FileObject findFile(FileObject baseFile,
                           String uri,
                           FileSystemOptions fileSystemOptions)
                    throws FileSystemException

Locates a file object, by absolute URI.

Parameters:

baseFile - The base file.

uri - The URI of the file to locate.

fileSystemOptions - The FileSystem options.

Returns:

the FileObject.

Throws:

FileSystemException - if an error occurs.

getConfigBuilder

public FileSystemConfigBuilder getConfigBuilder()

Description copied from class: AbstractFileProvider

Returns the FileSystemConfigBuidler.

Specified by:

getConfigBuilder in interface FileProvider

Overrides:

getConfigBuilder in class AbstractFileProvider

Returns:

the FileSystemConfigBuilder.

closeFileSystem

public void closeFileSystem(FileSystem filesystem)

Description copied from class: AbstractFileProvider

Close the FileSystem.

Overrides:

closeFileSystem in class AbstractFileProvider

Parameters:

filesystem - The FileSystem to close.

getCapabilities

public Collection<Capability> getCapabilities()

Description copied from interface: FileProvider

Get the filesystem capabilities.
These are the same as on the filesystem, but available before the first filesystem was instanciated.

Returns:

a Collection of the file systems Capabilities.