Package org.jgrapes.util

Class FileSystemWatcher

java.lang.Object

org.jgrapes.core.internal.ComponentVertex

org.jgrapes.core.Component

org.jgrapes.util.FileSystemWatcher

All Implemented Interfaces:

Iterable<ComponentType>, Channel, ComponentType, Eligible, Manager

public class FileSystemWatcher
extends Component

A component that watches paths in the file system for changes and sends events if such changes occur.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jgrapes.core.Channel

Channel.Default

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Logger	logger

Fields inherited from interface org.jgrapes.core.Channel

BROADCAST, SELF

Constructor Summary

Constructors

Constructor	Description
FileSystemWatcher()	Creates a new component base with its channel set to itself.
FileSystemWatcher(Channel componentChannel)	Creates a new component base with its channel set to the given channel.

Method Summary

Modifier and Type	Method	Description
void	onWatchFile(WatchFile event, Channel channel)	Register a path to wath.

Methods inherited from class org.jgrapes.core.Component

channel, component, defaultCriterion, isEligibleFor, setName

Methods inherited from class org.jgrapes.core.internal.ComponentVertex

activeEventPipeline, addHandler, attach, children, componentPath, componentVertex, detach, fire, initComponentsHandlers, iterator, name, newEventPipeline, newEventPipeline, parent, registerAsGenerator, root, toString, unregisterAsGenerator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.jgrapes.core.Manager

stream

Field Details

logger

protected static final Logger logger

Constructor Details

FileSystemWatcher

public FileSystemWatcher()

Creates a new component base with its channel set to itself.

FileSystemWatcher

public FileSystemWatcher(Channel componentChannel)

Creates a new component base with its channel set to the given channel.

As a special case Channel.SELF can be passed to the constructor to make the component use itself as channel. The special value is necessary as you obviously cannot pass an object to be constructed to its constructor.

Parameters:

componentChannel - the channel that the component’s handlers listen on by default and that Manager.fire(Event, Channel...) sends the event to

Method Details

onWatchFile

@Handler
public void onWatchFile(WatchFile event,
 Channel channel)
                 throws IOException

Register a path to wath.

Subsequent FileChanged events will be fire on the channel(s) on which the WatchFile event was fired.

The channel is stored using a weak reference, so no explicit “clear watch” is required.

Parameters:

event - the event

channel - the channel

Throws:

IOException - if an I/O exception occurs