de.schlichtherle.truezip.fs

Class FsDriver

java.lang.Object

de.schlichtherle.truezip.fs.FsDriver

Direct Known Subclasses:

FileDriver, FileDriver, FsArchiveDriver, HttpDriver

@Immutable
public abstract class FsDriver
extends Object

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

Subclasses must be thread-safe and should be immutable!

Author:

Christian Schlichtherle

See Also:

FsCompositeDriver

Constructor Summary

Constructors

Constructor and Description
FsDriver()

Method Summary

Modifier and Type	Method and Description
int	getPriority() Returns a priority to help the file system driver service locator.
boolean	isFederated() Returns true iff this file system driver implements a federated file system type, i.e.
FsController<? extends FsModel>	newController(FsManager manager, FsModel model, FsController<? extends FsModel> parent) Returns a new thread-safe file system controller for the mount point of the given file system model and nullable parent file system controller.
abstract FsController<?>	newController(FsModel model, FsController<?> parent) Returns a new thread-safe file system controller for the mount point of the given file system model and nullable parent file system controller.
String	toString() Returns a string representation of this object for debugging and logging purposes.

Methods inherited from class java.lang.Object

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

Constructor Detail

FsDriver

public FsDriver()

Method Detail

getPriority

public int getPriority()

Returns a priority to help the file system driver service locator. The greater number wins!

Returns:

0, as by the implementation in the class FsDriver.

isFederated

public boolean isFederated()

Returns true iff this file system driver implements a federated file system type, i.e. if the type of file system must be a member of a parent file system.

The implementation in the class FsDriver returns false.

Returns:

true iff the type of the file system implemented by this file system driver is federated, i.e. must be a member of a parent file system.

newController

public FsController<? extends FsModel> newController(FsManager manager,
                                                     FsModel model,
                                                     @CheckForNull
                                                     FsController<? extends FsModel> parent)

Returns a new thread-safe file system controller for the mount point of the given file system model and nullable parent file system controller.

When called, you may assert the following precondition:

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

The implementation in the class FsDriver simply forwards the call to newController(FsModel, FsController).

Parameters:

manager - the file system manager for the new controller.

model - the file system model.

parent - the nullable parent file system controller.

Returns:

A new thread-safe file system controller for the given mount point and nullable parent file system controller.

Since:

TrueZIP 7.6

See Also:

FsCompositeDriver.newController(de.schlichtherle.truezip.fs.FsManager, de.schlichtherle.truezip.fs.FsModel, de.schlichtherle.truezip.fs.FsController<? extends de.schlichtherle.truezip.fs.FsModel>)

newController

public abstract FsController<?> newController(FsModel model,
                                              @CheckForNull
                                              FsController<?> parent)

Returns a new thread-safe file system controller for the mount point of the given file system model and nullable parent file system controller.

When called, you may assert the following precondition:

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

Parameters:

model - the file system model.

parent - the nullable parent file system controller.

Returns:

A new thread-safe file system controller for the given mount point and nullable parent file system controller.

See Also:

FsCompositeDriver.newController(de.schlichtherle.truezip.fs.FsManager, de.schlichtherle.truezip.fs.FsModel, de.schlichtherle.truezip.fs.FsController<? extends de.schlichtherle.truezip.fs.FsModel>)

toString

public String toString()

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

Overrides:

toString in class Object