net.java.truevfs.kernel.spec

Class FsDecoratingManager

java.lang.Object

net.java.truecommons.shed.UniqueObject

net.java.truevfs.kernel.spec.FsAbstractManager

net.java.truevfs.kernel.spec.FsDecoratingManager

All Implemented Interfaces:

FsController.Factory<FsArchiveDriver<? extends FsArchiveEntry>>, FsManager, FsModel.Factory<FsDriver>

Direct Known Subclasses:

InstrumentingManager

@ThreadSafe
public abstract class FsDecoratingManager
extends FsAbstractManager

An abstract decorator for a file system manager.

Author:

Christian Schlichtherle

Field Summary

Fields

Modifier and Type	Field and Description
protected FsManager	manager The decorated file system manager.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FsDecoratingManager(FsManager manager)

Method Summary

Modifier and Type	Method and Description
<X extends Exception,V extends net.java.truecommons.shed.Visitor<? super FsController,X>> V	accept(net.java.truecommons.shed.Filter<? super FsController> filter, V visitor) Filters all managed file system controllers using the given filter and accepts the given visitor to them.
FsController	controller(FsCompositeDriver driver, FsMountPoint mountPoint) Returns the thread-safe file system controller for the given mount point.
FsController	newController(FsArchiveDriver<? extends FsArchiveEntry> context, FsModel model, FsController parent) Returns a new file system controller for the mount point of the given file system model.
FsModel	newModel(FsDriver context, FsMountPoint mountPoint, FsModel parent) Returns a new file system model for the given mount point.
String	toString() Returns a string representation of this object for debugging and logging purposes.

Methods inherited from class net.java.truecommons.shed.UniqueObject

equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

manager

protected final FsManager manager

The decorated file system manager.

Constructor Detail

FsDecoratingManager

protected FsDecoratingManager(FsManager manager)

Method Detail

accept

public <X extends Exception,V extends net.java.truecommons.shed.Visitor<? super FsController,X>> V accept(net.java.truecommons.shed.Filter<? super FsController> filter,
                                                                                                          V visitor)
                                                                                                   throws X extends Exception

Description copied from interface: FsManager

Filters all managed file system controllers using the given filter and accepts the given visitor to them.

Parameters:

filter - the filter for the managed file system controllers. Calls to its Filter.accept(Object) method should terminate quickly without an exception and must not have any side effects on the given controllers!

visitor - the visitor of the filtered file system controllers. Calls to its Visitor.visit(Object) method may have side effects on the given controllers, e.g. by calling FsController.sync(BitField).

Returns:

visitor

Throws:

X - at the discretion of the given visitor. Throwing this exception aborts the visiting.

X extends Exception

controller

public FsController controller(FsCompositeDriver driver,
                               FsMountPoint mountPoint)

Description copied from interface: FsManager

Returns the thread-safe file system controller for the given mount point. The life cycle of the returned file system controller gets managed by this manager, i.e. it gets remembered for future lookup and synchronization.

Parameters:

driver - the composite file system driver which shall get used to create a new file system controller if required.

mountPoint - the mount point of the file system.

Returns:

The thread-safe file system controller for the given mount point.

newController

public FsController newController(FsArchiveDriver<? extends FsArchiveEntry> context,
                                  FsModel model,
                                  @Nullable
                                  FsController parent)

Description copied from interface: FsController.Factory

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())
 

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.

newModel

public FsModel newModel(FsDriver context,
                        FsMountPoint mountPoint,
                        FsModel parent)

Description copied from interface: FsModel.Factory

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());
 

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.

toString

public String toString()

Returns a string representation of this object for debugging and logging purposes.

Overrides:

toString in class Object