net.java.truevfs.kernel.spec

Interface FsModel

All Known Implementing Classes:

FsAbstractModel, FsDecoratingModel, InstrumentingModel, JmxModel

@ImplementationsShouldExtend(value=FsAbstractModel.class)
public interface FsModel

Defines common properties of any file system.

Implementations should be safe for multi-threaded access.

Author:

Christian Schlichtherle

See Also:

FsController, FsManager

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FsModel.Factory<Context> A factory for file system models.

Method Summary

Modifier and Type	Method and Description
FsMountPoint	getMountPoint() Returns the mount point of the file system.
FsModel	getParent() Returns the parent file system model or null if and only if the file system is not federated, i.e.
boolean	isMounted() Returns true if and only if some state associated with the federated file system has been modified so that the corresponding FsController must not get discarded until the next call to sync.
void	setMounted(boolean mounted) Sets the value of the property mounted.

Method Detail

getMountPoint

FsMountPoint getMountPoint()

Returns the mount point of the file system. The mount point may be used to construct error messages or to locate and access file system meta data which is stored outside the file system, e.g. passwords for RAES encrypted ZIP files.

Returns:

The mount point of the file system.

getParent

@CheckForNull
FsModel getParent()

Returns the parent file system model or null if and only if the file system is not federated, i.e. if it's not a member of a parent file system.

Returns:

The nullable parent file system model.

isMounted

boolean isMounted()

Returns true if and only if some state associated with the federated file system has been modified so that the corresponding FsController must not get discarded until the next call to sync.

An implementation may always return false if the associated file system controller is stateless.

Returns:

true if and only if some state associated with the federated file system has been modified so that the corresponding FsController must not get discarded until the next sync.

setMounted

void setMounted(boolean mounted)

Sets the value of the property mounted. Only file system controllers should call this method in order to register themselves for a call their FsController.sync(net.java.truecommons.shed.BitField<net.java.truevfs.kernel.spec.FsSyncOption>) method.

An implementation may ignore calls to this method if the associated file system controller is stateless.

Parameters:

mounted - the new value of this property.