FsSyncController (TrueZIP Kernel 7.5.1 API)

java.lang.Object
- de.schlichtherle.truezip.fs.FsController<M>
- - de.schlichtherle.truezip.fs.FsModelController<M>
  - - de.schlichtherle.truezip.fs.FsDecoratingController<M,FsController<? extends M>>
    - - de.schlichtherle.truezip.fs.FsSyncController<M>

Type Parameters:
M - the type of the file system model.
```
@ThreadSafe
public final class FsSyncController<M extends FsModel>
extends FsDecoratingController<M,FsController<? extends M>>
```
Performs a sync operation on the file system if and only if any decorated file system controller throws an FsNeedsSyncException.

Since:

TrueZIP 7.3

Author:

Christian Schlichtherle

See Also:
FsNeedsSyncException

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`FsSyncController.Input`
`private class`	`FsSyncController.Nio2Input`
`private class`	`FsSyncController.Nio2Output`
`private class`	`FsSyncController.Output`
`private static class`	`FsSyncController.SocketFactory`
`private class`	`FsSyncController.SyncInputStream`
`private class`	`FsSyncController.SyncOutputStream`
`private class`	`FsSyncController.SyncReadOnlyFile`
`private class`	`FsSyncController.SyncSeekableByteChannel`

Field Summary

Fields
Modifier and Type Field and Description

private static FsSyncController.SocketFactory SOCKET_FACTORY
- Fields inherited from class de.schlichtherle.truezip.fs.FsDecoratingController
  delegate

Fields
Modifier and Type	Field and Description
`private static FsSyncController.SocketFactory`	`SOCKET_FACTORY`

Constructor Summary

Constructors
Constructor and Description

FsSyncController(FsController<? extends M> controller)
Constructs a new file system sync controller.

Constructors
Constructor and Description
`FsSyncController(FsController<? extends M> controller)` Constructs a new file system sync controller.

Method Summary

Methods
Modifier and Type	Method and Description
`(package private) void`	`close(Closeable closeable)`
`Icon`	`getClosedIcon()` Deprecated.
`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.
`Icon`	`getOpenIcon()` Deprecated.
`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.
`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`	`unlink(FsEntryName name, BitField<FsOutputOption> options)` Removes the named file system entry from the file system.

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

Methods inherited from class de.schlichtherle.truezip.fs.FsModelController
getModel, getMountPoint, isTouched, setTouched

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

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

- Field Detail
  - SOCKET_FACTORY
```
private static final FsSyncController.SocketFactory SOCKET_FACTORY
```
- Constructor Detail
  - FsSyncController
```
public FsSyncController(FsController<? extends M> controller)
```
    Constructs a new file system sync controller.
    
    Parameters:
    controller - the decorated file system controller.
- Method Detail
  - close
```
void close(Closeable closeable)
     throws IOException
```
    Throws:
    
    IOException
  - getClosedIcon
```
@Deprecated
public Icon getClosedIcon()
                   throws IOException
```
    Deprecated.
    
    Description copied from class: FsController
    
    Returns a nullable icon representing the "closed" state when displaying the (federated) file system represented by this controller in a GUI, e.g. a JTree.
    
    Overrides:
    
    getClosedIcon in class FsDecoratingController<M extends FsModel,FsController<? extends M extends FsModel>>
    
    Returns:
    The nullable icon.
    
    Throws:
    
    IOException - on any I/O failure.
  - 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.
    
    Overrides:
    
    getEntry in class FsDecoratingController<M extends FsModel,FsController<? extends 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.
    
    Overrides:
    
    getInputSocket in class FsDecoratingController<M extends FsModel,FsController<? extends M extends FsModel>>
    
    Parameters:
    name - the file system entry name.
    options - the input options.
    
    Returns:
    An InputSocket.
  - getOpenIcon
```
@Deprecated
public Icon getOpenIcon()
                 throws IOException
```
    Deprecated.
    
    Description copied from class: FsController
    
    Returns a nullable icon representing the "open" state when displaying the (federated) file system represented by this controller in a GUI, e.g. a JTree.
    
    Overrides:
    
    getOpenIcon in class FsDecoratingController<M extends FsModel,FsController<? extends M extends FsModel>>
    
    Returns:
    The nullable icon.
    
    Throws:
    
    IOException - on any I/O failure.
  - getOutputSocket
```
public OutputSocket<?> getOutputSocket(FsEntryName name,
                              BitField<FsOutputOption> options,
                              @CheckForNull
                              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<M extends FsModel,FsController<? extends 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.
  - 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 FsDecoratingController<M extends FsModel,FsController<? extends 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.
    
    Overrides:
    
    isReadable in class FsDecoratingController<M extends FsModel,FsController<? extends 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.
    
    Overrides:
    
    isReadOnly in class FsDecoratingController<M extends FsModel,FsController<? extends 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.
    
    Overrides:
    
    isWritable in class FsDecoratingController<M extends FsModel,FsController<? extends 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,
         @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<M extends FsModel,FsController<? extends 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.
    
    Overrides:
    
    setReadOnly in class FsDecoratingController<M extends FsModel,FsController<? extends 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. Whether or not this is an atomic operation is specific to the implementation.
    
    Overrides:
    
    setTime in class FsDecoratingController<M extends FsModel,FsController<? extends 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 FsDecoratingController<M extends FsModel,FsController<? extends 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.
  - 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.
    
    Overrides:
    
    unlink in class FsDecoratingController<M extends FsModel,FsController<? extends M extends FsModel>>
    
    Parameters:
    name - the file system entry name.
    options - output options for this operation.
    
    Throws:
    
    IOException - on any I/O failure.

Class FsSyncController<M extends FsModel>

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

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

Methods inherited from class java.lang.Object

Field Detail

SOCKET_FACTORY

Constructor Detail

FsSyncController

Method Detail

close

getClosedIcon

getEntry

getInputSocket

getOpenIcon

getOutputSocket

isExecutable

isReadable

isReadOnly

isWritable

mknod

setReadOnly

setTime

setTime

unlink