org.apache.commons.vfs2.cache

Class SoftRefFilesCache

java.lang.Object

org.apache.commons.vfs2.provider.AbstractVfsComponent

org.apache.commons.vfs2.cache.AbstractFilesCache

org.apache.commons.vfs2.cache.SoftRefFilesCache

All Implemented Interfaces:

FilesCache, VfsComponent

Direct Known Subclasses:

WeakRefFilesCache

public class SoftRefFilesCache
extends AbstractFilesCache

This implementation caches every file as long as it is strongly reachable by the java vm. As soon as the vm needs memory - every softly reachable file will be discarded.

Version:

$Revision: 1055961 $ $Date: 2005-09-30 09:02:41 +0200 (Fr, 30 Sep 2005) $

Author:

Commons VFS team

See Also:

SoftReference

Constructor Summary

Constructors

Constructor and Description
SoftRefFilesCache()

Method Summary

Modifier and Type	Method and Description
void	clear(FileSystem filesystem) purge the entries corresponding to the filesystem.
void	close() Closes the provider.
protected Reference<FileObject>	createReference(FileObject file, ReferenceQueue<FileObject> refqueue)
FileObject	getFile(FileSystem filesystem, FileName name) retrieve a file from the cache by its name.
protected Map<FileName,Reference<FileObject>>	getOrCreateFilesystemCache(FileSystem filesystem)
void	putFile(FileObject file) add a fileobject to the cache.
boolean	putFileIfAbsent(FileObject file) add a fileobject to the cache if it isn't already present.
void	removeFile(FileSystem filesystem, FileName name) removes a file from cache.
void	touchFile(FileObject file)

Methods inherited from class org.apache.commons.vfs2.provider.AbstractVfsComponent

getContext, getLogger, init, setContext, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SoftRefFilesCache

public SoftRefFilesCache()

Method Detail

putFile

public void putFile(FileObject file)

Description copied from interface: FilesCache

add a fileobject to the cache.

Parameters:

file - the file

putFileIfAbsent

public boolean putFileIfAbsent(FileObject file)

Description copied from interface: FilesCache

add a fileobject to the cache if it isn't already present.

Parameters:

file - the file

Returns:

true if the file was stored, false otherwise.

createReference

protected Reference<FileObject> createReference(FileObject file,
                                                ReferenceQueue<FileObject> refqueue)

getFile

public FileObject getFile(FileSystem filesystem,
                          FileName name)

Description copied from interface: FilesCache

retrieve a file from the cache by its name.

Parameters:

filesystem - The FileSystem.

name - the name

Returns:

the fileobject or null if file is not cached

clear

public void clear(FileSystem filesystem)

Description copied from interface: FilesCache

purge the entries corresponding to the filesystem.

Parameters:

filesystem - The FileSystem.

close

public void close()

Description copied from class: AbstractVfsComponent

Closes the provider. This implementation does nothing.

Specified by:

close in interface FilesCache

Specified by:

close in interface VfsComponent

Overrides:

close in class AbstractVfsComponent

removeFile

public void removeFile(FileSystem filesystem,
                       FileName name)

Description copied from interface: FilesCache

removes a file from cache.

Parameters:

filesystem - filesystem

name - filename

touchFile

public void touchFile(FileObject file)

getOrCreateFilesystemCache

protected Map<FileName,Reference<FileObject>> getOrCreateFilesystemCache(FileSystem filesystem)