jodd.io.watch

Class DirWatcher

java.lang.Object

jodd.io.watch.DirWatcher

public class DirWatcher
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DirWatcher.Event Events that describes file change.
class	DirWatcher.WatchTask

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.File	dir
protected int	filesCount
protected boolean	ignoreDotFiles
protected java.util.List<DirWatcherListener>	listeners
protected java.util.HashMap<java.io.File,MutableLong>	map
protected java.lang.String[]	patterns
protected boolean	startBlank
protected java.util.Timer	timer
protected java.io.File	watchFile
protected long	watchFileLastAccessTime

Constructor Summary

Constructors

Constructor and Description
DirWatcher(java.lang.String dir) Creates new watcher on specified directory.
DirWatcher(java.lang.String dirName, java.lang.String... patterns) Creates new watched on specified directory with given set of wildcard patterns for file names.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	acceptFile(java.io.File file) Accepts if a file is going to be watched.
DirWatcher	ignoreDotFiles(boolean ignoreDotFiles) Enables or disables if dot files should be watched.
protected void	init() Initializes dir watcher by reading all files from watched folder.
DirWatcher	monitor(java.lang.String... patterns) Defines patterns to scan.
protected void	onChange(java.io.File file, DirWatcher.Event event) Triggers listeners on file change.
void	register(DirWatcherListener dirWatcherListener) Registers listener.
void	remove(DirWatcherListener dirWatcherListener) Removes registered listener.
void	start(long pollingInterval) Starts the watcher.
DirWatcher	startBlank(boolean startBlank) Defines if watcher should start blank and consider all present files as created.
void	stop() Stops the watcher.
DirWatcher	useWatchFile() Enables usage of default watch file (".watch.ready").
DirWatcher	useWatchFile(java.lang.String name) Enables usage of provided watch file.

Methods inherited from class java.lang.Object

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

Field Detail

dir

protected final java.io.File dir

map

protected java.util.HashMap<java.io.File,MutableLong> map

filesCount

protected int filesCount

listeners

protected java.util.List<DirWatcherListener> listeners

patterns

protected java.lang.String[] patterns

ignoreDotFiles

protected boolean ignoreDotFiles

startBlank

protected boolean startBlank

watchFile

protected java.io.File watchFile

watchFileLastAccessTime

protected long watchFileLastAccessTime

timer

protected java.util.Timer timer

Constructor Detail

DirWatcher

public DirWatcher(java.lang.String dir)

Creates new watcher on specified directory. You can set file patterns later.

DirWatcher

public DirWatcher(java.lang.String dirName,
          java.lang.String... patterns)

Creates new watched on specified directory with given set of wildcard patterns for file names.

Method Detail

init

protected void init()

Initializes dir watcher by reading all files from watched folder.

ignoreDotFiles

public DirWatcher ignoreDotFiles(boolean ignoreDotFiles)

Enables or disables if dot files should be watched.

startBlank

public DirWatcher startBlank(boolean startBlank)

Defines if watcher should start blank and consider all present files as created. By default all existing files will consider as existing ones.

monitor

public DirWatcher monitor(java.lang.String... patterns)

Defines patterns to scan.

acceptFile

protected boolean acceptFile(java.io.File file)

Accepts if a file is going to be watched.

useWatchFile

public DirWatcher useWatchFile()

Enables usage of default watch file (".watch.ready").

useWatchFile

public DirWatcher useWatchFile(java.lang.String name)

Enables usage of provided watch file.

start

public void start(long pollingInterval)

Starts the watcher.

stop

public void stop()

Stops the watcher.

onChange

protected void onChange(java.io.File file,
            DirWatcher.Event event)

Triggers listeners on file change.

register

public void register(DirWatcherListener dirWatcherListener)

Registers listener.

remove

public void remove(DirWatcherListener dirWatcherListener)

Removes registered listener.