org.danilopianini.io

Class AbstractFileSystemWatcher

java.lang.Object

java.lang.Thread

org.danilopianini.concurrency.AbstractService

org.danilopianini.io.AbstractFileSystemWatcher

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

AbstractRecursiveFileSystemWatcher

public abstract class AbstractFileSystemWatcher
extends AbstractService

The aim of this class is to provide a skeleton for a file system watcher. Some abstract methods are exposed in order to ease the subclassing

Nested Class Summary

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

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
private Path	path
private WatchService	watcher

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
AbstractFileSystemWatcher(String dir) Builds a file system watcher for a single directory.

Method Summary

Modifier and Type	Method and Description
protected abstract void	created(Path filename) This method is invoked whenever a new file is created.
protected abstract void	deleted(Path filename) This method is invoked whenever a file is deleted.
Path	getPath()
protected abstract void	modified(Path filename) This method is invoked whenever a file is modified.
abstract void	overflow() This method is invoked whenever an overflow event occurs (see java.nio.file.StandardWatchEventKinds.OVERFLOW).
void	run()
void	stopService() If called, the service must stop.
protected abstract void	unknown(WatchEvent<Path> event) Something nasty happened, and the system received an unexpected event.

Methods inherited from class org.danilopianini.concurrency.AbstractService

isServiceAlive, setAlive

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

Field Detail

path

private final Path path

watcher

private final WatchService watcher

Constructor Detail

AbstractFileSystemWatcher

public AbstractFileSystemWatcher(String dir)
                          throws IOException

Builds a file system watcher for a single directory.

Parameters:

dir - the directory to register to

Throws:

IOException - in case of I/O errors

Method Detail

created

protected abstract void created(Path filename)

This method is invoked whenever a new file is created.

Parameters:

filename - the file which has been created

deleted

protected abstract void deleted(Path filename)

This method is invoked whenever a file is deleted.

Parameters:

filename - the file which has been deleted

getPath

public Path getPath()

Returns:

the currently observed path

modified

protected abstract void modified(Path filename)

This method is invoked whenever a file is modified.

Parameters:

filename - the file which has been modified

overflow

public abstract void overflow()

This method is invoked whenever an overflow event occurs (see java.nio.file.StandardWatchEventKinds.OVERFLOW).

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

stopService

public void stopService()

Description copied from class: AbstractService

If called, the service must stop.

Specified by:

stopService in class AbstractService

unknown

protected abstract void unknown(WatchEvent<Path> event)

Something nasty happened, and the system received an unexpected event.

Parameters:

event - the bad event