org.intellimate.izou.system.context

Interface Files

public interface Files

Version:

1.0

Author:

Leander Kurscheidt

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.
File	getLibLocation() gets the File pointing towards the location of the lib-folder
File	getLogsLocation() gets the File pointing towards the location of the logs-folder
File	getPropertiesLocation() gets the File pointing towards the location of the properties-folder
File	getResourceLocation() gets the File pointing towards the location of the resource-folder
void	register(FileSubscriber fileSubscriber, Identification identification) Registers a FileSubscriber so that whenever any file is reloaded, the fileSubscriber is notified.
void	register(ReloadableFile reloadableFile, FileSubscriber fileSubscriber, Identification identification) Registers a FileSubscriber with a ReloadableFile.
void	registerFileDir(Path dir, String fileType, ReloadableFile reloadableFile) Use this method to register a file with the watcherService
void	unregister(FileSubscriber fileSubscriber) Unregisters all instances of fileSubscriber found.
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.

Method Detail

registerFileDir

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

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

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

register

void register(ReloadableFile reloadableFile,
              FileSubscriber fileSubscriber,
              Identification identification)
       throws IllegalIDException

Registers a FileSubscriber with a ReloadableFile. So when the reloadableFile is reloaded, the fileSubscriber will be notified. Multiple file subscribers can be registered with the same reloadable file.

Parameters:

reloadableFile - the reloadable file that should be observed

fileSubscriber - the fileSubscriber that should be notified when the reloadable file is reloaded

identification - the Identification of the requesting instance

Throws:

IllegalIDException - not yet implemented

register

void register(FileSubscriber fileSubscriber,
              Identification identification)
       throws IllegalIDException

Registers a FileSubscriber so that whenever any file is reloaded, the fileSubscriber is notified.

Parameters:

fileSubscriber - the fileSubscriber that should be notified when the reloadable file is reloaded

identification - the Identification of the requesting instance

Throws:

IllegalIDException - not yet implemented

unregister

void unregister(FileSubscriber fileSubscriber)

Unregisters all instances of fileSubscriber found.

Parameters:

fileSubscriber - the fileSubscriber to unregister

getLibLocation

File getLibLocation()

gets the File pointing towards the location of the lib-folder

Returns:

the File

getResourceLocation

File getResourceLocation()

gets the File pointing towards the location of the resource-folder

Returns:

the File

getPropertiesLocation

File getPropertiesLocation()

gets the File pointing towards the location of the properties-folder

Returns:

the File

getLogsLocation

File getLogsLocation()

gets the File pointing towards the location of the logs-folder

Returns:

the File