Package com.codingchili.core.files

Class CachedFileStore

java.lang.Object

com.codingchili.core.files.CachedFileStore

All Implemented Interfaces:

FileStoreListener

public final class CachedFileStore
extends Object
implements FileStoreListener

Caches files from disk in memory and reloads them on change.

Field Summary

Fields

Modifier and Type	Field	Description
protected CoreContext	context

Constructor Summary

Constructors

Constructor	Description
CachedFileStore(CoreContext context, CachedFileStoreSettings settings)	Maintain a CachedFileStore for each loaded directory.

Method Summary

Modifier and Type	Method	Description
CachedFileStore	addListener(FileStoreListener listener)
CachedFile	getFile(String path)
Collection<CachedFile>	getFiles()
void	onFileModify(Path path)	Triggered when a file on the registered path has been modified or created.
void	onFileRemove(Path path)	Triggered when a file on the registered path has been deleted.

Methods inherited from class java.lang.Object

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

Field Details

context

protected CoreContext context

Constructor Details

CachedFileStore

public CachedFileStore(CoreContext context,
 CachedFileStoreSettings settings)

Maintain a CachedFileStore for each loaded directory.

Parameters:

context - the context requesting the feature.

settings - the settings to use for the CachedFileStore, if conflicting with any existing configuration for the given path the configuration is ignored.

Method Details

onFileModify

public void onFileModify(Path path)

Description copied from interface: FileStoreListener

Triggered when a file on the registered path has been modified or created.

Specified by:

onFileModify in interface FileStoreListener

Parameters:

path - the basedir-relative path to the file that was modified.

onFileRemove

public void onFileRemove(Path path)

Description copied from interface: FileStoreListener

Triggered when a file on the registered path has been deleted.

Specified by:

onFileRemove in interface FileStoreListener

Parameters:

path - the basedir-relative path to the file that was modified.

getFiles

public Collection<CachedFile> getFiles()

getFile

public CachedFile getFile(String path)
                   throws FileMissingException

Throws:

FileMissingException

addListener

public CachedFileStore addListener(FileStoreListener listener)

Parameters:

listener - a modify/remove event listener.

Returns:

fluent