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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
clear(FileSystem fileSystem)
Purges the entries corresponding to the FileSystem.void
close()
Purges the whole cache.FileObject
getFile(FileSystem filesystem, FileName name)
Retrieves a FileObject from the cache by name.void
putFile(FileObject file)
Adds a FileObject to the cache.boolean
putFileIfAbsent(FileObject file)
Adds a FileObject to the cache if it isn't already present.void
removeFile(FileSystem filesystem, FileName name)
Removes a file from cache.
-
-
-
Method Detail
-
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.
-
getFile
FileObject getFile(FileSystem filesystem, FileName name)
Retrieves a FileObject from the cache by name.- Parameters:
filesystem
- The FileSystem.name
- the name- Returns:
- the file object or null if file is not cached
-
clear
void clear(FileSystem fileSystem)
Purges the entries corresponding to the FileSystem.- Parameters:
fileSystem
- The FileSystem.
-
close
void close()
Purges the whole cache.
-
removeFile
void removeFile(FileSystem filesystem, FileName name)
Removes a file from cache.- Parameters:
filesystem
- filesystemname
- filename
-
-