vfs
Class VFSRoot

java.lang.Object
  vfs.VFSRoot

public class VFSRoot
extends java.lang.Object

A VFSRoot is the root of a virtual file system. It provides access to the root directory and provides an escort method for escorting visitors through the file system.

Constructor Summary

VFSRoot(java.lang.Class c)
new VFSRoot(c) returns a virtual file system root for the package that contains c.

VFSRoot(java.lang.Class c, java.lang.String nm)
new VFSRoot(c, nm) returns a virtual file system root for the directory named nm in the classpath entry containing c.

Method Summary

void	escort(VFSVisitor v) vfsr.escort(v) escorts v through the virtual file system whose root is vfsr.
VFSDirectory	getRootDirectory() vfsr.getRootDirectory() returns the topmost directory for vfsr.

Methods inherited from class java.lang.Object

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

Constructor Detail

VFSRoot

public VFSRoot(java.lang.Class c,
               java.lang.String nm)

new VFSRoot(c, nm) returns a virtual file system root for the directory named nm in the classpath entry containing c.

Parameters:

c - the class that determines the classpath entry

nm - the name of the directory

VFSRoot

public VFSRoot(java.lang.Class c)

new VFSRoot(c) returns a virtual file system root for the package that contains c.

Parameters:

c - the class that determines the package

Method Detail

getRootDirectory

public VFSDirectory getRootDirectory()

vfsr.getRootDirectory() returns the topmost directory for vfsr.

escort

public void escort(VFSVisitor v)

vfsr.escort(v) escorts v through the virtual file system whose root is vfsr.