Class VirtualFileSystem

java.lang.Object

org.apache.commons.vfs2.provider.AbstractVfsComponent

org.apache.commons.vfs2.provider.AbstractFileSystem

org.apache.commons.vfs2.impl.VirtualFileSystem

All Implemented Interfaces:

Closeable, AutoCloseable, FileSystem, VfsComponent

public class VirtualFileSystem
extends AbstractFileSystem

A logical file system, made up of set of junctions, or links, to files from other file systems.

TODO - Handle nested junctions.

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<FileName, FileObject>	junctions

Constructor Summary

Constructors

Constructor	Description
VirtualFileSystem(AbstractFileName rootName, FileSystemOptions fileSystemOptions)

Method Summary

Modifier and Type	Method	Description
protected void	addCapabilities(Collection<Capability> caps)	Adds the capabilities of this file system.
void	addJunction(String junctionPoint, FileObject targetFile)	Adds a junction to this file system.
void	close()	Closes this component.
protected FileObject	createFile(AbstractFileName name)	Creates a file object.
private FileName	getJunctionForFile(FileName name)	Locates the junction point for the junction containing the given file.
void	removeJunction(String junctionPoint)	Removes a junction from this file system.

Methods inherited from class AbstractFileSystem

addListener, closeCommunicationLink, decorateFileObject, doCloseCommunicationLink, doReplicateFile, fireFileChanged, fireFileCreated, fireFileDeleted, getAttribute, getFileFromCache, getFileSystemManager, getFileSystemOptions, getLastModTimeAccuracy, getParentLayer, getRoot, getRootName, getRootURI, hasCapability, init, isOpen, isReleaseable, notifyAllStreamsClosed, putFileToCache, removeFileFromCache, removeListener, replicateFile, resolveFile, resolveFile, setAttribute

Methods inherited from class AbstractVfsComponent

getContext, getLogger, setContext, setLogger

Methods inherited from class Object

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

Field Details

junctions

private final Map<FileName, FileObject> junctions

Constructor Details

VirtualFileSystem

public VirtualFileSystem(AbstractFileName rootName,
 FileSystemOptions fileSystemOptions)

Method Details

addCapabilities

protected void addCapabilities(Collection<Capability> caps)

Adds the capabilities of this file system.

Specified by:

addCapabilities in class AbstractFileSystem

Parameters:

caps - collections of Capabilities, can be immutable.

createFile

protected FileObject createFile(AbstractFileName name)
                         throws Exception

Creates a file object. This method is called only if the requested file is not cached.

Specified by:

createFile in class AbstractFileSystem

Parameters:

name - name referencing the new file.

Returns:

new created FileObject.

Throws:

Exception - might throw an Exception, which is then wrapped in FileSystemException.

addJunction

public void addJunction(String junctionPoint,
 FileObject targetFile)
                 throws FileSystemException

Adds a junction to this file system.

Specified by:

addJunction in interface FileSystem

Overrides:

addJunction in class AbstractFileSystem

Parameters:

junctionPoint - The location of the junction.

targetFile - The target file to base the junction on.

Throws:

FileSystemException - if an error occurs.

removeJunction

public void removeJunction(String junctionPoint)
                    throws FileSystemException

Removes a junction from this file system.

Specified by:

removeJunction in interface FileSystem

Overrides:

removeJunction in class AbstractFileSystem

Parameters:

junctionPoint - The junction to remove.

Throws:

FileSystemException - if an error occurs.

getJunctionForFile

private FileName getJunctionForFile(FileName name)

Locates the junction point for the junction containing the given file.

Parameters:

name - The FileName.

Returns:

the FileName where the junction occurs.

close

public void close()

Description copied from class: AbstractFileSystem

Closes this component.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface VfsComponent

Overrides:

close in class AbstractFileSystem