Package org.apache.commons.vfs2.cache
Class DefaultFilesCache
java.lang.Object
org.apache.commons.vfs2.provider.AbstractVfsComponent
org.apache.commons.vfs2.cache.AbstractFilesCache
org.apache.commons.vfs2.cache.DefaultFilesCache
- All Implemented Interfaces:
Closeable,AutoCloseable,FilesCache,VfsComponent
A simple
FilesCache implementation.
This implementation caches every file with no expire or limit. All files and file systems are hard reachable references. This implementation holds a list of file system specific ConcurrentHashMaps in the main cache map.
Cached FileObjects as well as FileSystems are only removed when
clear(FileSystem) is called (i.e. on file system close). When the used
FileSystemManager is closed, it will also close this cache (which frees all entries).
Despite its name, this is not the fallback implementation used by
DefaultFileSystemManager#init() anymore.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidclear(FileSystem filesystem) Purges the entries corresponding to the FileSystem.voidclose()Closes the provider.getFile(FileSystem filesystem, FileName name) Retrieves a FileObject from the cache by name.protected ConcurrentMap<FileName, FileObject> getOrCreateFilesystemCache(FileSystem fileSystem) Gets or creates a Map.voidputFile(FileObject file) Adds a FileObject to the cache.booleanputFileIfAbsent(FileObject file) Adds a FileObject to the cache if it isn't already present.voidremoveFile(FileSystem filesystem, FileName name) Removes a file from cache.Methods inherited from class org.apache.commons.vfs2.cache.AbstractFilesCache
touchFileMethods inherited from class org.apache.commons.vfs2.provider.AbstractVfsComponent
getContext, getLogger, init, setContext, setLogger
-
Constructor Details
-
DefaultFilesCache
public DefaultFilesCache()Constructs a new instance.
-
-
Method Details
-
clear
Description copied from interface:FilesCachePurges the entries corresponding to the FileSystem.- Parameters:
filesystem- The FileSystem.
-
close
Description copied from class:AbstractVfsComponentCloses the provider. This implementation does nothing.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein interfaceFilesCache- Specified by:
closein interfaceVfsComponent- Overrides:
closein classAbstractVfsComponent
-
getFile
Description copied from interface:FilesCacheRetrieves 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
-
getOrCreateFilesystemCache
Gets or creates a Map.- Parameters:
fileSystem- the key- Returns:
- an existing or new Map.
-
putFile
Description copied from interface:FilesCacheAdds a FileObject to the cache.- Parameters:
file- the file
-
putFileIfAbsent
Description copied from interface:FilesCacheAdds 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
Description copied from interface:FilesCacheRemoves a file from cache.- Parameters:
filesystem- file systemname- file name
-