net.java.truevfs.kernel.spec

Interface FsCompositeDriver

All Superinterfaces:

FsController.Factory<FsManager>, FsModel.Factory<FsManager>

All Known Implementing Classes:

FsAbstractCompositeDriver, FsSimpleCompositeDriver, InstrumentingCompositeDriver, TArchiveDetector

@ImplementationsShouldExtend(value=FsAbstractCompositeDriver.class)
public interface FsCompositeDriver
extends FsModel.Factory<FsManager>, FsController.Factory<FsManager>

Queries the scheme of the mount point of the given file system model in order to lookup the appropriate file system driver which is then used to create the requested thread-safe file system controller.

Implementations should be immutable.

Author:

Christian Schlichtherle

See Also:

FsDriver

Method Summary

Modifier and Type	Method and Description
FsController	newController(FsManager context, FsModel model, FsController parent) Returns a new file system controller for the mount point of the given file system model.
FsModel	newModel(FsManager context, FsMountPoint mountPoint, FsModel parent) Returns a new file system model for the given mount point.

Method Detail

newController

FsController newController(FsManager context,
                           FsModel model,
                           @CheckForNull
                           FsController parent)
                    throws ServiceConfigurationError

Returns a new file system controller for the mount point of the given file system model. This is a pure function without side effects.

When called, you may assert the following precondition:

 assert null == parent
         ? null == model.getParent()
         : parent.getModel().equals(model.getParent())
 

The file system controller gets created by using a file system driver which gets looked up by querying the scheme of the mount point of the given file system model with the expression model.getMountPoint().getScheme().

Specified by:

newController in interface FsController.Factory<FsManager>

Parameters:

context - the calling context.

model - the file system model.

parent - the nullable parent file system controller.

Returns:

A new file system controller for the mount point of the given file system model.

Throws:

ServiceConfigurationError - if no appropriate file system driver is known for the scheme of the mount point of the given model.

newModel

FsModel newModel(FsManager context,
                 FsMountPoint mountPoint,
                 @CheckForNull
                 FsModel parent)

Returns a new file system model for the given mount point. This is a pure function without side effects.

When called, you may assert the following precondition:

 assert null == parent
         ? null == mountPoint.getParent()
         : parent.getMountPoint().equals(mountPoint.getParent());
 

The file system model gets created by using a file system driver which gets looked up by querying the scheme of the given mount point with the expression mountPoint.getScheme().

Specified by:

newModel in interface FsModel.Factory<FsManager>

Parameters:

context - the calling context.

mountPoint - the mount point of the file system.

parent - the nullable parent file system model.

Returns:

A new file system model for the given mount point.

Throws:

ServiceConfigurationError - if no appropriate file system driver is known for the scheme of the given mount point.