de.mhus.lib.core.io

Class FileWatch

java.lang.Object

de.mhus.lib.core.io.FileWatch

public class FileWatch
extends Object

FileWatch class.

Version:

$Id: $Id

Author:

mikehummel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FileWatch.Listener

Constructor Summary

Constructors

Constructor and Description
FileWatch(File fileToWatch, FileWatch.Listener listener) Constructor for FileWatch.
FileWatch(File fileToWatch, TimerIfc timer, FileWatch.Listener listener) Constructor for FileWatch.
FileWatch(File fileToWatch, TimerIfc timer, long period, boolean startHook, FileWatch.Listener listener) Watch a file or directory (one level!) against changes.

Method Summary

Modifier and Type	Method and Description
void	checkFile() checkFile.
FileWatch	doStart() doStart.
FileWatch	doStop() doStop.
File	getFile() Getter for the field file.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FileWatch

public FileWatch(File fileToWatch,
                 FileWatch.Listener listener)

Constructor for FileWatch.

Parameters:

fileToWatch - a File object.

listener - a FileWatch.Listener object.

FileWatch

public FileWatch(File fileToWatch,
                 TimerIfc timer,
                 FileWatch.Listener listener)

Constructor for FileWatch.

Parameters:

fileToWatch - a File object.

timer - a TimerIfc object.

listener - a FileWatch.Listener object.

FileWatch

public FileWatch(File fileToWatch,
                 TimerIfc timer,
                 long period,
                 boolean startHook,
                 FileWatch.Listener listener)

Watch a file or directory (one level!) against changes. Check the modify date to recognize a change. It has two ways to work: 1. Manual check, every time you use the file, call the checkFile() method. 2. Use of a timer.

Parameters:

fileToWatch - a File object.

timer - a TimerIfc object.

period - a long.

startHook - a boolean.

listener - a FileWatch.Listener object.

Method Detail

doStart

public FileWatch doStart()

doStart.

Returns:

a FileWatch object.

doStop

public FileWatch doStop()

doStop.

Returns:

a FileWatch object.

checkFile

public void checkFile()

checkFile.

Since:

3.2.9

getFile

public File getFile()

Getter for the field file.

Returns:

a File object.

toString

public String toString()

Overrides:

toString in class Object