Field Detail

• readLock

  private volatile ReentrantReadWriteLock.ReadLock readLock

• writeLock

  private volatile ReentrantReadWriteLock.WriteLock writeLock

Constructor Detail

• FsConcurrentController

  public FsConcurrentController(@NonNull
                        FsController<? extends FsConcurrentModel> controller)

  Constructs a new concurrent file system controller.

  Parameters:

  controller - the decorated file system controller.

Method Detail

• readLock

  private ReentrantReadWriteLock.ReadLock readLock()

• writeLock

  private ReentrantReadWriteLock.WriteLock writeLock()

• assertNotReadLockedByCurrentThread

  private void assertNotReadLockedByCurrentThread(FsNotWriteLockedException ex)
                                           throws FsNotWriteLockedException

  Throws:

  FsNotWriteLockedException

• getOpenIcon

  public Icon getOpenIcon()
                   throws IOException

  Overrides:

  getOpenIcon in class FsDecoratingController<FsConcurrentModel,FsController<? extends FsConcurrentModel>>

  Throws:

  IOException

• getClosedIcon

  public Icon getClosedIcon()
                     throws IOException

  Overrides:

  getClosedIcon in class FsDecoratingController<FsConcurrentModel,FsController<? extends FsConcurrentModel>>

  Throws:

  IOException

• isReadOnly

  public boolean isReadOnly()
                     throws IOException

  Overrides:

  isReadOnly in class FsDecoratingController<FsConcurrentModel,FsController<? extends FsConcurrentModel>>

  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<FsConcurrentModel,FsController<? extends FsConcurrentModel>>

  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<FsConcurrentModel,FsController<? extends FsConcurrentModel>>

  Throws:

  IOException

• isWritable

  public boolean isWritable(FsEntryName name)
                     throws IOException

  Overrides:

  isWritable in class FsDecoratingController<FsConcurrentModel,FsController<? extends FsConcurrentModel>>

  Throws:

  IOException

• setReadOnly

  public void setReadOnly(FsEntryName name)
                   throws IOException

  Overrides:

  setReadOnly in class FsDecoratingController<FsConcurrentModel,FsController<? extends FsConcurrentModel>>

  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<FsConcurrentModel,FsController<? extends FsConcurrentModel>>

  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<FsConcurrentModel,FsController<? extends FsConcurrentModel>>

  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<FsConcurrentModel,FsController<? extends FsConcurrentModel>>

  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<FsConcurrentModel,FsController<? extends FsConcurrentModel>>

  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<FsConcurrentModel,FsController<? extends FsConcurrentModel>>

  Throws:

  IOException

• sync

  public <X extends IOException> void sync(@NonNull
                                  BitField<FsSyncOption> options,
                                  @NonNull
                                  ExceptionHandler<? super FsSyncException,X> handler)
            throws X extends 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.

  Overrides:

  sync in class FsDecoratingController<FsConcurrentModel,FsController<? extends FsConcurrentModel>>

  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 IOException