org.apache.commons.vfs2.provider.local
Class DefaultLocalFileProvider

java.lang.Object
  extended by org.apache.commons.vfs2.provider.AbstractVfsComponent
      extended by org.apache.commons.vfs2.provider.AbstractVfsContainer
          extended by org.apache.commons.vfs2.provider.AbstractFileProvider
              extended by org.apache.commons.vfs2.provider.AbstractOriginatingFileProvider
                  extended by org.apache.commons.vfs2.provider.local.DefaultLocalFileProvider
All Implemented Interfaces:
FileProvider, LocalFileProvider, VfsComponent

public class DefaultLocalFileProvider
extends AbstractOriginatingFileProvider
implements LocalFileProvider

A file system provider, which uses direct file access.

Author:
Commons VFS team

Field Summary
static Collection<Capability> capabilities
          The provider's capabilities.
 
Constructor Summary
DefaultLocalFileProvider()
           
 
Method Summary
protected  FileSystem doCreateFileSystem(FileName name, FileSystemOptions fileSystemOptions)
          Creates the filesystem.
 FileObject findLocalFile(File file)
          Finds a local file.
 FileObject findLocalFile(String name)
          Finds a local file, from its local name.
 Collection<Capability> getCapabilities()
          Get the filesystem capabilities.
These are the same as on the filesystem, but available before the first filesystem was instanciated.
 boolean isAbsoluteLocalName(String name)
          Determines if a name is an absolute file name.
 
Methods inherited from class org.apache.commons.vfs2.provider.AbstractOriginatingFileProvider
findFile, findFile, getFileSystem
 
Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileProvider
addFileSystem, close, closeFileSystem, createFileSystem, 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
 
Methods inherited from interface org.apache.commons.vfs2.provider.FileProvider
createFileSystem, findFile, getConfigBuilder, parseUri
 

Field Detail

capabilities

public static final Collection<Capability> capabilities
The provider's capabilities.

Constructor Detail

DefaultLocalFileProvider

public DefaultLocalFileProvider()
Method Detail

isAbsoluteLocalName

public boolean isAbsoluteLocalName(String name)
Determines if a name is an absolute file name.

Specified by:
isAbsoluteLocalName in interface LocalFileProvider
Parameters:
name - The file name.
Returns:
true if the name is absolute, false otherwise.

findLocalFile

public FileObject findLocalFile(String name)
                         throws FileSystemException
Finds a local file, from its local name.

Specified by:
findLocalFile in interface LocalFileProvider
Parameters:
name - The name of the file to locate.
Returns:
the located FileObject.
Throws:
FileSystemException - if an error occurs.

findLocalFile

public FileObject findLocalFile(File file)
                         throws FileSystemException
Finds a local file.

Specified by:
findLocalFile in interface LocalFileProvider
Parameters:
file - The File to locate.
Returns:
the located FileObject.
Throws:
FileSystemException - if an error occurs.

doCreateFileSystem

protected FileSystem doCreateFileSystem(FileName name,
                                        FileSystemOptions fileSystemOptions)
                                 throws FileSystemException
Creates the filesystem.

Specified by:
doCreateFileSystem in class AbstractOriginatingFileProvider
Parameters:
name - The name of the root file of the file system to create.
fileSystemOptions - The FileSystem options.
Returns:
The FileSystem.
Throws:
FileSystemException - if an error occurs.

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.

Specified by:
getCapabilities in interface FileProvider
Returns:
a Collection of the file systems Capabilities.


Copyright © 2002-2012 The Apache Software Foundation. All Rights Reserved.