org.millscript.commons.vfs.protocols
Interface URISchemeHandler

All Known Implementing Classes:

AbstractURISchemeHandler, FileSchemeHandler, FtpSchemeHandler, HttpSchemeHandler, VFS

public interface URISchemeHandler

This interface specifies a virtual filesystem URI scheme handler, for resolving a specified URI into a new virtual filesystem object.

Method Summary

VFS	getParentVFS() Returns the parent VFS, that which created this URI scheme handler.
VFile	resolveAsFile(java.net.URI uri) Resolves the specified URI to a virtual file in a new virtual filesystem.
VFolder	resolveAsFolder(java.net.URI uri) Resolves the specified URI to a virtual fole in a new virtual filesystem.
VVolume	resolveAsVolume(java.net.URI uri) Resolves the specified URI to a new virtual filesystem volume.

Method Detail

getParentVFS

VFS getParentVFS()

Returns the parent VFS, that which created this URI scheme handler. The parent VFS is maintained through to each volume, so that we can use it for configuration.

Returns:

resolveAsFile

VFile resolveAsFile(java.net.URI uri)

Resolves the specified URI to a virtual file in a new virtual filesystem. The returned virtual file will belong to a virtual volume and possibly some virtual folders as well. The virtual volume will be located at the root of the URI's path.

Parameters:

uri - the URI of the file to get a virtual file for

Returns:

a VFile for the specified file URI

resolveAsFolder

VFolder resolveAsFolder(java.net.URI uri)

Resolves the specified URI to a virtual fole in a new virtual filesystem. The returned virtual fiolder will belong to a virtual volume and possibly some virtual folders as well. The virtual volume will be located at the root of the URI's path.

Parameters:

uri - the URI of the folder to get a virtual folder for

Returns:

a VFile for the specified folder URI

resolveAsVolume

VVolume resolveAsVolume(java.net.URI uri)

Resolves the specified URI to a new virtual filesystem volume. The root of the virtual volume will be the specified URI's path.

Parameters:

uri - the URI of the file to get a virtual file for

Returns:

a VFile for the specified file URI