net.java.truevfs.kernel.spec

Class FsDriver

java.lang.Object

net.java.truecommons.shed.UniqueObject

net.java.truevfs.kernel.spec.FsDriver

All Implemented Interfaces:

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

Direct Known Subclasses:

FsArchiveDriver

@Immutable
public abstract class FsDriver
extends net.java.truecommons.shed.UniqueObject
implements FsModel.Factory<FsManager>, FsController.Factory<FsManager>

An abstract factory for components required to access a file system.

Subclasses should be immutable.

See Also:

FsCompositeDriver

Constructor Summary

Constructors

Constructor and Description
FsDriver()

Method Summary

Modifier and Type	Method and Description
FsModel	decorate(FsModel model) Decorates the given file system model.
boolean	isArchiveDriver() Returns true if and only if this is an archive driver, that is, if file systems of this type must be a member of a parent file system.
FsModel	newModel(FsManager context, FsMountPoint mountPoint, FsModel parent) Returns a new file system model for the given mount point.
java.lang.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

Methods inherited from interface net.java.truevfs.kernel.spec.FsController.Factory

newController

Constructor Detail

FsDriver

public FsDriver()

Method Detail

isArchiveDriver

public boolean isArchiveDriver()

Returns true if and only if this is an archive driver, that is, if file systems of this type must be a member of a parent file system.

Returns:

The implementation in the class FsDriver unconditionally returns false.

newModel

public final FsModel newModel(FsManager context,
                              FsMountPoint mountPoint,
                              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 implementation in the class FsDriver forwards the call to the given file system manager.

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.

decorate

public FsModel decorate(FsModel model)

Decorates the given file system model.

Parameters:

model - the file system model to decorate.

Returns:

The implementation in the class FsDriver unconditionally returns model.

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object