FsFederatingController (TrueZIP Kernel 7.1.3 API)

java.lang.Object
- de.schlichtherle.truezip.fs.FsController<M>
- - de.schlichtherle.truezip.fs.FsDecoratingController<FsModel,FsController<?>>
  - - de.schlichtherle.truezip.fs.FsFederatingController

```
@ThreadSafe
final class FsFederatingController
extends FsDecoratingController<FsModel,FsController<?>>
```
Implements a chain of responsibility in order to resolve FsFalsePositiveExceptions thrown by the prospective file system provided to its constructor. Whenever the controller for the prospective file system throws a FsFalsePositiveException, the method call is delegated to the controller for its parent file system in order to resolve the requested operation.

Author:

Christian Schlichtherle

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private class FsFederatingController.Input

private class FsFederatingController.Output

Nested Classes
Modifier and Type	Class and Description
`private class`	`FsFederatingController.Input`
`private class`	`FsFederatingController.Output`

Field Summary

Fields
Modifier and Type Field and Description

private FsPath path
- Fields inherited from class de.schlichtherle.truezip.fs.FsDecoratingController
  delegate

Fields
Modifier and Type	Field and Description
`private FsPath`	`path`

Constructor Summary

Constructors
Constructor and Description

FsFederatingController(FsController<?> controller)
Constructs a new file system federating controller.

Constructors
Constructor and Description
`FsFederatingController(FsController<?> controller)` Constructs a new file system federating controller.

Method Summary

Methods
Modifier and Type	Method and Description
`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.
`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.
`private FsPath`	`getPath()`
`boolean`	`isReadable(FsEntryName name)`
`boolean`	`isReadOnly()`
`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.
`private FsEntryName`	`resolveParent(FsEntryName name)`
`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.
`void`	`unlink(FsEntryName name)`

Methods inherited from class de.schlichtherle.truezip.fs.FsDecoratingController
getModel, getParent, sync, toString

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

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - path
```
private volatile FsPath path
```
- Constructor Detail
  - FsFederatingController
```
FsFederatingController(@NonNull
                      FsController<?> controller)
```
    Constructs a new file system federating controller.
    
    Parameters:
    controller - the decorated file system controller.
- Method Detail
  - resolveParent
```
private FsEntryName resolveParent(FsEntryName name)
```
  - getPath
```
private FsPath getPath()
```
  - getOpenIcon
```
public Icon getOpenIcon()
                 throws IOException
```
    Overrides:
    
    getOpenIcon in class FsDecoratingController<FsModel,FsController<?>>
    
    Throws:
    
    IOException
  - getClosedIcon
```
public Icon getClosedIcon()
                   throws IOException
```
    Overrides:
    
    getClosedIcon in class FsDecoratingController<FsModel,FsController<?>>
    
    Throws:
    
    IOException
  - isReadOnly
```
public boolean isReadOnly()
                   throws IOException
```
    Overrides:
    
    isReadOnly in class FsDecoratingController<FsModel,FsController<?>>
    
    Throws:
    
    IOException
  - getEntry
```
public FsEntry getEntry(FsEntryName name)
                 throws 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 graph is either not supported (i.e. throws an UnsupportedOperationException) or does not show any effect on the file system.
    
    Overrides:
    
    getEntry in class FsDecoratingController<FsModel,FsController<?>>
    
    Parameters:
    name - the name of the file system entry to look up.
    
    Returns:
    A file system entry or null if no file system entry exists for the given name.
    
    Throws:
    
    IOException - on any I/O error.
  - isReadable
```
public boolean isReadable(FsEntryName name)
                   throws IOException
```
    Overrides:
    
    isReadable in class FsDecoratingController<FsModel,FsController<?>>
    
    Throws:
    
    IOException
  - isWritable
```
public boolean isWritable(FsEntryName name)
                   throws IOException
```
    Overrides:
    
    isWritable in class FsDecoratingController<FsModel,FsController<?>>
    
    Throws:
    
    IOException
  - setReadOnly
```
public void setReadOnly(FsEntryName name)
                 throws IOException
```
    Overrides:
    
    setReadOnly in class FsDecoratingController<FsModel,FsController<?>>
    
    Throws:
    
    IOException
  - setTime
```
public boolean setTime(FsEntryName name,
              BitField<Entry.Access> types,
              long value)
                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. In other words, this is not an atomic operation if multiple access types are given. To make this operation atomic, set the last access time for a single type only.
    
    Overrides:
    
    setTime in class FsDecoratingController<FsModel,FsController<?>>
    
    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:
    
    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.
    
    Overrides:
    
    getInputSocket in class FsDecoratingController<FsModel,FsController<?>>
    
    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.
    
    Overrides:
    
    getOutputSocket in class FsDecoratingController<FsModel,FsController<?>>
    
    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(@NonNull
         FsEntryName name,
         @NonNull
         Entry.Type type,
         @NonNull
         BitField<FsOutputOption> options,
         @CheckForNull
         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.
    Overrides:
    
    mknod in class FsDecoratingController<FsModel,FsController<?>>
    
    Parameters:
    name - the file system entry name.
    type - the file system entry type.
    options - the file system output options. If CREATE_PARENTS is set, any missing parent directories will be created and linked into this 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 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 IOException
```
    Overrides:
    
    unlink in class FsDecoratingController<FsModel,FsController<?>>
    
    Throws:
    
    IOException

Class FsFederatingController

Nested Class Summary

Field Summary

Fields inherited from class de.schlichtherle.truezip.fs.FsDecoratingController

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

path

Constructor Detail

FsFederatingController

Method Detail

resolveParent

getPath

getOpenIcon

getClosedIcon

isReadOnly

getEntry

isReadable

isWritable

setReadOnly

setTime

getInputSocket

getOutputSocket

mknod

unlink