net.java.truevfs.kernel.spec

Class FsAbstractCompositeDriver

java.lang.Object

net.java.truevfs.kernel.spec.FsAbstractCompositeDriver

All Implemented Interfaces:

javax.inject.Provider<Map<FsScheme,FsDriver>>, net.java.truecommons.services.Container<Map<FsScheme,FsDriver>>, FsCompositeDriver, FsController.Factory<FsManager>, FsModel.Factory<FsManager>

Direct Known Subclasses:

FsSimpleCompositeDriver, TArchiveDetector

@Immutable
public abstract class FsAbstractCompositeDriver
extends Object
implements FsCompositeDriver, net.java.truecommons.services.Container<Map<FsScheme,FsDriver>>

An abstract composite driver. This class provides an implementation of newController(net.java.truevfs.kernel.spec.FsManager, net.java.truevfs.kernel.spec.FsModel, net.java.truevfs.kernel.spec.FsController) which uses the file system driver map returned by Container.get() to lookup the appropriate driver for the scheme of any given mount point.

Subclasses should be immutable, too.

Author:

Christian Schlichtherle

Constructor Summary

Constructors

Constructor and Description
FsAbstractCompositeDriver()

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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.java.truecommons.services.Container

get

Constructor Detail

FsAbstractCompositeDriver

public FsAbstractCompositeDriver()

Method Detail

newController

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

Description copied from interface: FsCompositeDriver

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 FsCompositeDriver

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

public final FsModel newModel(FsManager context,
                              FsMountPoint mountPoint,
                              FsModel parent)

Description copied from interface: FsCompositeDriver

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 FsCompositeDriver

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.