de.schlichtherle.truezip.fs

Class FsDecoratingController<M extends FsModel,C extends FsController<? extends M>>

java.lang.Object

de.schlichtherle.truezip.fs.FsController<M>

de.schlichtherle.truezip.fs.FsAbstractController<M>

de.schlichtherle.truezip.fs.FsDecoratingController<M,C>

Type Parameters:

M - the type of the file system model.

C - the type of the decorated file system controller.

Direct Known Subclasses:

InstrumentingController, KeyController

@ThreadSafe
public abstract class FsDecoratingController<M extends FsModel,C extends FsController<? extends M>>
extends FsAbstractController<M>

An abstract decorator for a file system controller.

Author:

Christian Schlichtherle

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FsDecoratingController(C controller) Constructs a new decorating file system controller.

Method Summary

Modifier and Type	Method and Description
FsEntry	getEntry(FsEntryName name) Returns the file system entry for the given name or null if it doesn't exist.
InputSocket<?>	getInputSocket(FsEntryName name, BitField<FsInputOption> options) Returns an input socket for reading the contents of the file system entry addressed by the given name from the file system.
OutputSocket<?>	getOutputSocket(FsEntryName name, BitField<FsOutputOption> options, Entry template) Returns an output socket for writing the contents of the entry addressed by the given name to the file system.
FsController<?>	getParent() Returns the controller for the parent file system or null if and only if this file system is not federated, i.e.
boolean	isExecutable(FsEntryName name) Returns false if the named file system entry is not executable.
boolean	isReadable(FsEntryName name) Returns false if the named file system entry is not readable.
boolean	isReadOnly() Returns true if and only if the file system is read-only.
boolean	isWritable(FsEntryName name) Returns false if the named file system entry is not writable.
void	mknod(FsEntryName name, Entry.Type type, BitField<FsOutputOption> options, Entry template) Creates or replaces and finally links a chain of one or more entries for the given entry name into the file system.
void	setReadOnly(FsEntryName name) Sets the named file system entry as read-only.
boolean	setTime(FsEntryName name, BitField<Entry.Access> types, long value, BitField<FsOutputOption> options) Makes an attempt to set the last access time of all types in the given bit field for the file system entry with the given name.
boolean	setTime(FsEntryName name, Map<Entry.Access,Long> times, BitField<FsOutputOption> options) Makes an attempt to set the last access time of all types in the given map for the file system entry with the given name.
void	sync(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(FsEntryName name, BitField<FsOutputOption> options) Removes the named file system entry from the file system.

Methods inherited from class de.schlichtherle.truezip.fs.FsAbstractController

getModel, getMountPoint, isMounted, setMounted

Methods inherited from class de.schlichtherle.truezip.fs.FsController

equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

delegate

protected final C extends FsController<? extends M> delegate

The decorated file system controller.

Constructor Detail

FsDecoratingController

protected FsDecoratingController(C controller)

Constructs a new decorating file system controller.

Parameters:

controller - the decorated file system controller.

Method Detail

getEntry

public FsEntry getEntry(FsEntryName name)
                 throws IOException

Description copied from class: FsController

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

Specified by:

getEntry in class FsController<M extends FsModel>

Parameters:

name - the name of the file system entry.

Returns:

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

Throws:

IOException - on any I/O failure.

getInputSocket

public InputSocket<?> getInputSocket(FsEntryName name,
                                     BitField<FsInputOption> options)

Description copied from class: FsController

Returns an input socket for reading the contents of the file system entry addressed by the given name from the file system.

Specified by:

getInputSocket in class FsController<M extends FsModel>

Parameters:

name - the file system entry name.

options - the input options.

Returns:

An InputSocket.

getOutputSocket

public OutputSocket<?> getOutputSocket(FsEntryName name,
                                       BitField<FsOutputOption> options,
                                       Entry template)

Description copied from class: FsController

Returns an output socket for writing the contents of the entry addressed by the given name to the file system. If template is not null, then the output entry shall have as many of its properties copied as reasonable, e.g. the last modification time.

Specified by:

getOutputSocket in class FsController<M extends FsModel>

Parameters:

name - a file system entry name.

options - a bit field of output options.

template - a nullable template for the properties of the output entry.

Returns:

An OutputSocket.

getParent

public FsController<?> getParent()

Description copied from class: 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 class FsController<M extends FsModel>

Returns:

The nullable controller for the parent file system.

isExecutable

public boolean isExecutable(FsEntryName name)
                     throws IOException

Description copied from class: FsController

Returns false if the named file system entry is not executable.

The implementation in the class FsController always returns false.

Overrides:

isExecutable in class FsController<M extends FsModel>

Parameters:

name - the name of the file system entry.

Returns:

false if the named file system entry is not executable.

Throws:

IOException - on any I/O failure.

isReadable

public boolean isReadable(FsEntryName name)
                   throws IOException

Description copied from class: FsController

Returns false if the named file system entry is not readable.

Specified by:

isReadable in class FsController<M extends FsModel>

Parameters:

name - the name of the file system entry.

Returns:

false if the named file system entry is not readable.

Throws:

IOException - on any I/O failure.

isReadOnly

public boolean isReadOnly()
                   throws IOException

Description copied from class: FsController

Returns true if and only if the file system is read-only.

Specified by:

isReadOnly in class FsController<M extends FsModel>

Returns:

true if and only if the file system is read-only.

Throws:

IOException - on any I/O failure.

isWritable

public boolean isWritable(FsEntryName name)
                   throws IOException

Description copied from class: FsController

Returns false if the named file system entry is not writable.

Specified by:

isWritable in class FsController<M extends FsModel>

Parameters:

name - the name of the file system entry.

Returns:

false if the named file system entry is not writable.

Throws:

IOException - on any I/O failure.

mknod

public void mknod(FsEntryName name,
                  Entry.Type type,
                  BitField<FsOutputOption> options,
                  Entry template)
           throws IOException

Description copied from class: FsController

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

Specified by:

mknod in class FsController<M extends FsModel>

Parameters:

name - the file system entry name.

type - the file system entry type.

options - the file system output options. If FsOutputOption.CREATE_PARENTS is set, any missing parent directories will be created and linked into the file system with its last modification time set to the system's current time.

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

Throws:

IOException - on any I/O failure, 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 entry already exists and either the option FsOutputOption.EXCLUSIVE is set or the entry is a directory.
• The entry exists as a different type.
• A parent entry exists but is not a directory.
• A parent entry is missing and createParents is false.

setReadOnly

public void setReadOnly(FsEntryName name)
                 throws IOException

Description copied from class: FsController

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

Specified by:

setReadOnly in class FsController<M extends FsModel>

Parameters:

name - the name of the file system entry.

Throws:

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

setTime

public boolean setTime(FsEntryName name,
                       BitField<Entry.Access> types,
                       long value,
                       BitField<FsOutputOption> options)
                throws IOException

Description copied from class: FsController

Makes an attempt to set the last access time of all types in the given bit field for the file system entry 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 class FsController<M extends FsModel>

Parameters:

name - the file system entry name.

types - the access types.

value - the last access time.

options - the file system output options.

Returns:

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

Throws:

IOException - on any I/O failure.

setTime

public boolean setTime(FsEntryName name,
                       Map<Entry.Access,Long> times,
                       BitField<FsOutputOption> options)
                throws IOException

Description copied from class: FsController

Makes an attempt to set the last access time of all types in the given map for the file system entry 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.

Overrides:

setTime in class FsController<M extends FsModel>

Parameters:

name - the file system entry name.

times - the access times.

options - the file system output options.

Returns:

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

Throws:

IOException - on any I/O failure.

sync

public void sync(BitField<FsSyncOption> options)
          throws FsSyncException

Description copied from class: 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.

Specified by:

sync in class FsController<M extends FsModel>

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: FsController

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

Overrides:

toString in class FsController<M extends FsModel>

unlink

public void unlink(FsEntryName name,
                   BitField<FsOutputOption> options)
            throws IOException

Description copied from class: FsController

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

Specified by:

unlink in class FsController<M extends FsModel>

Parameters:

name - the file system entry name.

options - output options for this operation.

Throws:

IOException - on any I/O failure.