Class DefaultVfsComponentContext

java.lang.Object

org.apache.commons.vfs2.impl.DefaultVfsComponentContext

All Implemented Interfaces:

VfsComponentContext

final class DefaultVfsComponentContext
extends Object
implements VfsComponentContext

The default context implementation.

Field Summary

Fields

Modifier and Type	Field	Description
private final DefaultFileSystemManager	manager

Constructor Summary

Constructors

Constructor	Description
DefaultVfsComponentContext(DefaultFileSystemManager manager)

Method Summary

Modifier and Type	Method	Description
FileSystemManager	getFileSystemManager()	Returns the file system manager for the current context
FileReplicator	getReplicator()	Locates a file replicator for the provider to use.
TemporaryFileStore	getTemporaryFileStore()	Locates a temporary file store for the provider to use.
FileName	parseURI(String uri)	Parses a URI into a FileName.
FileObject	resolveFile(String name, FileSystemOptions fileSystemOptions)	Locate a file by name.
FileObject	resolveFile(FileObject baseFile, String name, FileSystemOptions fileSystemOptions)	Locate a file by name.
FileObject	toFileObject(File file)	Returns a FileObject for a local file.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

manager

private final DefaultFileSystemManager manager

Constructor Details

DefaultVfsComponentContext

public DefaultVfsComponentContext(DefaultFileSystemManager manager)

Method Details

resolveFile

public FileObject resolveFile(FileObject baseFile,
 String name,
 FileSystemOptions fileSystemOptions)
                       throws FileSystemException

Locate a file by name.

Specified by:

resolveFile in interface VfsComponentContext

Parameters:

baseFile - The base FileObject.

name - The name of the file to locate.

fileSystemOptions - The FileSystemOptions.

Returns:

The FileObject for the located file.

Throws:

FileSystemException - if an error occurs.

resolveFile

public FileObject resolveFile(String name,
 FileSystemOptions fileSystemOptions)
                       throws FileSystemException

Locate a file by name.

Specified by:

resolveFile in interface VfsComponentContext

Parameters:

name - The name of the file to locate.

fileSystemOptions - The FileSystemOptions.

Returns:

The FileObject for the located file.

Throws:

FileSystemException - if an error occurs.

parseURI

public FileName parseURI(String uri)
                  throws FileSystemException

Description copied from interface: VfsComponentContext

Parses a URI into a FileName.

Specified by:

parseURI in interface VfsComponentContext

Parameters:

uri - The URI String.

Returns:

The FileName.

Throws:

FileSystemException - if an error occurs.

toFileObject

public FileObject toFileObject(File file)
                        throws FileSystemException

Returns a FileObject for a local file.

Specified by:

toFileObject in interface VfsComponentContext

Parameters:

file - The File to convert to a FileObject.

Returns:

the FileObject.

Throws:

FileSystemException - if an error occurs.

getReplicator

public FileReplicator getReplicator()
                             throws FileSystemException

Locates a file replicator for the provider to use.

Specified by:

getReplicator in interface VfsComponentContext

Returns:

The FileReplicator.

Throws:

FileSystemException - if an error occurs.

getTemporaryFileStore

public TemporaryFileStore getTemporaryFileStore()
                                         throws FileSystemException

Locates a temporary file store for the provider to use.

Specified by:

getTemporaryFileStore in interface VfsComponentContext

Returns:

The TemporaryFileStore.

Throws:

FileSystemException - if an error occurs.

getFileSystemManager

public FileSystemManager getFileSystemManager()

Returns the file system manager for the current context

Specified by:

getFileSystemManager in interface VfsComponentContext

Returns:

the file system manager