FsDecoratingController (TrueZIP Kernel 7.2-rc-2 API)

java.lang.Object
- de.schlichtherle.truezip.fs.FsController<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:

FsCachingController, FsConcurrentController, FsFederatingController
```
@ThreadSafe
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
public abstract class FsDecoratingController<M extends FsModel,C extends FsController<? extends M>>
extends FsController<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.

private M model

Fields
Modifier and Type	Field and Description
`protected C`	`delegate` The decorated file system controller.
`private M`	`model`

Constructor Summary

Constructors
Modifier Constructor and Description

protected FsDecoratingController(C controller)
Constructs a new decorating file system controller.

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

Method Summary

Methods
Modifier and Type	Method and Description
`javax.swing.Icon`	`getClosedIcon()`
`FsEntry`	`getEntry(FsEntryName name)` Returns a file system entry or `null` if no file system entry exists for the given name.
`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.
`M`	`getModel()` Returns the file system model.
`javax.swing.Icon`	`getOpenIcon()`
`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. not a member of another file system.
`boolean`	`isReadable(FsEntryName name)`
`boolean`	`isReadOnly()` Returns `true` if and only if the file system is read-only.
`boolean`	`isWritable(FsEntryName name)`
`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)`
`boolean`	`setTime(FsEntryName name, BitField<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 entry with the given name.
`boolean`	`setTime(FsEntryName name, java.util.Map<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 entry with the given name.
`<X extends java.io.IOException> void`	`sync(BitField<FsSyncOption> options, ExceptionHandler<? super FsSyncException,X> handler)` 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.
`java.lang.String`	`toString()` Returns a string representation of this object for debugging and logging purposes.
`void`	`unlink(FsEntryName name)`

Methods inherited from class de.schlichtherle.truezip.fs.FsController
equals, hashCode, isExecutable, sync

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.
  - model
```
private volatile M extends FsModel model
```
- Constructor Detail
  - FsDecoratingController
```
protected FsDecoratingController(C controller)
```
    Constructs a new decorating file system controller.
    
    Parameters:
    controller - the decorated file system controller.
- Method Detail
  - getModel
```
public final M getModel()
```
    Description copied from class: FsController
    
    Returns the file system model. Multiple invocations must return the same object.
    
    Specified by:
    
    getModel in class FsController<M extends FsModel>
    
    Returns:
    The file system model.
  - 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.
  - getOpenIcon
```
public javax.swing.Icon getOpenIcon()
                             throws java.io.IOException
```
    Specified by:
    
    getOpenIcon in class FsController<M extends FsModel>
    
    Throws:
    
    java.io.IOException
  - getClosedIcon
```
public javax.swing.Icon getClosedIcon()
                               throws java.io.IOException
```
    Specified by:
    
    getClosedIcon in class FsController<M extends FsModel>
    
    Throws:
    
    java.io.IOException
  - isReadOnly
```
public boolean isReadOnly()
                   throws java.io.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:
    
    java.io.IOException - on any I/O error.
  - getEntry
```
public FsEntry getEntry(FsEntryName name)
                 throws java.io.IOException
```
    Description copied from class: FsController
    
    Returns a file system entry or null if no file system entry exists for the given name. Modifying the returned object is either not supported (i.e. throws an UnsupportedOperationException) or does not show any effect on the file system.
    
    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:
    
    java.io.IOException - on any I/O error.
  - isReadable
```
public boolean isReadable(FsEntryName name)
                   throws java.io.IOException
```
    Specified by:
    
    isReadable in class FsController<M extends FsModel>
    
    Throws:
    
    java.io.IOException
  - isWritable
```
public boolean isWritable(FsEntryName name)
                   throws java.io.IOException
```
    Specified by:
    
    isWritable in class FsController<M extends FsModel>
    
    Throws:
    
    java.io.IOException
  - setReadOnly
```
public void setReadOnly(FsEntryName name)
                 throws java.io.IOException
```
    Specified by:
    
    setReadOnly in class FsController<M extends FsModel>
    
    Throws:
    
    java.io.IOException
  - setTime
```
public boolean setTime(FsEntryName name,
              BitField<Entry.Access> types,
              long value)
                throws java.io.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. Whether or not this is an atomic operation is specific to the implementation.
    
    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.
    
    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.
  - setTime
```
public boolean setTime(FsEntryName name,
              java.util.Map<Entry.Access,java.lang.Long> times)
                throws java.io.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.
    
    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.
  - 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.
  - mknod
```
public void mknod(FsEntryName name,
         Entry.Type type,
         BitField<FsOutputOption> options,
         Entry template)
           throws java.io.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:
    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 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.
  - unlink
```
public void unlink(FsEntryName name)
            throws java.io.IOException
```
    Specified by:
    
    unlink in class FsController<M extends FsModel>
    
    Throws:
    
    java.io.IOException
  - sync
```
public <X extends java.io.IOException> void sync(BitField<FsSyncOption> options,
                                        ExceptionHandler<? super FsSyncException,X> handler)
          throws X extends java.io.IOException
```
    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>
    
    Type Parameters:
    X - The type of the IOException to throw at the discretion of the exception handler.
    Parameters:
    options - a bit field of synchronization options.
    handler - the exception handling strategy for consuming input FsSyncExceptions and/or assembling output IOExceptions.
    
    Throws:
    
    X extends java.io.IOException
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object for debugging and logging purposes.
    
    Overrides:
    
    toString in class FsController<M extends FsModel>

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

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

delegate

model

Constructor Detail

FsDecoratingController

Method Detail

getModel

getParent

getOpenIcon

getClosedIcon

isReadOnly

getEntry

isReadable

isWritable

setReadOnly

setTime

setTime

getInputSocket

getOutputSocket

mknod

unlink

sync

toString