net.java.truevfs.kernel.spec

Interface FsDelegatingController

All Superinterfaces:

FsController

All Known Implementing Classes:

FsAccessOptionsController, FsDecoratingController

@ThreadSafe
public interface FsDelegatingController
extends FsController

A file system controller which delegates its calls to another file system controller.

Nested Class Summary

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

FsController.Factory<Context>

Method Summary

Modifier and Type	Method and Description
default 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	getController() The underlying file system controller.
default FsModel	getModel() Returns the file system model.
default FsController	getParent() Returns the controller for the parent file system or null if and only if this file system is not federated, i.e.
default 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.
default 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.
default 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.
default 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.
default void	setReadOnly(net.java.truecommons.shed.BitField<FsAccessOption> options, FsNodeName name) Sets the named file system node as read-only.
default 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.
default boolean	setTime(net.java.truecommons.shed.BitField<FsAccessOption> options, FsNodeName name, java.util.Map<net.java.truecommons.cio.Entry.Access,java.lang.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.
default 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.
default void	unlink(net.java.truecommons.shed.BitField<FsAccessOption> options, FsNodeName name) Removes the named file system node from the file system.

Method Detail

getController

FsController getController()

The underlying file system controller.

getParent

default 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.

Specified by:

getParent in interface FsController

Returns:

The nullable controller for the parent file system.

getModel

default FsModel getModel()

Description copied from interface: FsController

Returns the file system model.

Specified by:

getModel in interface FsController

Returns:

The file system model.

node

@CheckForNull
default FsNode node(net.java.truecommons.shed.BitField<FsAccessOption> options,
                                  FsNodeName name)
                           throws java.io.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.

Specified by:

node in interface FsController

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:

java.io.IOException - on any I/O error.

checkAccess

default void checkAccess(net.java.truecommons.shed.BitField<FsAccessOption> options,
                         FsNodeName name,
                         net.java.truecommons.shed.BitField<net.java.truecommons.cio.Entry.Access> types)
                  throws java.io.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.

Specified by:

checkAccess in interface FsController

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:

java.io.IOException - on any I/O error.

setReadOnly

default void setReadOnly(net.java.truecommons.shed.BitField<FsAccessOption> options,
                         FsNodeName name)
                  throws java.io.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.

Specified by:

setReadOnly in interface FsController

Parameters:

options - the options for accessing the file system node.

name - the name of the file system node.

Throws:

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

setTime

default boolean setTime(net.java.truecommons.shed.BitField<FsAccessOption> options,
                        FsNodeName name,
                        java.util.Map<net.java.truecommons.cio.Entry.Access,java.lang.Long> times)
                 throws java.io.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

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:

java.io.IOException - on any I/O error.

setTime

default 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 java.io.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.

Specified by:

setTime in interface FsController

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:

java.io.IOException - on any I/O error.

input

default 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!

Specified by:

input in interface FsController

Parameters:

options - the options for accessing the file system node.

name - the name of the file system node.

Returns:

An InputSocket.

output

default 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!

Specified by:

output in interface FsController

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.

make

default 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 java.io.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.

Specified by:

make in interface FsController

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:

java.io.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.

unlink

default void unlink(net.java.truecommons.shed.BitField<FsAccessOption> options,
                    FsNodeName name)
             throws java.io.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.

Specified by:

unlink in interface FsController

Parameters:

options - the options for accessing the file system node.

name - the name of the file system node.

Throws:

java.io.IOException - on any I/O error.

sync

default 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.

Specified by:

sync in interface FsController

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.