Package org.apache.commons.vfs2

Interface FilesCache

All Known Implementing Classes:
AbstractFilesCache, DefaultFilesCache, LRUFilesCache, NullFilesCache, SoftRefFilesCache, WeakRefFilesCache
public interface FilesCache
The fileCache interface. Implementations of this interface are expected to be thread safe.

  • Method Details

    • clear

      void clear(FileSystem fileSystem)
      Purges the entries corresponding to the FileSystem.
      Parameters:
      fileSystem - The FileSystem.

    • close

      void close()
      Purges the whole cache.

    • getFile

      FileObject getFile(FileSystem fileSystem, FileName fileName)
      Retrieves a FileObject from the cache by name.
      Parameters:
      fileSystem - The FileSystem.
      fileName - the name
      Returns:
      the file object or null if file is not cached

    • putFile

      void putFile(FileObject file)
      Adds a FileObject to the cache.
      Parameters:
      file - the file

    • putFileIfAbsent

      boolean putFileIfAbsent(FileObject file)
      Adds a FileObject to the cache if it isn't already present.
      Parameters:
      file - the file
      Returns:
      true if the file was stored, false otherwise.

    • removeFile

      void removeFile(FileSystem fileSystem, FileName name)
      Removes a file from cache.
      Parameters:
      fileSystem - file system
      name - file name