net.sf.jabref.collab

Class FileUpdateMonitor

java.lang.Object

java.lang.Thread

net.sf.jabref.collab.FileUpdateMonitor

All Implemented Interfaces:

java.lang.Runnable

public class FileUpdateMonitor
extends java.lang.Thread

This thread monitors a set of files, each associated with a FileUpdateListener, for changes in the file's last modification time stamp. The

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
FileUpdateMonitor()

Method Summary

Modifier and Type	Method and Description
java.lang.String	addUpdateListener(FileUpdateListener ul, java.io.File file) Add a new file to monitor.
void	changeFile(java.lang.String key, java.io.File file)
java.io.File	getTempFile(java.lang.String key) Method for getting the temporary file used for this database.
boolean	hasBeenModified(java.lang.String handle) Forces a check on the file, and returns the result.
void	perturbTimestamp(java.lang.String handle) Change the stored timestamp for the given file.
void	removeUpdateListener(java.lang.String handle) Removes a listener from the monitor.
void	run()
void	stopMonitoring() Cause the thread to stop monitoring.
void	updateTimeStamp(java.lang.String key)

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

FileUpdateMonitor

public FileUpdateMonitor()

Method Detail

run

public void run()

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

stopMonitoring

public void stopMonitoring()

Cause the thread to stop monitoring. It will finish the current round before stopping.

addUpdateListener

public java.lang.String addUpdateListener(FileUpdateListener ul,
                                          java.io.File file)
                                   throws java.io.IOException

Add a new file to monitor. Returns a handle for accessing the entry.

Parameters:

ul - FileUpdateListener The listener to notify when the file changes.

file - File The file to monitor.

Throws:

java.io.IOException - if the file does not exist.

hasBeenModified

public boolean hasBeenModified(java.lang.String handle)
                        throws java.lang.IllegalArgumentException

Forces a check on the file, and returns the result. Does not force a report to all listeners before the next routine check.

Throws:

java.lang.IllegalArgumentException

perturbTimestamp

public void perturbTimestamp(java.lang.String handle)

Change the stored timestamp for the given file. If the timestamp equals the file's timestamp on disk, after this call the file will appear to have been modified. Used if a file has been modified, and the change scan fails, in order to ensure successive checks.

Parameters:

handle - the handle to the correct file.

removeUpdateListener

public void removeUpdateListener(java.lang.String handle)

Removes a listener from the monitor.

Parameters:

handle - String The handle for the listener to remove.

updateTimeStamp

public void updateTimeStamp(java.lang.String key)
                     throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

changeFile

public void changeFile(java.lang.String key,
                       java.io.File file)
                throws java.io.IOException,
                       java.lang.IllegalArgumentException

Throws:

java.io.IOException

java.lang.IllegalArgumentException

getTempFile

public java.io.File getTempFile(java.lang.String key)
                         throws java.lang.IllegalArgumentException

Method for getting the temporary file used for this database. The tempfile is used for comparison with the changed on-disk version.

Parameters:

key - String The handle for this monitor.

Returns:

File The temporary file.

Throws:

java.lang.IllegalArgumentException - If the handle doesn't correspond to an entry.