org.wso2.testgrid.web.utils

Class FileWatcher

java.lang.Object

org.wso2.testgrid.web.utils.FileWatcher

All Implemented Interfaces:

Runnable

public abstract class FileWatcher
extends Object
implements Runnable

This class is responsible for watching changes of a given file.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
FileWatcher(Path watchFile) Creates an instance of FileWatcher to watch the given file.

Method Summary

Modifier and Type	Method and Description
abstract void	beforeFileWatch(String fileContents) This method will execute before watching the file for changes.
abstract void	onCreate(String fileContents) This method will be called when the file creation is detected.
abstract void	onDelete() This method will be called when the file deletion is detected.
abstract void	onModified(String fileContents) This method will be called when the file modification is detected.
void	run()

Methods inherited from class java.lang.Object

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

Constructor Detail

FileWatcher

public FileWatcher(Path watchFile)
            throws FileWatcherException

Creates an instance of FileWatcher to watch the given file.

Parameters:

watchFile - file to be watched

Throws:

FileWatcherException - thrown when error on creating an instance of FileWatcher

Method Detail

beforeFileWatch

public abstract void beforeFileWatch(String fileContents)
                              throws FileWatcherException

This method will execute before watching the file for changes. The contents of the file will be passed to the method.

Parameters:

fileContents - contents of the file to be watched

Throws:

FileWatcherException - thrown when error on executing before file watch method

onCreate

public abstract void onCreate(String fileContents)
                       throws FileWatcherException

This method will be called when the file creation is detected. Implement this method to execute the necessary logic when the file is created. The contents of the file created is passed to the method.

Parameters:

fileContents - contents of the file created

Throws:

FileWatcherException - thrown when error on executing creation method

onModified

public abstract void onModified(String fileContents)
                         throws FileWatcherException

This method will be called when the file modification is detected. Implement this method to execute the necessary logic when the file is modified. The contents of the file created is passed to the method.

Parameters:

fileContents - contents of the file modified

Throws:

FileWatcherException - thrown when error on executing modification method

onDelete

public abstract void onDelete()

This method will be called when the file deletion is detected. Implement this method to execute the necessary logic when the file is deleted.

run

public void run()

Specified by:

run in interface Runnable