org.ow2.chameleon.core.services

Interface Watcher

All Known Implementing Classes:

DirectoryMonitor

public interface Watcher

A service letting adding / removing directory watchers.

Since:

1.0.4

Version:

$Id: 1.0.4 $Id

Author:

The OW2 Chameleon Team

Method Summary

Modifier and Type	Method and Description
boolean	add(File directory, boolean watch) Adds a directory to the watcher.
boolean	add(File directory, long polling) Adds a directory to the watcher.
boolean	removeAndStopIfNeeded(File directory) If the directory was added, remove it.

Method Detail

add

boolean add(File directory,
            boolean watch)

Adds a directory to the watcher. If `watch` is true, the directory is monitored, otherwise only the initial provisioning is done.

Parameters:

directory - the directory

watch - true to enable the watch mode.

Returns:

true if the directory was added, false otherwise.

add

boolean add(File directory,
            long polling)

Adds a directory to the watcher. If `polling` is not -1, the directory is monitored, otherwise only the initial provisioning is done.

Parameters:

directory - the directory

polling - the polling period in ms, -1 to disable the watch.

Returns:

true if the directory was added, false otherwise.

removeAndStopIfNeeded

boolean removeAndStopIfNeeded(File directory)

If the directory was added, remove it. It the monitoring was enable it disable the monitoring. You have to call stop on all directories where the add methods have returned true.

Parameters:

directory - the directory

Returns:

true if the directory was watched and stopped.