org.intellimate.izou.system.file

Class FileManager

java.lang.Object

org.intellimate.izou.util.IzouModule

org.intellimate.izou.system.file.FileManager

All Implemented Interfaces:

Runnable, Identifiable, MainProvider

public class FileManager
extends IzouModule
implements Runnable

The file manager listens for events that were caused by modifications made to property files and then reloads the file. You can register an AddOn or a ReloadableFile with the path to the directory it is supposed to watch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FileManager.IncompleteFileEventException Exception thrown if there are multiple Events fired at the same time.

Field Summary

Fields inherited from class org.intellimate.izou.util.IzouModule

log, main

Constructor Summary

Constructors

Constructor and Description
FileManager(Main main) Creates a new FileManager with a watcher and addOnMap

Method Summary

Modifier and Type	Method and Description
void	createDefaultFile(String defaultFilePath, String initMessage) Creates a default File in case it does not exist yet.
void	registerFileDir(Path dir, String fileType, ReloadableFile reloadableFile) Use this method to register a file with the watcherService
void	run() Main method of fileManager, it constantly waits for new events and then processes them
boolean	writeToFile(String defaultFilePath, String realFilePath) Writes default file to real file The default file would be a file that can be packaged along with the code, from which a real file (say a properties file for example) can be loaded.

Methods inherited from class org.intellimate.izou.util.IzouModule

debug, debug, error, error, fatal, fatal, getID, getMain

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.intellimate.izou.identification.Identifiable

isOwner

Constructor Detail

FileManager

public FileManager(Main main)
            throws IOException

Creates a new FileManager with a watcher and addOnMap

Parameters:

main - an instance of main

Throws:

IOException - exception is thrown by watcher service

Method Detail

registerFileDir

public void registerFileDir(Path dir,
                            String fileType,
                            ReloadableFile reloadableFile)
                     throws IOException

Use this method to register a file with the watcherService

Parameters:

dir - directory of file

fileType - the name/extension of the file IMPORTANT: Please try to always enter the full name with extension of the file (Ex: "test.txt"), it would be best if the fileType is the full file name, and that the file name is clearly distinguishable from other files. For example, the property files are stored with the ID of the addon they belong too. That way every property file is easily distinguishable.

reloadableFile - object of interface that file belongs to

Throws:

IOException - exception thrown by watcher service

writeToFile

public boolean writeToFile(String defaultFilePath,
                           String realFilePath)

Writes default file to real file The default file would be a file that can be packaged along with the code, from which a real file (say a properties file for example) can be loaded. This is useful because there are files (like property files0 that cannot be shipped with the package and have to be created at runtime. To still be able to fill these files, you can create a default file (usually txt) from which the content, as mentioned above, can then be loaded into the real file.

Parameters:

defaultFilePath - path to default file (or where it should be created)

realFilePath - path to real file (that should be filled with content of default file)

Returns:

true if operation has succeeded, else false

createDefaultFile

public void createDefaultFile(String defaultFilePath,
                              String initMessage)
                       throws IOException

Creates a default File in case it does not exist yet. Default files can be used to load other files that are created at runtime (like properties file)

Parameters:

defaultFilePath - path to default file.txt (or where it should be created)

initMessage - the string to write in default file

Throws:

IOException - is thrown by bufferedWriter

run

public void run()

Main method of fileManager, it constantly waits for new events and then processes them

Specified by:

run in interface Runnable