Package org.apache.commons.vfs.provider
Class AbstractFileProvider
- java.lang.Object
-
- org.apache.commons.vfs.provider.AbstractVfsComponent
-
- org.apache.commons.vfs.provider.AbstractVfsContainer
-
- org.apache.commons.vfs.provider.AbstractFileProvider
-
- All Implemented Interfaces:
FileProvider
,VfsComponent
- Direct Known Subclasses:
AbstractLayeredFileProvider
,AbstractOriginatingFileProvider
,CompositeFileProvider
,ResourceFileProvider
,TemporaryFileProvider
,UrlFileProvider
public abstract class AbstractFileProvider extends AbstractVfsContainer implements FileProvider
A partialFileProvider
implementation. Takes care of managing the file systems created by the provider.- Version:
- $Revision: 480428 $ $Date: 2006-11-29 07:15:24 +0100 (Wed, 29 Nov 2006) $
- Author:
- Adam Murdoch
-
-
Constructor Summary
Constructors Constructor Description AbstractFileProvider()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addFileSystem(java.lang.Comparable key, FileSystem fs)
Adds a file system to those cached by this provider.void
close()
Closes the file systems created by this provider.void
closeFileSystem(FileSystem filesystem)
FileObject
createFileSystem(java.lang.String scheme, FileObject file, FileSystemOptions properties)
Creates a layered file system.protected FileSystem
findFileSystem(java.lang.Comparable key, FileSystemOptions fileSystemProps)
Locates a cached file systemvoid
freeUnusedResources()
FileSystemConfigBuilder
getConfigBuilder()
Gets the configbuilder useable to collect the needed fileSystemOptions.protected FileNameParser
getFileNameParser()
FileName
parseUri(FileName base, java.lang.String uri)
Parses an absolute URI.protected void
setFileNameParser(FileNameParser parser)
-
Methods inherited from class org.apache.commons.vfs.provider.AbstractVfsContainer
addComponent, removeComponent
-
Methods inherited from class org.apache.commons.vfs.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
-
Methods inherited from interface org.apache.commons.vfs.provider.FileProvider
findFile, getCapabilities
-
-
-
-
Method Detail
-
getFileNameParser
protected FileNameParser getFileNameParser()
-
setFileNameParser
protected void setFileNameParser(FileNameParser parser)
-
close
public void close()
Closes the file systems created by this provider.- Specified by:
close
in interfaceVfsComponent
- Overrides:
close
in classAbstractVfsContainer
-
createFileSystem
public FileObject createFileSystem(java.lang.String scheme, FileObject file, FileSystemOptions properties) throws FileSystemException
Creates a layered file system. This method throws a 'not supported' exception.- Specified by:
createFileSystem
in interfaceFileProvider
- Parameters:
scheme
- The URI scheme for the layered file system.file
- The file to build the file system on.- Throws:
FileSystemException
-
addFileSystem
protected void addFileSystem(java.lang.Comparable key, FileSystem fs) throws FileSystemException
Adds a file system to those cached by this provider. The file system may implementVfsComponent
, in which case it is initialised.- Throws:
FileSystemException
-
findFileSystem
protected FileSystem findFileSystem(java.lang.Comparable key, FileSystemOptions fileSystemProps)
Locates a cached file system- Returns:
- The provider, or null if it is not cached.
-
getConfigBuilder
public FileSystemConfigBuilder getConfigBuilder()
Description copied from interface:FileProvider
Gets the configbuilder useable to collect the needed fileSystemOptions.- Specified by:
getConfigBuilder
in interfaceFileProvider
-
freeUnusedResources
public void freeUnusedResources()
-
closeFileSystem
public void closeFileSystem(FileSystem filesystem)
-
parseUri
public FileName parseUri(FileName base, java.lang.String uri) throws FileSystemException
Parses an absolute URI.- Specified by:
parseUri
in interfaceFileProvider
- Parameters:
base
- The base file - if null theuri
needs to be absoluteuri
- The URI to parse.- Throws:
FileSystemException
-
-