net.java.truevfs.kernel.spec

Class FsDecoratingController

java.lang.Object

net.java.truecommons.shed.UniqueObject

net.java.truevfs.kernel.spec.FsAbstractController

net.java.truevfs.kernel.spec.FsDecoratingController

All Implemented Interfaces:

FsController

Direct Known Subclasses:

AbstractKeyController, FsAccessOptionsController, InstrumentingController

@ThreadSafe
public abstract class FsDecoratingController
extends FsAbstractController

An abstract decorator for a file system controller.

Author:

Christian Schlichtherle

Nested Class Summary

Nested classes/interfaces inherited from interface net.java.truevfs.kernel.spec.FsController

FsController.Factory<Context>

Field Summary

Fields

Modifier and Type	Field and Description
protected FsController	controller The decorated file system controller.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FsDecoratingController(FsController controller)

Method Summary

Modifier and Type	Method and Description
void	checkAccess(net.java.truecommons.shed.BitField<FsAccessOption> options, FsNodeName name, net.java.truecommons.shed.BitField<net.java.truecommons.cio.Entry.Access> types) Checks if the file system node for the given name exists when constrained by the given access options and permits the given access types.
FsController	getParent() Returns the controller for the parent file system or null if and only if this file system is not federated, i.e.
net.java.truecommons.cio.InputSocket<? extends net.java.truecommons.cio.Entry>	input(net.java.truecommons.shed.BitField<FsAccessOption> options, FsNodeName name) Returns an input socket for reading the contents of the file system node addressed by the given name from the file system.
void	make(net.java.truecommons.shed.BitField<FsAccessOption> options, FsNodeName name, net.java.truecommons.cio.Entry.Type type, net.java.truecommons.cio.Entry template) Creates or replaces and finally links a chain of one or more entries for the given node name into the file system.
FsNode	node(net.java.truecommons.shed.BitField<FsAccessOption> options, FsNodeName name) Returns the file system node for the given name or null if it doesn't exist.
net.java.truecommons.cio.OutputSocket<? extends net.java.truecommons.cio.Entry>	output(net.java.truecommons.shed.BitField<FsAccessOption> options, FsNodeName name, net.java.truecommons.cio.Entry template) Returns an output socket for writing the contents of the node addressed by the given name to the file system.
void	setReadOnly(net.java.truecommons.shed.BitField<FsAccessOption> options, FsNodeName name) Sets the named file system node as read-only.
boolean	setTime(net.java.truecommons.shed.BitField<FsAccessOption> options, FsNodeName name, net.java.truecommons.shed.BitField<net.java.truecommons.cio.Entry.Access> types, long value) Makes an attempt to set the last access time of all types in the given bit field for the file system node with the given name.
boolean	setTime(net.java.truecommons.shed.BitField<FsAccessOption> options, FsNodeName name, Map<net.java.truecommons.cio.Entry.Access,Long> times) Makes an attempt to set the last access time of all types in the given map for the file system node with the given name.
void	sync(net.java.truecommons.shed.BitField<FsSyncOption> options) Commits all unsynchronized changes to the contents of this file system to its parent file system, releases the associated resources (e.g.
String	toString() Returns a string representation of this object for debugging and logging purposes.
void	unlink(net.java.truecommons.shed.BitField<FsAccessOption> options, FsNodeName name) Removes the named file system node from the file system.

Methods inherited from class net.java.truevfs.kernel.spec.FsAbstractController

getModel, getMountPoint, isMounted, setMounted

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

controller

protected final FsController controller

The decorated file system controller.

Constructor Detail

FsDecoratingController

protected FsDecoratingController(FsController controller)

Method Detail

checkAccess

public void checkAccess(net.java.truecommons.shed.BitField<FsAccessOption> options,
                        FsNodeName name,
                        net.java.truecommons.shed.BitField<net.java.truecommons.cio.Entry.Access> types)
                 throws IOException

Description copied from interface: FsController

Checks if the file system node for the given name exists when constrained by the given access options and permits the given access types.

Parameters:

options - the options for accessing the file system node.

name - the name of the file system node.

types - the types of the desired access.

Throws:

IOException - on any I/O error.

getParent

public FsController getParent()

Description copied from interface: FsController

Returns the controller for the parent file system or null if and only if this file system is not federated, i.e. not a member of another file system. Multiple invocations must return the same object.

Returns:

The nullable controller for the parent file system.

input

public net.java.truecommons.cio.InputSocket<? extends net.java.truecommons.cio.Entry> input(net.java.truecommons.shed.BitField<FsAccessOption> options,
                                                                                            FsNodeName name)

Description copied from interface: FsController

Returns an input socket for reading the contents of the file system node addressed by the given name from the file system. Note that the assertions for this file system operation equally apply to any channel or stream created by the returned input socket!

Parameters:

options - the options for accessing the file system node.

name - the name of the file system node.

Returns:

An InputSocket.

make

public void make(net.java.truecommons.shed.BitField<FsAccessOption> options,
                 FsNodeName name,
                 net.java.truecommons.cio.Entry.Type type,
                 @CheckForNull
                 net.java.truecommons.cio.Entry template)
          throws IOException

Description copied from interface: FsController

Creates or replaces and finally links a chain of one or more entries for the given node name into the file system.

Parameters:

options - the options for accessing the file system node. If FsAccessOption.CREATE_PARENTS is set, any missing parent directories shall get created with an undefined last modification time.

name - the name of the file system node.

type - the file system node type.

template - if not null, then the file system node at the end of the chain shall inherit as much properties from this node as possible - with the exception of its name and type.

Throws:

IOException - on any I/O error, including but not limited to these reasons:

• The file system is read only.
• name contains characters which are not supported by the file system.
• The node already exists and either the option FsAccessOption.EXCLUSIVE is set or the node is a directory.
• The node exists as a different type.
• A parent node exists but is not a directory.
• A parent node is missing and createParents is false.

node

@CheckForNull
public FsNode node(net.java.truecommons.shed.BitField<FsAccessOption> options,
                                 FsNodeName name)
                          throws IOException

Description copied from interface: FsController

Returns the file system node for the given name or null if it doesn't exist. Modifying the returned node does not show any effect on the file system and should result in an UnsupportedOperationException.

Parameters:

options - the options for accessing the file system node.

name - the name of the file system node.

Returns:

A file system node or null if no file system node exists for the given name.

Throws:

IOException - on any I/O error.

output

public net.java.truecommons.cio.OutputSocket<? extends net.java.truecommons.cio.Entry> output(net.java.truecommons.shed.BitField<FsAccessOption> options,
                                                                                              FsNodeName name,
                                                                                              @CheckForNull
                                                                                              net.java.truecommons.cio.Entry template)

Description copied from interface: FsController

Returns an output socket for writing the contents of the node addressed by the given name to the file system. Note that the assertions for this file system operation equally apply to any channel or stream created by the returned output socket!

Parameters:

options - the options for accessing the file system node. If FsAccessOption.CREATE_PARENTS is set, any missing parent directories shall get created with an undefined last modification time.

name - the name of the file system node.

template - if not null, then the file system node at the end of the chain shall inherit as much properties from this node as possible - with the exception of its name and type.

Returns:

An OutputSocket.

setReadOnly

public void setReadOnly(net.java.truecommons.shed.BitField<FsAccessOption> options,
                        FsNodeName name)
                 throws IOException

Description copied from interface: FsController

Sets the named file system node as read-only. This method will fail for typical archive file system controller implementations because they do not support it.

Parameters:

options - the options for accessing the file system node.

name - the name of the file system node.

Throws:

IOException - on any I/O error or if this operation is not supported.

setTime

public boolean setTime(net.java.truecommons.shed.BitField<FsAccessOption> options,
                       FsNodeName name,
                       net.java.truecommons.shed.BitField<net.java.truecommons.cio.Entry.Access> types,
                       long value)
                throws IOException

Description copied from interface: FsController

Makes an attempt to set the last access time of all types in the given bit field for the file system node with the given name. If false is returned or an IOException is thrown, then still some of the last access times may have been set.

Parameters:

options - the options for accessing the file system node.

name - the name of the file system node.

types - the access types.

value - the last access time.

Returns:

true if and only if setting the access time for all types in types succeeded.

Throws:

IOException - on any I/O error.

setTime

public boolean setTime(net.java.truecommons.shed.BitField<FsAccessOption> options,
                       FsNodeName name,
                       Map<net.java.truecommons.cio.Entry.Access,Long> times)
                throws IOException

Description copied from interface: FsController

Makes an attempt to set the last access time of all types in the given map for the file system node with the given name. If false is returned or an IOException is thrown, then still some of the last access times may have been set. Whether or not this is an atomic operation is specific to the implementation.

Specified by:

setTime in interface FsController

Overrides:

setTime in class FsAbstractController

Parameters:

options - the options for accessing the file system node.

name - the name of the file system node.

times - the access times.

Returns:

true if and only if setting the access time for all types in times succeeded.

Throws:

IOException - on any I/O error.

sync

public void sync(net.java.truecommons.shed.BitField<FsSyncOption> options)
          throws FsSyncException

Description copied from interface: FsController

Commits all unsynchronized changes to the contents of this file system to its parent file system, releases the associated resources (e.g. target archive files) for access by third parties (e.g. other processes), cleans up any temporary allocated resources (e.g. temporary files) and purges any cached data. Note that temporary resources may get allocated even if the federated file systems were accessed read-only. If this is not a federated file system, i.e. if its not a member of a parent file system, then nothing happens. Otherwise, the state of this file system controller is reset.

An implementation may ignore calls to this method if its stateless.

Parameters:

options - the options for synchronizing the file system.

Throws:

FsSyncWarningException - if only warning conditions apply. This implies that the respective parent file system has been synchronized with constraints, e.g. if an unclosed archive entry stream gets forcibly closed.

FsSyncException - if any error conditions apply.

toString

public String toString()

Description copied from class: FsAbstractController

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

Overrides:

toString in class FsAbstractController

Returns:

A string representation of this object for debugging and logging purposes.

unlink

public void unlink(net.java.truecommons.shed.BitField<FsAccessOption> options,
                   FsNodeName name)
            throws IOException

Description copied from interface: FsController

Removes the named file system node from the file system. If the named file system node is a directory, it must be empty.

Parameters:

options - the options for accessing the file system node.

name - the name of the file system node.

Throws:

IOException - on any I/O error.