Class DefaultLocalFileProvider

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

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

All Implemented Interfaces:

Closeable, AutoCloseable, FileProvider, LocalFileProvider, VfsComponent

public class DefaultLocalFileProvider
extends AbstractOriginatingFileProvider
implements LocalFileProvider

A file system provider, which uses direct file access.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
DefaultLocalFileProvider()	Constructs a new provider.

Method Summary

Modifier and Type	Method	Description
protected FileSystem	doCreateFileSystem(FileName name, FileSystemOptions fileSystemOptions)	Creates the file system.
FileObject	findLocalFile(File file)	Finds a local file.
FileObject	findLocalFile(String name)	Finds a local file, from its local name.
Collection<Capability>	getCapabilities()	Gets the file system capabilities.
boolean	isAbsoluteLocalName(String name)	Determines if a name is an absolute file name.

Methods inherited from class AbstractOriginatingFileProvider

findFile, findFile, getFileSystem

Methods inherited from class AbstractFileProvider

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

Methods inherited from interface FileProvider

createFileSystem, findFile, getConfigBuilder, parseUri

Field Details

capabilities

public static final Collection<Capability> capabilities

The provider's capabilities.

Constructor Details

DefaultLocalFileProvider

public DefaultLocalFileProvider()

Constructs a new provider.

Method Details

doCreateFileSystem

protected FileSystem doCreateFileSystem(FileName name,
 FileSystemOptions fileSystemOptions)
                                 throws FileSystemException

Creates the file system.

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.

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.

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.

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

Specified by:

getCapabilities in interface FileProvider

Returns:

a Collection of the file systems Capabilities.

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.