Package org.apache.commons.vfs

Interface FilesCache

All Known Implementing Classes:

AbstractFilesCache, DefaultFilesCache, LRUFilesCache, NullFilesCache, SoftRefFilesCache, WeakRefFilesCache

public interface FilesCache

The fileCache interface

Version:

$Revision: 480428 $ $Date: 2006-11-29 07:15:24 +0100 (Wed, 29 Nov 2006) $

Author:

Mario Ivankovits

Method Summary

Modifier and Type	Method	Description
void	clear(FileSystem filesystem)	purge the entries corresponding to the filesystem
void	close()	purge the whole cache
FileObject	getFile(FileSystem filesystem, FileName name)	retrieve a file from the cache by its name
void	putFile(FileObject file)	add a fileobject to the cache
void	removeFile(FileSystem filesystem, FileName name)	removes a file from cache

Method Detail

putFile

void putFile(FileObject file)

add a fileobject to the cache

Parameters:

file - the file

getFile

FileObject getFile(FileSystem filesystem,
                   FileName name)

retrieve a file from the cache by its name

Parameters:

name - the name

Returns:

the fileobject or null if file is not cached

clear

void clear(FileSystem filesystem)

purge the entries corresponding to the filesystem

close

void close()

purge the whole cache

removeFile

void removeFile(FileSystem filesystem,
                FileName name)

removes a file from cache

Parameters:

filesystem - filesystem

name - filename