Package org.millscript.commons.vfs

This package provides the interface to the virtual filing system.

See:
Description

Interface Summary

VEntry	This interface describes an entry in a virtual filesystem volume.
VFile	This interface describes a file in the virtual filesystem.
VFolder	This interface describes a folder in the virutal filesystem.
VVolume	This interface describes the root of a virtual filesystem.

Class Summary

AbstractVEntry<V extends VVolume>	This class provides the skeletal implementation of a virtual filesystem entry,
AbstractVFile<V extends VVolume>	This class provides the skeletal implementation of a virtual filesystem file,
AbstractVFolder<V extends VVolume>	This class provides the skeletal implementation of a virtual filesystem folder,
AbstractVVolume	The class provides a skeletal virtual filesystem volume.
VFS	This class provides the entry point for obtaining a new virtual filesytem.

Package org.millscript.commons.vfs Description

This package provides the interface to the virtual filing system. You should enter the system through an instance of the VFS class.

Overview

A virtual filesystem is made of three components: volumes, folders and files. A volume hides away details about the real location of the folders and files. A folder is essentially a collection of virtual filesystem entries, where an entry is either a folder or a file. A file is a representation of a real file and provides methods for accessing its content.

Use

The general idea behind the virtual filesystem is that you use the VFS class to resolve a URI to either a volume, folder or file. From the volume you can obtain its root folder, or inpect the root folder through the volume. From a folder you can fetch specific child folders or files. Finally from the file you can access the real files contents.